fr.igred.omero.containers

Interface Folder

All Superinterfaces:

Annotatable, RemoteObject, RepositoryObject

All Known Implementing Classes:

FolderWrapper

public interface Folder
extends RepositoryObject, Annotatable

Interface to handle Folders on OMERO.

Method Summary

Modifier and Type	Method and Description
void	addChild(Folder folder) Adds a child folder to this folder.
void	addChildren(Collection<? extends Folder> folders) Adds children folders to this folder.
default void	addImages(DataManager dm, Image... images) Links images to the folder in OMERO.
default void	addROIs(DataManager dm, Image image, ROI... rois) Adds ROIs to the folder and associate them to the provided image.
default void	addROIs(DataManager dm, long imageId, ROI... rois) Adds ROIs to the folder and associate them to the provided image ID.
FolderData	asDataObject() Returns a DataObject (or a subclass) corresponding to the handled object.
List<Folder>	getChildren() Retrieves the children folders for this folder.
default List<RepositoryObject>	getChildren(Browser browser) Reloads the folder and gets its children (images and folders).
List<Image>	getImages() Retrieves the images contained in this folder.
default List<Image>	getImages(Browser browser) Retrieves the images contained in this folder.
Folder	getParent() Retrieves the parent folders for this folder.
default List<RepositoryObject>	getParents(Browser browser) Reloads the folder and returns its parent as a singleton list.
default List<ROI>	getROIs(DataManager dm, Image image) Gets the ROIs contained in the folder associated with the provided image.
List<ROI>	getROIs(DataManager dm, long imageId) Gets the ROIs contained in the folder associated with the provided image ID.
default <A extends AnnotationData> void	link(DataManager dm, A annotation) Attach an AnnotationData to this object.
void	reload(Browser browser) Reloads the folder from OMERO, to update all links.
void	setDescription(String description) Sets the description of the folder.
void	setName(String name) Sets the name of the folder.
void	setParent(Folder folder) Sets the parent folder for this folder.
void	unlinkAllROIs(DataManager dm) Unlink all ROIs associated to this folder.
default void	unlinkAllROIs(DataManager dm, Image image) Unlink all ROIs associated to the provided image from the folder.
default void	unlinkAllROIs(DataManager dm, long imageId) Unlink all ROIs associated to the provided image ID from the folder.
default void	unlinkROIs(DataManager dm, Collection<? extends ROI> rois) Unlink ROIs from the folder.
default void	unlinkROIs(DataManager dm, ROI... rois) Unlink ROIs from the folder.

Methods inherited from interface fr.igred.omero.RepositoryObject

getDescription, getName

Methods inherited from interface fr.igred.omero.Annotatable

addAndReplaceFile, addAndReplaceFile, addAndReplaceTable, addAndReplaceTable, addFile, addKeyValuePair, addTable, addTag, addTag, addTags, copyAnnotationLinks, getAnnotationData, getAnnotations, getFileAnnotations, getKeyValuePairs, getMapAnnotations, getMyRating, getTable, getTables, getTags, getValues, isLinked, link, link, linkIfNotLinked, rate, unlink

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, distinct, flatten, getCreated, getElementsOf, getGroupId, getId, getOwner, getUpdated, saveAndUpdate

Method Detail

asDataObject

FolderData asDataObject()

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

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

link

default <A extends AnnotationData> void link(DataManager dm,
                                             A annotation)
                                      throws ServiceException,
                                             AccessException,
                                             ExecutionException

Attach an AnnotationData to this object.

Specified by:

link in interface Annotatable

Type Parameters:

A - The type of the annotation.

Parameters:

dm - The client handling the connection.

annotation - The AnnotationData.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

setName

void setName(String name)

Sets the name of the folder.

Parameters:

name - The name of the folder. Mustn't be null.

Throws:

IllegalArgumentException - If the name is null.

setDescription

void setDescription(String description)

Sets the description of the folder.

Parameters:

description - The folder description.

getParent

Folder getParent()

Retrieves the parent folders for this folder.

Returns:

See above

setParent

void setParent(Folder folder)

Sets the parent folder for this folder.

Parameters:

folder - The new parent folder.

getParents

default List<RepositoryObject> getParents(Browser browser)
                                   throws AccessException,
                                          ServiceException,
                                          ExecutionException

Reloads the folder and returns its parent as a singleton list.

