omero.gateway.facility

Class MetadataFacility

java.lang.Object

omero.gateway.facility.Facility

omero.gateway.facility.MetadataFacility

public class MetadataFacility
extends Facility

A Facility to access the metadata.

Since:

5.1

Method Summary

Modifier and Type	Method and Description
java.util.List<AnnotationData>	getAnnotations(SecurityContext ctx, DataObject object) Get all annotations for the given DataObject
java.util.List<AnnotationData>	getAnnotations(SecurityContext ctx, DataObject object, java.util.List<java.lang.Class<? extends AnnotationData>> annotationTypes, java.util.List<java.lang.Long> userIds) Get the annotations for the given DataObject
java.util.Map<DataObject,java.util.List<AnnotationData>>	getAnnotations(SecurityContext ctx, java.util.List<? extends DataObject> objects, java.util.List<java.lang.Class<? extends AnnotationData>> annotationTypes, java.util.List<java.lang.Long> userIds) Get the annotations for the given DataObjects
java.util.List<ChannelData>	getChannelData(SecurityContext ctx, long imageId) Get the ChannelData for a specific image
ImageAcquisitionData	getImageAcquisitionData(SecurityContext ctx, long imageId) Loads the ImageAcquisitionData for a specific image

Methods inherited from class omero.gateway.facility.Facility

addPropertyChangeListener, clear, firePropertyChanged, firePropertyChanged, getFacility, logDebug, logError, logInfo, logWarn, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Method Detail

getImageAcquisitionData

public ImageAcquisitionData getImageAcquisitionData(SecurityContext ctx,
                                                    long imageId)
                                             throws DSOutOfServiceException,
                                                    DSAccessException

Loads the ImageAcquisitionData for a specific image

Parameters:

ctx - The SecurityContext

imageId - The imageId

Returns:

See above

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

getChannelData

public java.util.List<ChannelData> getChannelData(SecurityContext ctx,
                                                  long imageId)
                                           throws DSOutOfServiceException,
                                                  DSAccessException

Get the ChannelData for a specific image

Parameters:

ctx - The SecurityContext

imageId - The imageId to get the ChannelData for

Returns:

List of ChannelData

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

getAnnotations

public java.util.List<AnnotationData> getAnnotations(SecurityContext ctx,
                                                     DataObject object)
                                              throws DSOutOfServiceException,
                                                     DSAccessException

Get all annotations for the given DataObject

Parameters:

ctx - The SecurityContext

object - The DataObject to load the annotations for

Returns:

See above

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

getAnnotations

public java.util.List<AnnotationData> getAnnotations(SecurityContext ctx,
                                                     DataObject object,
                                                     java.util.List<java.lang.Class<? extends AnnotationData>> annotationTypes,
                                                     java.util.List<java.lang.Long> userIds)
                                              throws DSOutOfServiceException,
                                                     DSAccessException

Get the annotations for the given DataObject

Parameters:

ctx - The SecurityContext

object - The DataObject to load the annotations for

annotationTypes - The type of annotations to load (can be null)

userIds - Only load annotations of certain users (can be null, i. e. all users)

Returns:

See above

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.

getAnnotations

public java.util.Map<DataObject,java.util.List<AnnotationData>> getAnnotations(SecurityContext ctx,
                                                                               java.util.List<? extends DataObject> objects,
                                                                               java.util.List<java.lang.Class<? extends AnnotationData>> annotationTypes,
                                                                               java.util.List<java.lang.Long> userIds)
                                                                        throws DSOutOfServiceException,
                                                                               DSAccessException

Get the annotations for the given DataObjects

Parameters:

ctx - The SecurityContext

objects - The DataObjects to load the annotations for (have to be all of the same type)

annotationTypes - The type of annotations to load (can be null)

userIds - Only load annotations of certain users (can be null, i. e. all users)

Returns:

Lists of AnnotationData mapped to the DataObject they are attached to.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.