Package fr.igred.omero.screen

Interface Screen

All Superinterfaces:

Annotatable, HCSLinked, ImageLinked, RemoteObject, RepositoryObject

All Known Implementing Classes:

ScreenWrapper

public interface Screen
extends RepositoryObject, HCSLinked

Interface to handle Screens on OMERO.

Method Summary

Modifier and Type	Method	Description
ScreenData	asDataObject()	Returns an ScreenData corresponding to the handled object.
default java.util.List<Image>	getImages(Browser browser)	Retrieves the images contained in this screen.
default java.util.List<PlateAcquisition>	getPlateAcquisitions(Browser browser)	Returns the plate acquisitions linked to this object, either directly, or through parents/children.
java.util.List<Plate>	getPlates()	Returns the plates contained in this screen.
default java.util.List<Plate>	getPlates(Browser browser)	Reloads this screen and returns the updated list of plates linked to this screen.
default java.util.List<Plate>	getPlates(java.lang.String name)	Returns the plates contained in this screen, with the specified name.
java.lang.String	getProtocolDescription()	Returns the description of the protocol.
java.lang.String	getProtocolIdentifier()	Returns the identifier of the protocol.
java.lang.String	getReagentSetDescription()	Returns the description of the reagent set.
java.lang.String	getReagentSetIdentifier()	Returns the identifier of the Reagent set.
default java.util.List<Screen>	getScreens(Browser browser)	Reloads and returns this screen as a singleton list.
default java.util.List<Well>	getWells(Browser browser)	Retrieves the wells linked to this object, either directly, or through parents/children.
java.util.List<java.lang.Long>	importImage(Client client, java.lang.String path)	Imports one image file to the screen in OMERO.
boolean	importImages(Client client, java.lang.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(java.lang.String description)	Sets the description of the screen.
void	setName(java.lang.String name)	Sets the name of the screen.
void	setProtocolDescription(java.lang.String value)	Sets the description of the protocol.
void	setProtocolIdentifier(java.lang.String value)	Sets the identifier of the protocol.
void	setReagentSetDescription(java.lang.String value)	Sets the identifier of the reagent.
void	setReagentSetIdentifier(java.lang.String value)	Sets the identifier of the reagent.

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, getCreated, getGroupId, getId, getOwner, saveAndUpdate

Methods inherited from interface fr.igred.omero.RepositoryObject

getDescription, getName

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(java.lang.String name)

Sets the name of the screen.

Parameters:

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

Throws:

java.lang.IllegalArgumentException - If the name is null.

setDescription

void setDescription(java.lang.String description)

Sets the description of the screen.

Parameters:

description - The description of the screen.

getScreens

default java.util.List<Screen> getScreens(Browser browser)
                                   throws ServiceException,
                                          AccessException,
                                          java.util.concurrent.ExecutionException

Reloads and returns this screen as a singleton list.

Specified by:

getScreens in interface HCSLinked

Parameters:

browser - The data browser (unused).

Returns:

See above

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getPlates

default java.util.List<Plate> getPlates(Browser browser)
                                 throws ServiceException,
                                        AccessException,
                                        java.util.concurrent.ExecutionException

Reloads this screen and returns the updated list of plates linked to this screen.

Specified by:

getPlates in interface HCSLinked

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getPlates

java.util.List<Plate> getPlates()

Returns the plates contained in this screen.

Returns:

See above.

getPlates

default java.util.List<Plate> getPlates(java.lang.String name)

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

Parameters:

name - The expected plates name.

Returns:

See above.

getPlateAcquisitions

default java.util.List<PlateAcquisition> getPlateAcquisitions(Browser browser)
                                                       throws ServiceException,
                                                              AccessException,
                                                              java.util.concurrent.ExecutionException

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

Specified by:

getPlateAcquisitions in interface HCSLinked

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getWells

default java.util.List<Well> getWells(Browser browser)
                               throws ServiceException,
                                      AccessException,
                                      java.util.concurrent.ExecutionException

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

Specified by:

getWells in interface HCSLinked

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getImages

default java.util.List<Image> getImages(Browser browser)
                                 throws ServiceException,
                                        AccessException,
                                        java.util.concurrent.ExecutionException

Retrieves the images contained in this screen.

Specified by:

getImages in interface ImageLinked

Parameters:

browser - The data browser.

Returns:

See above

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getProtocolDescription

java.lang.String getProtocolDescription()

Returns the description of the protocol.

Returns:

See above.

setProtocolDescription

void setProtocolDescription(java.lang.String value)

Sets the description of the protocol.

Parameters:

value - The value to set.

getProtocolIdentifier

java.lang.String getProtocolIdentifier()

Returns the identifier of the protocol.

Returns:

See above.

setProtocolIdentifier

void setProtocolIdentifier(java.lang.String value)

Sets the identifier of the protocol.

Parameters:

value - The value to set.

getReagentSetDescription

java.lang.String getReagentSetDescription()

Returns the description of the reagent set.

Returns:

See above.

setReagentSetDescription

void setReagentSetDescription(java.lang.String value)

Sets the identifier of the reagent.

Parameters:

value - The value to set.

getReagentSetIdentifier

java.lang.String getReagentSetIdentifier()

Returns the identifier of the Reagent set.

Returns:

See above.

setReagentSetIdentifier

void setReagentSetIdentifier(java.lang.String value)

Sets the identifier of the reagent.

Parameters:

value - The value to set.

reload

void reload(Browser browser)
     throws ServiceException,
            AccessException,
            java.util.concurrent.ExecutionException

Reloads the screen from OMERO.

Parameters:

browser - The data browser.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

importImages

boolean importImages(Client client,
                     java.lang.String... paths)
              throws ServiceException,
                     ServerException,
                     AccessException,
                     java.io.IOException,
                     java.util.concurrent.ExecutionException

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.

ServerException - Server error.

java.io.IOException - Cannot read file.

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

importImage

java.util.List<java.lang.Long> importImage(Client client,
                                           java.lang.String path)
                                    throws ServiceException,
                                           AccessException,
                                           ServerException,
                                           java.util.concurrent.ExecutionException

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.

ServerException - Server error.

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