omero.api

Class _IMetadataDisp

java.lang.Object

Ice.ObjectImpl

omero.api._IMetadataDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _IMetadataOperations, _IMetadataOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, IMetadata, ServiceInterface

Direct Known Subclasses:

_IMetadataTie

public abstract class _IMetadataDisp
extends Ice.ObjectImpl
implements IMetadata

Provides method to interact with acquisition metadata and annotations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface omero.api.IMetadata

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_IMetadataDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___countAnnotationsUsedNotOwned(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___countSpecifiedAnnotations(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getTaggedObjectsCount(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadAnnotation(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadAnnotations(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadAnnotationsUsedNotOwned(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadChannelAcquisitionData(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadInstrument(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadLogFiles(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadSpecifiedAnnotations(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadSpecifiedAnnotationsLinkedTo(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadTagContent(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___loadTagSets(IMetadata __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
void	countAnnotationsUsedNotOwned_async(AMD_IMetadata_countAnnotationsUsedNotOwned __cb, java.lang.String annotationType, long userID) Counts the number of annotation of a given type used by the specified user but not owned by the user.
void	countSpecifiedAnnotations_async(AMD_IMetadata_countSpecifiedAnnotations __cb, java.lang.String annotationType, java.util.List<java.lang.String> include, java.util.List<java.lang.String> exclude, Parameters options) Counts the number of annotation of a given type.
void	getTaggedObjectsCount_async(AMD_IMetadata_getTaggedObjectsCount __cb, java.util.List<java.lang.Long> ids, Parameters options) Returns a map whose key is a tag id and the value the number of Projects, Datasets, and Images linked to that tag.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
void	loadAnnotation_async(AMD_IMetadata_loadAnnotation __cb, java.util.List<java.lang.Long> annotationIds) Loads the specified annotations.
void	loadAnnotations_async(AMD_IMetadata_loadAnnotations __cb, java.lang.String rootType, java.util.List<java.lang.Long> rootIds, java.util.List<java.lang.String> annotationTypes, java.util.List<java.lang.Long> annotatorIds, Parameters options) Loads all the annotations of given types, that have been attached to the specified rootNodes for the specified annotatorIds.
void	loadAnnotationsUsedNotOwned_async(AMD_IMetadata_loadAnnotationsUsedNotOwned __cb, java.lang.String annotationType, long userID) Loads the annotations of a given type used by the specified user but not owned by the user.
void	loadChannelAcquisitionData_async(AMD_IMetadata_loadChannelAcquisitionData __cb, java.util.List<java.lang.Long> ids) Loads the logical channels and the acquisition metadata related to them.
void	loadInstrument_async(AMD_IMetadata_loadInstrument __cb, long id) Loads the instrument and its components i.e.
void	loadLogFiles_async(AMD_IMetadata_loadLogFiles __cb, java.lang.String rootType, java.util.List<java.lang.Long> ids) Finds the original file IDs for the import logs corresponding to the given Image or Fileset IDs.
void	loadSpecifiedAnnotations_async(AMD_IMetadata_loadSpecifiedAnnotations __cb, java.lang.String annotationType, java.util.List<java.lang.String> include, java.util.List<java.lang.String> exclude, Parameters options) Loads all the annotations of a given type.
void	loadSpecifiedAnnotationsLinkedTo_async(AMD_IMetadata_loadSpecifiedAnnotationsLinkedTo __cb, java.lang.String annotationType, java.util.List<java.lang.String> include, java.util.List<java.lang.String> exclude, java.lang.String rootNodeType, java.util.List<java.lang.Long> rootNodeIds, Parameters options) Loads the annotations of a given type linked to the specified objects.
void	loadTagContent_async(AMD_IMetadata_loadTagContent __cb, java.util.List<java.lang.Long> ids, Parameters options) Loads the TagSet if the id is specified otherwise loads all the TagSet.
void	loadTagSets_async(AMD_IMetadata_loadTagSets __cb, Parameters options) Loads all the TagSets.

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface omero.api._IMetadataOperations

countAnnotationsUsedNotOwned_async, countSpecifiedAnnotations_async, getTaggedObjectsCount_async, loadAnnotation_async, loadAnnotations_async, loadAnnotationsUsedNotOwned_async, loadChannelAcquisitionData_async, loadInstrument_async, loadLogFiles_async, loadSpecifiedAnnotations_async, loadSpecifiedAnnotationsLinkedTo_async, loadTagContent_async, loadTagSets_async

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_IMetadataDisp

public _IMetadataDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

countAnnotationsUsedNotOwned_async

public final void countAnnotationsUsedNotOwned_async(AMD_IMetadata_countAnnotationsUsedNotOwned __cb,
                                                     java.lang.String annotationType,
                                                     long userID)
                                              throws ServerError

Counts the number of annotation of a given type used by the specified user but not owned by the user.

Specified by:

countAnnotationsUsedNotOwned_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

annotationType - The type of annotations to load.

Throws:

ServerError

countSpecifiedAnnotations_async

public final void countSpecifiedAnnotations_async(AMD_IMetadata_countSpecifiedAnnotations __cb,
                                                  java.lang.String annotationType,
                                                  java.util.List<java.lang.String> include,
                                                  java.util.List<java.lang.String> exclude,
                                                  Parameters options)
                                           throws ServerError

Counts the number of annotation of a given type.

Specified by:

countSpecifiedAnnotations_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

annotationType - The type of annotations to load.

exclude - The collection of name space, one of the constants defined by this class.

options - The POJO options.

Throws:

ServerError

getTaggedObjectsCount_async

public final void getTaggedObjectsCount_async(AMD_IMetadata_getTaggedObjectsCount __cb,
                                              java.util.List<java.lang.Long> ids,
                                              Parameters options)
                                       throws ServerError

Returns a map whose key is a tag id and the value the number of Projects, Datasets, and Images linked to that tag.

Specified by:

getTaggedObjectsCount_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

ids - The collection of ids.

Throws:

ServerError

loadAnnotation_async

public final void loadAnnotation_async(AMD_IMetadata_loadAnnotation __cb,
                                       java.util.List<java.lang.Long> annotationIds)
                                throws ServerError

Loads the specified annotations.

Specified by:

loadAnnotation_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

annotationIds - The collection of annotation ids.

Throws:

ServerError

loadAnnotations_async

public final void loadAnnotations_async(AMD_IMetadata_loadAnnotations __cb,
                                        java.lang.String rootType,
                                        java.util.List<java.lang.Long> rootIds,
                                        java.util.List<java.lang.String> annotationTypes,
                                        java.util.List<java.lang.Long> annotatorIds,
                                        Parameters options)
                                 throws ServerError

Loads all the annotations of given types, that have been attached to the specified rootNodes for the specified annotatorIds. If no types specified, all annotations will be loaded. This method looks for the annotations that have been attached to each of the specified objects. It then maps each rootId onto the set of annotations that were found for that node. If no annotations were found for that node, then the entry will be null. Otherwise it will be a Map containing Annotation objects.

Specified by:

loadAnnotations_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

rootType - The type of the nodes the annotations are linked to. Mustn't be null.

rootIds - Ids of the objects of type rootType. Mustn't be null.

annotationTypes - The types of annotation to retrieve. If null all annotations will be loaded. String of the type omero.model.annotations.*.

annotatorIds - Ids of the users for whom annotations should be retrieved. If null, all annotations returned.

options -

Throws:

ServerError

loadAnnotationsUsedNotOwned_async

public final void loadAnnotationsUsedNotOwned_async(AMD_IMetadata_loadAnnotationsUsedNotOwned __cb,
                                                    java.lang.String annotationType,
                                                    long userID)
                                             throws ServerError

Loads the annotations of a given type used by the specified user but not owned by the user.

Specified by:

loadAnnotationsUsedNotOwned_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

annotationType - The type of annotations to load.

Throws:

ServerError

loadChannelAcquisitionData_async

public final void loadChannelAcquisitionData_async(AMD_IMetadata_loadChannelAcquisitionData __cb,
                                                   java.util.List<java.lang.Long> ids)
                                            throws ServerError

Loads the logical channels and the acquisition metadata related to them.

Specified by:

loadChannelAcquisitionData_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

ids - The collection of logical channel's ids. Mustn't be null.

Throws:

ServerError

loadInstrument_async

public final void loadInstrument_async(AMD_IMetadata_loadInstrument __cb,
                                       long id)
                                throws ServerError

Loads the instrument and its components i.e. detectors, objectives, etc.

Specified by:

loadInstrument_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

id - The id of the instrument to load.

Throws:

ServerError

loadLogFiles_async

public final void loadLogFiles_async(AMD_IMetadata_loadLogFiles __cb,
                                     java.lang.String rootType,
                                     java.util.List<java.lang.Long> ids)
                              throws ServerError

Finds the original file IDs for the import logs corresponding to the given Image or Fileset IDs.

Specified by:

loadLogFiles_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

rootType - the root node type, may be Image or Fileset

ids - the IDs of the entities for which the import log original file IDs are required

Throws:

ServerError

loadSpecifiedAnnotations_async

public final void loadSpecifiedAnnotations_async(AMD_IMetadata_loadSpecifiedAnnotations __cb,
                                                 java.lang.String annotationType,
                                                 java.util.List<java.lang.String> include,
                                                 java.util.List<java.lang.String> exclude,
                                                 Parameters options)
                                          throws ServerError

Loads all the annotations of a given type. It is possible to filter the annotations by including or excluding name spaces set on the annotations.

Specified by:

loadSpecifiedAnnotations_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

annotationType - The type of annotations to load.

exclude - Exclude the annotations with the specified name spaces.

options - The POJO options.

Throws:

ServerError

loadSpecifiedAnnotationsLinkedTo_async

public final void loadSpecifiedAnnotationsLinkedTo_async(AMD_IMetadata_loadSpecifiedAnnotationsLinkedTo __cb,
                                                         java.lang.String annotationType,
                                                         java.util.List<java.lang.String> include,
                                                         java.util.List<java.lang.String> exclude,
                                                         java.lang.String rootNodeType,
                                                         java.util.List<java.lang.Long> rootNodeIds,
                                                         Parameters options)
                                                  throws ServerError

Loads the annotations of a given type linked to the specified objects. It is possible to filter the annotations by including or excluding name spaces set on the annotations. This method looks for the annotations that have been attached to each of the specified objects. It then maps each rootNodeId onto the set of annotations that were found for that node. If no annotations were found for that node, the map will not contain an entry for that node. Otherwise it will be a Set containing Annotation objects. The rootNodeType supported are: Project, Dataset, Image, Pixels, Screen, Plate, PlateAcquisition, Well, Fileset.

Specified by:

loadSpecifiedAnnotationsLinkedTo_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

annotationType - The type of annotations to load.

exclude - Exclude the annotations with the specified name spaces.

rootNodeType - The type of objects the annotations are linked to.

rootNodeIds - The identifiers of the objects.

Throws:

ServerError

loadTagContent_async

public final void loadTagContent_async(AMD_IMetadata_loadTagContent __cb,
                                       java.util.List<java.lang.Long> ids,
                                       Parameters options)
                                throws ServerError

Loads the TagSet if the id is specified otherwise loads all the TagSet.

Specified by:

loadTagContent_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

ids - The id of the tag to load or -1.

Throws:

ServerError

loadTagSets_async

public final void loadTagSets_async(AMD_IMetadata_loadTagSets __cb,
                                    Parameters options)
                             throws ServerError

Loads all the TagSets. Returns a collection of AnnotationAnnotatioLink objects and, if the orphan parameters is true, the TagAnnotation object. Note that the difference between a TagSet and a Tag is made using the NS_INSIGHT_TAG_SET namespace.

Specified by:

loadTagSets_async in interface _IMetadataOperationsNC

Parameters:

__cb - The callback object for the operation.

options - The POJO options.

Throws:

ServerError

___loadChannelAcquisitionData

public static Ice.DispatchStatus ___loadChannelAcquisitionData(IMetadata __obj,
                                                               IceInternal.Incoming __inS,
                                                               Ice.Current __current)

___loadAnnotations

public static Ice.DispatchStatus ___loadAnnotations(IMetadata __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___loadSpecifiedAnnotations

public static Ice.DispatchStatus ___loadSpecifiedAnnotations(IMetadata __obj,
                                                             IceInternal.Incoming __inS,
                                                             Ice.Current __current)

___loadTagContent

public static Ice.DispatchStatus ___loadTagContent(IMetadata __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___loadTagSets

public static Ice.DispatchStatus ___loadTagSets(IMetadata __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___getTaggedObjectsCount

public static Ice.DispatchStatus ___getTaggedObjectsCount(IMetadata __obj,
                                                          IceInternal.Incoming __inS,
                                                          Ice.Current __current)

___countSpecifiedAnnotations

public static Ice.DispatchStatus ___countSpecifiedAnnotations(IMetadata __obj,
                                                              IceInternal.Incoming __inS,
                                                              Ice.Current __current)

___loadAnnotation

public static Ice.DispatchStatus ___loadAnnotation(IMetadata __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___loadInstrument

public static Ice.DispatchStatus ___loadInstrument(IMetadata __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___loadAnnotationsUsedNotOwned

public static Ice.DispatchStatus ___loadAnnotationsUsedNotOwned(IMetadata __obj,
                                                                IceInternal.Incoming __inS,
                                                                Ice.Current __current)

___countAnnotationsUsedNotOwned

public static Ice.DispatchStatus ___countAnnotationsUsedNotOwned(IMetadata __obj,
                                                                 IceInternal.Incoming __inS,
                                                                 Ice.Current __current)

___loadSpecifiedAnnotationsLinkedTo

public static Ice.DispatchStatus ___loadSpecifiedAnnotationsLinkedTo(IMetadata __obj,
                                                                     IceInternal.Incoming __inS,
                                                                     Ice.Current __current)

___loadLogFiles

public static Ice.DispatchStatus ___loadLogFiles(IMetadata __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl