Package fr.igred.omero.client

Interface Client

All Superinterfaces:

AdminManager, Browser, ConnectionHandler, DataManager

All Known Implementing Classes:

GatewayWrapper

public interface Client
extends ConnectionHandler, Browser, DataManager, AdminManager

Client interface to connect to OMERO, browse through all the data accessible to the user and modify it.

Method Summary

Modifier and Type	Method	Description
default AdminFacility	getAdminFacility()	Gets the AdminFacility to use admin specific function.
default BrowseFacility	getBrowseFacility()	Gets the BrowseFacility used to access the data from OMERO.
default DataManagerFacility	getDMFacility()	Gets the DataManagerFacility to handle/write data on OMERO.
default MetadataFacility	getMetadataFacility()	Gets the MetadataFacility used to retrieve annotations from OMERO.
default omero.api.IQueryPrx	getQueryService()	Returns the IQueryPrx used to find objects on OMERO.
default ROIFacility	getRoiFacility()	Gets the ROIFacility used to manipulate ROIs from OMERO.
default TablesFacility	getTablesFacility()	Gets the TablesFacility used to manipulate tables on OMERO.
Client	sudo(java.lang.String username)	Gets the client associated with the username in the parameters.

Methods inherited from interface fr.igred.omero.client.AdminManager

getCtx, getGroup, getUser

Methods inherited from interface fr.igred.omero.client.Browser

findByQuery, getCtx, getDataset, getDatasets, getDatasets, getDatasets, getDatasets, getFolder, getFolders, getFolders, getImage, getImages, getImages, getImages, getImages, getImages, getImagesLike, getImagesWithKey, getImagesWithKeyValuePair, getMapAnnotation, getMapAnnotations, getMapAnnotations, getMapAnnotations, getPlate, getPlates, getPlates, getPlates, getProject, getProjects, getProjects, getProjects, getProjects, getScreen, getScreens, getScreens, getScreens, getTag, getTags, getTags, getWell, getWells, getWells, getWells, loadFolders

Methods inherited from interface fr.igred.omero.client.ConnectionHandler

connect, connect, connect, connect, disconnect, getCtx, getCurrentGroupId, getGateway, getId, getImportStore, getSessionId, getUser, isConnected, switchGroup

Methods inherited from interface fr.igred.omero.client.DataManager

delete, delete, delete, delete, delete, deleteFile, getCtx, save

Method Detail

getBrowseFacility

default BrowseFacility getBrowseFacility()
                                  throws java.util.concurrent.ExecutionException

Gets the BrowseFacility used to access the data from OMERO.

Specified by:

getBrowseFacility in interface Browser

Returns:

See above.

Throws:

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

getQueryService

default omero.api.IQueryPrx getQueryService()
                                     throws ServiceException

Returns the IQueryPrx used to find objects on OMERO.

Specified by:

getQueryService in interface Browser

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

getMetadataFacility

default MetadataFacility getMetadataFacility()
                                      throws java.util.concurrent.ExecutionException

Gets the MetadataFacility used to retrieve annotations from OMERO.

Specified by:

getMetadataFacility in interface Browser

Returns:

See above.

Throws:

java.util.concurrent.ExecutionException - If the MetadataFacility can't be retrieved or instantiated.

getDMFacility

default DataManagerFacility getDMFacility()
                                   throws java.util.concurrent.ExecutionException

Gets the DataManagerFacility to handle/write data on OMERO. A

Specified by:

getDMFacility in interface DataManager

Returns:

See above.

Throws:

java.util.concurrent.ExecutionException - If the DataManagerFacility can't be retrieved or instantiated.

getRoiFacility

default ROIFacility getRoiFacility()
                            throws java.util.concurrent.ExecutionException

Gets the ROIFacility used to manipulate ROIs from OMERO.

Specified by:

getRoiFacility in interface DataManager

Returns:

See above.

Throws:

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

getTablesFacility

default TablesFacility getTablesFacility()
                                  throws java.util.concurrent.ExecutionException

Gets the TablesFacility used to manipulate tables on OMERO.

Specified by:

getTablesFacility in interface DataManager

Returns:

See above.

Throws:

java.util.concurrent.ExecutionException - If the TablesFacility can't be retrieved or instantiated.

getAdminFacility

default AdminFacility getAdminFacility()
                                throws java.util.concurrent.ExecutionException

Gets the AdminFacility to use admin specific function.

Specified by:

getAdminFacility in interface AdminManager

Returns:

See above.

Throws:

java.util.concurrent.ExecutionException - If the AdminFacility can't be retrieved or instantiated.

sudo

Client sudo(java.lang.String username)
     throws ServiceException,
            AccessException,
            java.util.concurrent.ExecutionException

Gets the client associated with the username in the parameters. The user calling this function needs to have administrator rights. All action realized with the client returned will be considered as his.

Specified by:

sudo in interface ConnectionHandler

Parameters:

username - Username of user.

Returns:

The client corresponding to the new user.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

java.util.NoSuchElementException - The requested user does not exist.