Package fr.igred.omero.screen

Class ScreenWrapper

java.lang.Object

fr.igred.omero.ObjectWrapper<T>

fr.igred.omero.AnnotatableWrapper<T>

fr.igred.omero.RepositoryObjectWrapper<ScreenData>

fr.igred.omero.screen.ScreenWrapper

All Implemented Interfaces:

Annotatable, HCSLinked, ImageLinked, RemoteObject, RepositoryObject, Screen

public class ScreenWrapper
extends RepositoryObjectWrapper<ScreenData>
implements Screen

Class containing a ScreenData object.

Wraps function calls to the ScreenData contained.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ANNOTATION_LINK	Annotation link name for this type of object

Fields inherited from class fr.igred.omero.ObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
ScreenWrapper(DataManager dm, java.lang.String name, java.lang.String description)	Constructor of the ProjectWrapper class.
ScreenWrapper(ScreenData screen)	Constructor of the class ScreenWrapper.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	annotationLinkType()	Returns the type of annotation link for this object.
java.lang.String	getDescription()	Gets the screen description
java.lang.String	getName()	Gets the screen name.
java.util.List<Plate>	getPlates()	Returns the plates contained in this screen.
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.
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 class fr.igred.omero.RepositoryObjectWrapper

importImage, importImages

Methods inherited from class fr.igred.omero.AnnotatableWrapper

addAndReplaceFile, addAndReplaceTable, addKeyValuePair, addTag, addTag, getAnnotations, getFileAnnotations, getMapAnnotations, getMyRating, getTable, getTags, rate, removeLink, unlink

Methods inherited from class fr.igred.omero.ObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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.screen.Screen

asDataObject, getImages, getPlateAcquisitions, getPlates, getPlates, getScreens, getWells

Field Detail

ANNOTATION_LINK

public static final java.lang.String ANNOTATION_LINK

Annotation link name for this type of object

See Also:

Constant Field Values

Constructor Detail

ScreenWrapper

public ScreenWrapper(DataManager dm,
                     java.lang.String name,
                     java.lang.String description)
              throws ServiceException,
                     AccessException,
                     java.util.concurrent.ExecutionException

Constructor of the ProjectWrapper class. Creates a new project and saves it to OMERO.

Parameters:

dm - The data manager.

name - Project name.

description - Project description.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

ScreenWrapper

public ScreenWrapper(ScreenData screen)

Constructor of the class ScreenWrapper.

Parameters:

screen - The ScreenData contained in the ScreenWrapper.

Method Detail

annotationLinkType

protected java.lang.String annotationLinkType()

Returns the type of annotation link for this object.

Specified by:

annotationLinkType in class AnnotatableWrapper<ScreenData>

Returns:

See above.

getName

public java.lang.String getName()

Gets the screen name.

Specified by:

getName in interface RepositoryObject

Returns:

See above.

setName

public void setName(java.lang.String name)

Sets the name of the screen.

Specified by:

setName in interface Screen

Parameters:

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

Throws:

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

getDescription

public java.lang.String getDescription()

Gets the screen description

Specified by:

getDescription in interface RepositoryObject

Returns:

See above.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the screen.

Specified by:

setDescription in interface Screen

Parameters:

description - The description of the screen.

getPlates

public java.util.List<Plate> getPlates()

Returns the plates contained in this screen.

Specified by:

getPlates in interface Screen

Returns:

See above.

getProtocolDescription

public java.lang.String getProtocolDescription()

Returns the description of the protocol.

Specified by:

getProtocolDescription in interface Screen

Returns:

See above.

setProtocolDescription

public void setProtocolDescription(java.lang.String value)

Sets the description of the protocol.

Specified by:

setProtocolDescription in interface Screen

Parameters:

value - The value to set.

getProtocolIdentifier

public java.lang.String getProtocolIdentifier()

Returns the identifier of the protocol.

Specified by:

getProtocolIdentifier in interface Screen

Returns:

See above.

setProtocolIdentifier

public void setProtocolIdentifier(java.lang.String value)

Sets the identifier of the protocol.

Specified by:

setProtocolIdentifier in interface Screen

Parameters:

value - The value to set.

getReagentSetDescription

public java.lang.String getReagentSetDescription()

Returns the description of the reagent set.

Specified by:

getReagentSetDescription in interface Screen

Returns:

See above.

setReagentSetDescription

public void setReagentSetDescription(java.lang.String value)

Sets the identifier of the reagent.

Specified by:

setReagentSetDescription in interface Screen

Parameters:

value - The value to set.

getReagentSetIdentifier

public java.lang.String getReagentSetIdentifier()

Returns the identifier of the Reagent set.

Specified by:

getReagentSetIdentifier in interface Screen

Returns:

See above.

setReagentSetIdentifier

public void setReagentSetIdentifier(java.lang.String value)

Sets the identifier of the reagent.

Specified by:

setReagentSetIdentifier in interface Screen

Parameters:

value - The value to set.

reload

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

Reloads the screen from OMERO.

Specified by:

reload in interface Screen

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

public 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.

Specified by:

importImages in interface Screen

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

public 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.

Specified by:

importImage in interface Screen

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.