fr.igred.omero

Interface RemoteObject

All Known Subinterfaces:

Annotatable, Annotation, Channel, Dataset, Ellipse, Experimenter, FileAnnotation, Folder, Group, Image, Line, MapAnnotation, Mask, Pixels, PlaneInfo, Plate, PlateAcquisition, Point, Polygon, Polyline, Project, RatingAnnotation, Rectangle, RepositoryObject, ROI, Screen, Shape, TagAnnotation, Text, TextualAnnotation, Well, WellSample

All Known Implementing Classes:

AnnotatableWrapper, AnnotationWrapper, ChannelWrapper, DatasetWrapper, EllipseWrapper, ExperimenterWrapper, FileAnnotationWrapper, FolderWrapper, GroupWrapper, ImageWrapper, ImportWrapper, LineWrapper, MapAnnotationWrapper, MaskWrapper, ObjectWrapper, PixelsWrapper, PlaneInfoWrapper, PlateAcquisitionWrapper, PlateWrapper, PointWrapper, PolygonWrapper, PolylineWrapper, ProjectWrapper, RatingAnnotationWrapper, RectangleWrapper, ROIWrapper, ScreenWrapper, ShapeWrapper, TagAnnotationWrapper, TextualAnnotationWrapper, TextWrapper, WellSampleWrapper, WellWrapper

public interface RemoteObject

Generic interface to handle OMERO objects.

Method Summary

Modifier and Type	Method and Description
DataObject	asDataObject() Returns a DataObject (or a subclass) corresponding to the handled object.
boolean	canAnnotate() Returns true if the object can be annotated false otherwise, depending on permissions level.
boolean	canChgrp() Returns true if the object can be moved by the user currently logged in, false otherwise, depending on permissions level.
boolean	canChown() Returns true if the object can be given by the user currently logged in, false otherwise, depending on permissions level.
boolean	canDelete() Returns true if the object can be deleted by the user currently logged in, false otherwise, depending on permissions level.
boolean	canEdit() Returns true if the object can be edited by the user currently logged in false otherwise, depending on permissions level.
boolean	canLink() Returns true if the object can be linked e.g. image add to dataset, by the user currently logged in, false otherwise, depending on permissions level.
static <T extends RemoteObject> List<T>	distinct(Collection<? extends T> objects) Only keeps objects with different IDs in a collection.
static <T extends RemoteObject> List<T>	flatten(Collection<? extends Collection<? extends T>> lists) Flattens a collection of collections and only keeps objects with different IDs.
Timestamp	getCreated() Gets the time when the object was created.
static <U extends RemoteObject,V extends U> List<V>	getElementsOf(Collection<? extends U> collection, Class<? extends V> clazz) Gets a list of elements of the specified class from a collection of RemoteObjects.
Long	getGroupId() Gets the group ID
long	getId() Gets the object id
Experimenter	getOwner() Gets the owner ID
Timestamp	getUpdated() Gets the time when the object was last updated.
void	saveAndUpdate(DataManager dm) Saves and updates object.

Method Detail

getElementsOf

static <U extends RemoteObject,V extends U> List<V> getElementsOf(Collection<? extends U> collection,
                                                                  Class<? extends V> clazz)

Gets a list of elements of the specified class from a collection of RemoteObjects.

Type Parameters:

U - Subclass of RemoteObject.

V - Subclass of U.

Parameters:

clazz - Class of the wanted elements.

collection - The collection of RemoteObjects

Returns:

See above.

distinct

static <T extends RemoteObject> List<T> distinct(Collection<? extends T> objects)

Only keeps objects with different IDs in a collection.

Type Parameters:

T - The objects type.

Parameters:

objects - A collection of objects.

Returns:

Distinct objects list, sorted by ID.

flatten

static <T extends RemoteObject> List<T> flatten(Collection<? extends Collection<? extends T>> lists)

Flattens a collection of collections and only keeps objects with different IDs.

Type Parameters:

T - The objects type.

Parameters:

lists - A collection of objects collections.

Returns:

Distinct objects list, sorted by ID.

asDataObject

DataObject asDataObject()

Returns a DataObject (or a subclass) corresponding to the handled object.

Returns:

See above.

getId

long getId()

Gets the object id

Returns:

id.

getCreated

Timestamp getCreated()

Gets the time when the object was created.

Returns:

creation date.

getUpdated

Timestamp getUpdated()

Gets the time when the object was last updated.

Returns:

creation date.

getOwner

Experimenter getOwner()

Gets the owner ID

Returns:

owner id.

getGroupId

Long getGroupId()

Gets the group ID

Returns:

group id.

saveAndUpdate

void saveAndUpdate(DataManager dm)
            throws ExecutionException,
                   ServiceException,
                   AccessException

Saves and updates object.

Parameters:

dm - The data manager.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

ExecutionException - A Facility can't be retrieved or instantiated.

canAnnotate

boolean canAnnotate()

Returns true if the object can be annotated false otherwise, depending on permissions level.

Returns:

See above.

canEdit

boolean canEdit()

Returns true if the object can be edited by the user currently logged in false otherwise, depending on permissions level.

Returns:

See above.

canLink

boolean canLink()

Returns true if the object can be linked e.g. image add to dataset, by the user currently logged in, false otherwise, depending on permissions level.

Returns:

See above.

canDelete

boolean canDelete()

Returns true if the object can be deleted by the user currently logged in, false otherwise, depending on permissions level.

Returns:

See above.

canChgrp

boolean canChgrp()

Returns true if the object can be moved by the user currently logged in, false otherwise, depending on permissions level.

Returns:

See above.

canChown

boolean canChown()

Returns true if the object can be given by the user currently logged in, false otherwise, depending on permissions level.

Returns:

See above.