Version: 5.3.3-ice35-b63

OmeroBlitz API

omero::api::IMetadata

Overview

[ "ami", "amd" ] interface IMetadata extends ServiceInterface

Provides method to interact with acquisition metadata and annotations.

Operation Index

loadChannelAcquisitionData: Loads the logical channels and the acquisition metadata related to them.
loadAnnotations: Loads all the annotations of given types, that have been attached to the specified rootNodes for the specified annotatorIds.
loadSpecifiedAnnotations: Loads all the annotations of a given type.
loadTagContent: Loads the TagSet if the id is specified otherwise loads all the TagSet.
loadTagSets: Loads all the TagSets.
getTaggedObjectsCount: Returns a map whose key is a tag id and the value the number of Projects, Datasets, and Images linked to that tag.
countSpecifiedAnnotations: Counts the number of annotation of a given type.
loadAnnotation: Loads the specified annotations.
loadInstrument: Loads the instrument and its components i.e.
loadAnnotationsUsedNotOwned: Loads the annotations of a given type used by the specified user but not owned by the user.
countAnnotationsUsedNotOwned: Counts the number of annotation of a given type used by the specified user but not owned by the user.
loadSpecifiedAnnotationsLinkedTo: Loads the annotations of a given type linked to the specified objects.
loadLogFiles: Finds the original file IDs for the import logs corresponding to the given Image or Fileset IDs.

Operations

LogicalChannelList loadChannelAcquisitionData(sys::LongList ids) throws ServerError

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

Parameters

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

Return Value

The collection of loaded logical channels.

LongIObjectListMap loadAnnotations(string rootType, sys::LongList rootIds, StringSet annotationTypes, sys::LongList annotatorIds, sys::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 model::Annotation objects.

Parameters

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.
annotationType: 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.

Return Value

A map whose key is rootId and value the Map of all annotations for that node or null.

AnnotationList loadSpecifiedAnnotations(string annotationType, StringSet include, StringSet exclude, sys::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

annotationType: The type of annotations to load.
include: Include the annotations with the specified name spaces.
exclude: Exclude the annotations with the specified name spaces.
options: The POJO options.

Return Value

A collection of found annotations.

LongIObjectListMap loadTagContent(sys::LongList ids, sys::Parameters options) throws ServerError

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

Parameters

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

Return Value

Map whose key is a Tag/TagSet and the value either a Map or a list of related DataObject.

IObjectList loadTagSets(sys::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

options: The POJO options.

Return Value

See above.

sys::CountMap getTaggedObjectsCount(sys::LongList ids, sys::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

ids: The collection of ids.
options: The POJO options.

Return Value

See above.

RLong countSpecifiedAnnotations(string annotationType, StringSet include, StringSet exclude, sys::Parameters options) throws ServerError

Counts the number of annotation of a given type.

Parameters

annotationType: The type of annotations to load.
include: The collection of name space, one of the constants defined by this class.
exclude: The collection of name space, one of the constants defined by this class.
options: The POJO options.

Return Value

See above.

AnnotationList loadAnnotation(sys::LongList annotationIds) throws ServerError

Loads the specified annotations.

Parameters

annotationIds: The collection of annotation ids.

Return Value

See above.

model::Instrument loadInstrument(long id) throws ServerError

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

Parameters

id: The id of the instrument to load.

Return Value

See above

IObjectList loadAnnotationsUsedNotOwned(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

annotationType: The type of annotations to load.
userID: The identifier of the user.

Return Value

See above.

RLong countAnnotationsUsedNotOwned(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

annotationType: The type of annotations to load.
userID: The identifier of the user.

Return Value

See above.

LongAnnotationListMap loadSpecifiedAnnotationsLinkedTo(string annotationType, StringSet include, StringSet exclude, string rootNodeType, sys::LongList rootNodeIds, sys::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 model::Annotation objects. The rootNodeType supported are: Project, Dataset, Image, Pixels, Screen, Plate, PlateAcquisition, Well, Fileset.

Parameters

annotationType: The type of annotations to load.
include: Include the annotations with the specified name spaces.
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.
options: The POJO options.

Return Value

A collection of found annotations.

LongIObjectListMap loadLogFiles(string rootType, sys::LongList ids) throws ServerError

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

Parameters

rootNodeType: the root node type, may be model::Image or model::Fileset
ids: the IDs of the entities for which the import log original file IDs are required

Return Value

the original file IDs of the import logs

Home

Index