omero.gateway.model

Class ScreenData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ScreenData

public class ScreenData
extends DataObject

The data that makes up an OME Screen along with links to its contained Plates and the Experimenter that owns this Screen.

Since:

3.0-Beta3

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION Identifies the ScreenI.DESCRIPTION field.
static String	NAME Identifies the ScreenI.NAME field.
static String	PLATE_LINKS Identifies the ScreenI.PLATELINKS field.

Constructor Summary

Constructors

Constructor and Description
ScreenData() Creates a new instance.
ScreenData(omero.model.Screen screen) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Map<Long,Long>	getAnnotationsCounts() Returns the number of annotations linked to the object, key: id of the user, value: number of annotation.
String	getDescription() Returns the description of the screen.
String	getName() Returns the name of the screen.
Set<PlateData>	getPlates() Returns the plates contained in this screen.
String	getProtocolDescription() Returns the description of the protocol.
String	getProtocolIdentifier() Returns the identifier of the protocol.
String	getReagentSetDescripion() Returns the description of the reagent set.
String	getReagentSetIdentifier() Returns the identifier of the Reagent set.
void	setDescription(String description) Sets the description of the screen.
void	setName(String name) Sets the name of the screen.
void	setPlates(Set<PlateData> value) Sets the plates contained in this screen.
void	setProtocolDescription(String value) Sets the description of the protocol.
void	setProtocolIdentifier(String value) Sets the identifier of the protocol.
void	setReagentSetDescripion(String value) Sets the identifier of the reagent.
void	setReagentSetIdentifier(String value) Sets the identifier of the reagent.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Identifies the ScreenI.NAME field.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Identifies the ScreenI.DESCRIPTION field.

See Also:

Constant Field Values

PLATE_LINKS

public static final String PLATE_LINKS

Identifies the ScreenI.PLATELINKS field.

See Also:

Constant Field Values

Constructor Detail

ScreenData

public ScreenData()

Creates a new instance.

ScreenData

public ScreenData(omero.model.Screen screen)

Creates a new instance.

Parameters:

screen - Back pointer to the Screen model object. Mustn't be null.

Throws:

IllegalArgumentException - If the object is null.

Method Detail

setName

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

getName

public String getName()

Returns the name of the screen.

Returns:

See above.

setDescription

public void setDescription(String description)

Sets the description of the screen.

Parameters:

description - The description of the screen.

getDescription

public String getDescription()

Returns the description of the screen.

Returns:

See above.

getAnnotationsCounts

public Map<Long,Long> getAnnotationsCounts()

Returns the number of annotations linked to the object, key: id of the user, value: number of annotation. The map may be null if no annotation.

Returns:

See above.

getPlates

public Set<PlateData> getPlates()

Returns the plates contained in this screen.

Returns:

See above.

setPlates

public void setPlates(Set<PlateData> value)

Sets the plates contained in this screen.

Parameters:

value - The set of plates.

getProtocolDescription

public String getProtocolDescription()

Returns the description of the protocol.

Returns:

See above.

setProtocolDescription

public void setProtocolDescription(String value)

Sets the description of the protocol.

Parameters:

value - The value to set.

getProtocolIdentifier

public String getProtocolIdentifier()

Returns the identifier of the protocol.

Returns:

See above.

setProtocolIdentifier

public void setProtocolIdentifier(String value)

Sets the identifier of the protocol.

Parameters:

value - The value to set.

getReagentSetDescripion

public String getReagentSetDescripion()

Returns the description of the reagent set.

Returns:

See above.

setReagentSetDescripion

public void setReagentSetDescripion(String value)

Sets the identifier of the reagent.

Parameters:

value - The value to set.

getReagentSetIdentifier

public String getReagentSetIdentifier()

Returns the identifier of the Reagent set.

Returns:

See above.

setReagentSetIdentifier

public void setReagentSetIdentifier(String value)

Sets the identifier of the reagent.

Parameters:

value - The value to set.