Specified by:

getParents in interface RepositoryObject

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

addChild

void addChild(Folder folder)

Adds a child folder to this folder.

Parameters:

folder - The new child folder.

addChildren

void addChildren(Collection<? extends Folder> folders)

Adds children folders to this folder.

Parameters:

folders - The new children folders.

getChildren

List<Folder> getChildren()

Retrieves the children folders for this folder.

Returns:

See above

getChildren

default List<RepositoryObject> getChildren(Browser browser)
                                    throws AccessException,
                                           ServiceException,
                                           ExecutionException

Reloads the folder and gets its children (images and folders).

Specified by:

getChildren in interface RepositoryObject

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

addImages

default void addImages(DataManager dm,
                       Image... images)
                throws ServiceException,
                       AccessException,
                       ExecutionException

Links images to the folder in OMERO.

The folder needs to be reloaded afterwards.

Parameters:

dm - The data manager.

images - Images to add.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getImages

List<Image> getImages()

Retrieves the images contained in this folder.

Returns:

See above

getImages

default List<Image> getImages(Browser browser)
                       throws AccessException,
                              ServiceException,
                              ExecutionException

Retrieves the images contained in this folder.

Parameters:

browser - The data browser.

Returns:

See above

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

addROIs

default void addROIs(DataManager dm,
                     long imageId,
                     ROI... rois)
              throws ServiceException,
                     AccessException,
                     ExecutionException

Adds ROIs to the folder and associate them to the provided image ID.

Parameters:

dm - The data manager.

imageId - The image ID.

rois - ROIs to add.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

ExecutionException - If the ROIFacility can't be retrieved or instantiated.

addROIs

default void addROIs(DataManager dm,
                     Image image,
                     ROI... rois)
              throws ServiceException,
                     AccessException,
                     ExecutionException

Adds ROIs to the folder and associate them to the provided image.

Parameters:

dm - The data manager.

image - The image.

rois - ROIs to add.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

ExecutionException - If the ROIFacility can't be retrieved or instantiated.

getROIs

List<ROI> getROIs(DataManager dm,
                  long imageId)
           throws ServiceException,
                  AccessException,
                  ExecutionException

Gets the ROIs contained in the folder associated with the provided image ID.

Parameters:

dm - The data manager.

imageId - The image.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getROIs

default List<ROI> getROIs(DataManager dm,
                          Image image)
                   throws ServiceException,
                          AccessException,
                          ExecutionException

Gets the ROIs contained in the folder associated with the provided image.

Parameters:

dm - The data manager.

image - The image.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

unlinkAllROIs

default void unlinkAllROIs(DataManager dm,
                           long imageId)
                    throws ServiceException,
                           AccessException,
                           ExecutionException

Unlink all ROIs associated to the provided image ID from the folder.

ROIs are now linked to the image directly.

Parameters:

dm - The data manager.

imageId - The image ID.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

unlinkAllROIs

default void unlinkAllROIs(DataManager dm,
                           Image image)
                    throws ServiceException,
                           AccessException,
                           ExecutionException

Unlink all ROIs associated to the provided image from the folder.

ROIs are now linked to the image directly.

Parameters:

dm - The data manager.

image - The image.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

unlinkAllROIs

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

Unlink all ROIs associated to this folder.

The folder must be loaded beforehand.

ROIs are now linked to their images directly.

Parameters:

dm - The data manager.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

unlinkROIs

default void unlinkROIs(DataManager dm,
                        ROI... rois)
                 throws ServiceException,
                        AccessException,
                        ExecutionException

Unlink ROIs from the folder.

The ROIs are now linked to the image directly.

Parameters:

dm - The data manager.

rois - ROI to unlink.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

unlinkROIs

default void unlinkROIs(DataManager dm,
                        Collection<? extends ROI> rois)
                 throws ServiceException,
                        AccessException,
                        ExecutionException

Unlink ROIs from the folder.

The ROIs are now linked to the image directly.

Parameters:

dm - The data manager.

rois - ROI to unlink.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

reload

void reload(Browser browser)
     throws AccessException,
            ServiceException,
            ExecutionException

Reloads the folder from OMERO, to update all links.

Specified by:

reload in interface RepositoryObject

Parameters:

browser - The data browser.

Throws:

AccessException - Cannot access data.

ServiceException - Cannot connect to OMERO.

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