fr.igred.omero.screen

Interface Screen

All Superinterfaces:

Annotatable, RemoteObject, RepositoryObject

All Known Implementing Classes:

ScreenWrapper

public interface Screen
extends RepositoryObject, Annotatable

Interface to handle Screens on OMERO.

Method Summary

Modifier and Type	Method and Description
ScreenData	asDataObject() Returns an ScreenData corresponding to the handled object.
default List<RepositoryObject>	getChildren(Browser browser) Gets the object parents.
default List<Image>	getImages(Browser browser) Retrieves the images contained in this screen.
default List<RepositoryObject>	getParents(Browser browser) Returns an empty list as screens do not have parents.
default List<PlateAcquisition>	getPlateAcquisitions(Browser browser) Returns the plate acquisitions linked to this object, either directly, or through parents/children.
List<Plate>	getPlates() Returns the plates contained in this screen.
default List<Plate>	getPlates(Browser browser) Reloads this screen and returns the updated list of plates within.
default List<Plate>	getPlates(String name) Returns the plates contained in this screen, with the specified name.
String	getProtocolDescription() Returns the description of the protocol.
String	getProtocolIdentifier() Returns the identifier of the protocol.
String	getReagentSetDescription() Returns the description of the reagent set.
String	getReagentSetIdentifier() Returns the identifier of the Reagent set.
default List<Well>	getWells(Browser browser) Retrieves the wells linked to this object, either directly, or through parents/children.
List<Long>	importImage(ConnectionHandler client, String path) Imports one image file to the screen in OMERO.
boolean	importImages(ConnectionHandler client, String... paths) Imports all images candidates in the paths to the screen in OMERO.
void	reload(Browser browser) Reloads the screen from OMERO.
void	setDescription(String description) Sets the description of the screen.
void	setName(String name) Sets the name of the screen.
void	setProtocolDescription(String value) Sets the description of the protocol.
void	setProtocolIdentifier(String value) Sets the identifier of the protocol.
void	setReagentSetDescription(String value) Sets the identifier of the reagent.
void	setReagentSetIdentifier(String value) Sets the identifier of the reagent.

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, 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

ScreenData asDataObject()

Returns an ScreenData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

setName

void setName(String name)

Sets the name of the screen.

Parameters:

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

Throws:

IllegalArgumentException - If the name is null.

setDescription

void setDescription(String description)

Sets the description of the screen.

Parameters:

description - The description of the screen.

getParents

default List<RepositoryObject> getParents(Browser browser)

Returns an empty list as screens do not have parents.

Specified by:

getParents in interface RepositoryObject

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

NoSuchElementException - Screens do not have parents.

getChildren

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

Gets the object parents.

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.

getPlates

List<Plate> getPlates()

Returns the plates contained in this screen.

Returns:

See above.

getPlates

default List<Plate> getPlates(Browser browser)
                       throws ServiceException,
                              AccessException,
                              ExecutionException

Reloads this screen and returns the updated list of plates within.

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.

getPlates

default List<Plate> getPlates(String name)

Returns the plates contained in this screen, with the specified name.

Parameters:

name - The expected plates name.

Returns:

See above.

getPlateAcquisitions

default List<PlateAcquisition> getPlateAcquisitions(Browser browser)
                                             throws ServiceException,
                                                    AccessException,
                                                    ExecutionException

Returns the plate acquisitions linked to this object, either directly, or through parents/children.

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.

getWells

default List<Well> getWells(Browser browser)
                     throws ServiceException,
                            AccessException,
                            ExecutionException

Retrieves the wells linked to this object, either directly, or through parents/children.

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.

getImages

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

Retrieves the images contained in this screen.

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.

getProtocolDescription

String getProtocolDescription()

Returns the description of the protocol.

Returns:

See above.

setProtocolDescription

void setProtocolDescription(String value)

Sets the description of the protocol.

Parameters:

value - The value to set.

getProtocolIdentifier

String getProtocolIdentifier()

Returns the identifier of the protocol.

Returns:

See above.

setProtocolIdentifier

void setProtocolIdentifier(String value)

Sets the identifier of the protocol.

Parameters:

value - The value to set.

getReagentSetDescription

String getReagentSetDescription()

Returns the description of the reagent set.

Returns:

See above.

setReagentSetDescription

void setReagentSetDescription(String value)

Sets the identifier of the reagent.

Parameters:

value - The value to set.

getReagentSetIdentifier

String getReagentSetIdentifier()

Returns the identifier of the Reagent set.

Returns:

See above.

setReagentSetIdentifier

void setReagentSetIdentifier(String value)

Sets the identifier of the reagent.

Parameters:

value - The value to set.

reload

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

Reloads the screen from OMERO.

Specified by:

reload in interface RepositoryObject

Parameters:

browser - The data browser.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

importImages

boolean importImages(ConnectionHandler client,
                     String... paths)
              throws ServiceException,
                     IOException,
                     AccessException

Imports all images candidates in the paths to the screen in OMERO.

Parameters:

client - The client handling the connection.

paths - Paths to the image files on the computer.

Returns:

If the import did not exit because of an error.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

IOException - Cannot read file.

importImage

List<Long> importImage(ConnectionHandler client,
                       String path)
                throws ServiceException,
                       AccessException,
                       IOException

Imports one image file to the screen in OMERO.

Parameters:

client - The client handling the connection.

path - Path to the image file on the computer.

Returns:

The list of IDs of the newly imported images.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

IOException - Cannot read file.