omero.api

Interface _IMetadataOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC

All Known Subinterfaces:

IMetadata

All Known Implementing Classes:

_IMetadataDisp, _IMetadataTie

public interface _IMetadataOperationsNC
extends _ServiceInterfaceOperationsNC

Provides method to interact with acquisition metadata and annotations.

Method Summary

Modifier and Type	Method and Description
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.
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.

Method Detail

loadChannelAcquisitionData_async

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.

Parameters:

__cb - The callback object for the operation.

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

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)
                    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.

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

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)
                             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.

Throws:

ServerError

loadTagContent_async

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.

Parameters:

__cb - The callback object for the operation.

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

Throws:

ServerError

loadTagSets_async

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.

Parameters:

__cb - The callback object for the operation.

options - The POJO options.

Throws:

ServerError

getTaggedObjectsCount_async

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.

Parameters:

__cb - The callback object for the operation.

ids - The collection of ids.

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)
                              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.

Throws:

ServerError

loadAnnotation_async

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

Loads the specified annotations.

Parameters:

__cb - The callback object for the operation.

annotationIds - The collection of annotation ids.

Throws:

ServerError

loadInstrument_async

void loadInstrument_async(AMD_IMetadata_loadInstrument __cb,
                          long id)
                   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.

Throws:

ServerError

loadAnnotationsUsedNotOwned_async

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.

Parameters:

__cb - The callback object for the operation.

annotationType - The type of annotations to load.

Throws:

ServerError

countAnnotationsUsedNotOwned_async

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.

Parameters:

__cb - The callback object for the operation.

annotationType - The type of annotations to load.

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)
                                     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.

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

loadLogFiles_async

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.

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