Package omero.api
Interface _IMetadataOperations
-
- All Superinterfaces:
_ServiceInterfaceOperations
- All Known Subinterfaces:
IMetadata
- All Known Implementing Classes:
_IMetadataDisp
,_IMetadataTie
,MetadataI
public interface _IMetadataOperations extends _ServiceInterfaceOperations
Provides method to interact with acquisition metadata and annotations.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
countAnnotationsUsedNotOwned_async(AMD_IMetadata_countAnnotationsUsedNotOwned __cb, java.lang.String annotationType, long userID, Ice.Current __current)
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, Ice.Current __current)
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, Ice.Current __current)
Returns a map whose key is a tag id and the value the number of Projects, Datasets, and Images linked to that tag.void
loadAnnotation_async(AMD_IMetadata_loadAnnotation __cb, java.util.List<java.lang.Long> annotationIds, Ice.Current __current)
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, Ice.Current __current)
Loads all the annotations of given types, that have been attached to the specifiedrootNodes
for the specifiedannotatorIds
.void
loadAnnotationsUsedNotOwned_async(AMD_IMetadata_loadAnnotationsUsedNotOwned __cb, java.lang.String annotationType, long userID, Ice.Current __current)
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, Ice.Current __current)
Loads the logical channels and the acquisition metadata related to them.void
loadInstrument_async(AMD_IMetadata_loadInstrument __cb, long id, Ice.Current __current)
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, Ice.Current __current)
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, Ice.Current __current)
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, Ice.Current __current)
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, Ice.Current __current)
Loads the TagSet if the id is specified otherwise loads all the TagSet.void
loadTagSets_async(AMD_IMetadata_loadTagSets __cb, Parameters options, Ice.Current __current)
Loads all the TagSets.
-
-
-
Method Detail
-
loadChannelAcquisitionData_async
void loadChannelAcquisitionData_async(AMD_IMetadata_loadChannelAcquisitionData __cb, java.util.List<java.lang.Long> ids, Ice.Current __current) throws ServerError
Loads the logical channels and the acquisition metadata related to them.- Parameters:
__cb
- The callback object for the operation.ids
- The collection of logical channel's ids. Mustn't benull
.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadAnnotations_async
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, Ice.Current __current) throws ServerError
Loads all the annotations of given types, that have been attached to the specifiedrootNodes
for the specifiedannotatorIds
. 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 eachrootId
onto the set of annotations that were found for that node. If no annotations were found for that node, then the entry will benull
. Otherwise it will be aMap
containingAnnotation
objects.- Parameters:
__cb
- The callback object for the operation.rootType
- The type of the nodes the annotations are linked to. Mustn't benull
.rootIds
- Ids of the objects of typerootType
. Mustn't benull
.annotationTypes
- The types of annotation to retrieve. Ifnull
all annotations will be loaded. String of the typeomero.model.annotations.*
.annotatorIds
- Ids of the users for whom annotations should be retrieved. Ifnull
, all annotations returned.options
-__current
- The Current object for the invocation.- Throws:
ServerError
-
loadSpecifiedAnnotations_async
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, Ice.Current __current) 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.- 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.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadTagContent_async
void loadTagContent_async(AMD_IMetadata_loadTagContent __cb, java.util.List<java.lang.Long> ids, Parameters options, Ice.Current __current) throws ServerError
Loads the TagSet if the id is specified otherwise loads all the TagSet.- Parameters:
__cb
- The callback object for the operation.ids
- The id of the tag to load or-1
.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadTagSets_async
void loadTagSets_async(AMD_IMetadata_loadTagSets __cb, Parameters options, Ice.Current __current) throws ServerError
Loads all the TagSets. Returns a collection ofAnnotationAnnotatioLink
objects and, if theorphan
parameters istrue
, theTagAnnotation
object. Note that the difference between a TagSet and a Tag is made using the NS_INSIGHT_TAG_SET namespace.- Parameters:
__cb
- The callback object for the operation.options
- The POJO options.__current
- The Current object for the invocation.- Throws:
ServerError
-
getTaggedObjectsCount_async
void getTaggedObjectsCount_async(AMD_IMetadata_getTaggedObjectsCount __cb, java.util.List<java.lang.Long> ids, Parameters options, Ice.Current __current) 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.- Parameters:
__cb
- The callback object for the operation.ids
- The collection of ids.__current
- The Current object for the invocation.- Throws:
ServerError
-
countSpecifiedAnnotations_async
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, Ice.Current __current) throws ServerError
Counts the number of annotation of a given type.- 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.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadAnnotation_async
void loadAnnotation_async(AMD_IMetadata_loadAnnotation __cb, java.util.List<java.lang.Long> annotationIds, Ice.Current __current) throws ServerError
Loads the specified annotations.- Parameters:
__cb
- The callback object for the operation.annotationIds
- The collection of annotation ids.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadInstrument_async
void loadInstrument_async(AMD_IMetadata_loadInstrument __cb, long id, Ice.Current __current) throws ServerError
Loads the instrument and its components i.e. detectors, objectives, etc.- Parameters:
__cb
- The callback object for the operation.id
- The id of the instrument to load.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadAnnotationsUsedNotOwned_async
void loadAnnotationsUsedNotOwned_async(AMD_IMetadata_loadAnnotationsUsedNotOwned __cb, java.lang.String annotationType, long userID, Ice.Current __current) throws ServerError
Loads the annotations of a given type used by the specified user but not owned by the user.- Parameters:
__cb
- The callback object for the operation.annotationType
- The type of annotations to load.__current
- The Current object for the invocation.- Throws:
ServerError
-
countAnnotationsUsedNotOwned_async
void countAnnotationsUsedNotOwned_async(AMD_IMetadata_countAnnotationsUsedNotOwned __cb, java.lang.String annotationType, long userID, Ice.Current __current) throws ServerError
Counts the number of annotation of a given type used by the specified user but not owned by the user.- Parameters:
__cb
- The callback object for the operation.annotationType
- The type of annotations to load.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadSpecifiedAnnotationsLinkedTo_async
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, Ice.Current __current) 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 eachrootNodeId
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 aSet
containingAnnotation
objects. TherootNodeType
supported are: Project, Dataset, Image, Pixels, Screen, Plate, PlateAcquisition, Well, Fileset.- 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.__current
- The Current object for the invocation.- Throws:
ServerError
-
loadLogFiles_async
void loadLogFiles_async(AMD_IMetadata_loadLogFiles __cb, java.lang.String rootType, java.util.List<java.lang.Long> ids, Ice.Current __current) throws ServerError
Finds the original file IDs for the import logs corresponding to the given Image or Fileset IDs.- Parameters:
__cb
- The callback object for the operation.rootType
- the root node type, may beImage
orFileset
ids
- the IDs of the entities for which the import log original file IDs are required__current
- The Current object for the invocation.- Throws:
ServerError
-
-