omero.gateway.model

Class DatasetData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.DatasetData

public class DatasetData
extends DataObject

The data that makes up an OME Dataset along with links to its contained Images and enclosing Project as well as the Experimenter that owns this Dataset.

Since:

OME2.2

Version:

2.2

Author:

Jean-Marie Burel j.burel@dundee.ac.uk,
Andrea Falconi a.falconi@dundee.ac.uk

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATIONS Identifies the DatasetI.ANNOTATIONLINKS field.
static String	DESCRIPTION Identifies the DatasetI.DESCRIPTION field.
static String	IMAGE_LINKS Identifies the DatasetI.IMAGELINKS field.
static String	NAME Identifies the DatasetI.NAME field.
static String	PROJECT_LINKS Identifies the DatasetI.PROJECTLINKS field.

Constructor Summary

Constructors

Constructor and Description
DatasetData() Creates a new instance.
DatasetData(omero.model.Dataset dataset) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Set	getAnnotations() Returns the annotations related to this dataset.
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 dataset.
Set	getImages() Returns a set of images contained in the dataset.
String	getName() Returns the name of the dataset.
Set	getProjects() Returns a set of projects containing the dataset.
void	setAnnotations(Set newValue) Sets the annotations related to this dataset.
void	setDescription(String description) Sets the description of the dataset.
void	setImages(Set<ImageData> newValue) Sets the images contained in this dataset.
void	setName(String name) Sets the name of the dataset.
void	setProjects(Set<ProjectData> newValue) Sets the projects containing the dataset.

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 DatasetI.NAME field.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Identifies the DatasetI.DESCRIPTION field.

See Also:

Constant Field Values

IMAGE_LINKS

public static final String IMAGE_LINKS

Identifies the DatasetI.IMAGELINKS field.

See Also:

Constant Field Values

PROJECT_LINKS

public static final String PROJECT_LINKS

Identifies the DatasetI.PROJECTLINKS field.

See Also:

Constant Field Values

ANNOTATIONS

public static final String ANNOTATIONS

Identifies the DatasetI.ANNOTATIONLINKS field.

See Also:

Constant Field Values

Constructor Detail

DatasetData

public DatasetData()

Creates a new instance.

DatasetData

public DatasetData(omero.model.Dataset dataset)

Creates a new instance.

Parameters:

dataset - Back pointer to the Dataset 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 dataset.

Parameters:

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

Throws:

IllegalArgumentException - If the name is null.

getName

public String getName()

Returns the name of the dataset.

Returns:

See above.

setDescription

public void setDescription(String description)

Sets the description of the dataset.

Parameters:

description - The description of the dataset.

getDescription

public String getDescription()

Returns the description of the dataset.

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.

getImages

public Set getImages()

Returns a set of images contained in the dataset.

Returns:

See above.

getProjects

public Set getProjects()

Returns a set of projects containing the dataset.

Returns:

See above.

setImages

public void setImages(Set<ImageData> newValue)

Sets the images contained in this dataset.

Parameters:

newValue - The set of images.

setProjects

public void setProjects(Set<ProjectData> newValue)

Sets the projects containing the dataset.

Parameters:

newValue - The set of projects.

getAnnotations

public Set getAnnotations()

Returns the annotations related to this dataset. Not sure we are going to keep this method.

Returns:

See Above

setAnnotations

public void setAnnotations(Set newValue)

Sets the annotations related to this dataset.

Parameters:

newValue - The set of annotations.