omero.gateway.model

Class ProjectData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ProjectData

public class ProjectData
extends DataObject

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

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	DATASET_LINKS Identifies the ProjectI.DATASETLINKS field.
static String	DESCRIPTION Identifies the ProjectI.DESCRIPTION field.
static String	NAME Identifies the ProjectI.NAME field.

Constructor Summary

Constructors

Constructor and Description
ProjectData() Creates a new instance.
ProjectData(omero.model.Project project) 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.
Set<DatasetData>	getDatasets() Returns the datasets contained in this project.
String	getDescription() Returns the description of the project.
String	getName() Returns the name of the project.
void	setDatasets(Set<DatasetData> newValue) Sets the datasets contained in this project.
void	setDescription(String description) Sets the description of the project.
void	setName(String name) Sets the name of the project.

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

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Identifies the ProjectI.DESCRIPTION field.

See Also:

Constant Field Values

DATASET_LINKS

public static final String DATASET_LINKS

Identifies the ProjectI.DATASETLINKS field.

See Also:

Constant Field Values

Constructor Detail

ProjectData

public ProjectData()

Creates a new instance.

ProjectData

public ProjectData(omero.model.Project project)

Creates a new instance.

Parameters:

project - Back pointer to the Project 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 project.

Parameters:

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

Throws:

IllegalArgumentException - If the name is null.

getName

public String getName()

Returns the name of the project.

Returns:

See above.

setDescription

public void setDescription(String description)

Sets the description of the project.

Parameters:

description - The description of the project.

getDescription

public String getDescription()

Returns the description of the project.

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.

getDatasets

public Set<DatasetData> getDatasets()

Returns the datasets contained in this project.

Returns:

See above.

setDatasets

public void setDatasets(Set<DatasetData> newValue)

Sets the datasets contained in this project.

Parameters:

newValue - The set of datasets.