fr.igred.omero.containers

Class ProjectWrapper

java.lang.Object

fr.igred.omero.ObjectWrapper<T>

fr.igred.omero.AnnotatableWrapper<ProjectData>

fr.igred.omero.containers.ProjectWrapper

All Implemented Interfaces:

Annotatable, Project, RemoteObject, RepositoryObject

public class ProjectWrapper
extends AnnotatableWrapper<ProjectData>
implements Project

Class containing a ProjectData object.

Wraps function calls to the Project contained

Field Summary

Fields

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

Fields inherited from class fr.igred.omero.ObjectWrapper

data

Constructor Summary

Constructors

Constructor and Description
ProjectWrapper(DataManager dm, String name, String description) Constructor of the ProjectWrapper class.
ProjectWrapper(ProjectData project) Constructor of the ProjectWrapper class.

Method Summary

Modifier and Type	Method and Description
Dataset	addDataset(DataManager dm, String name, String description) Creates a dataset and adds it to the project in OMERO. .
protected String	annotationLinkType() Returns the type of annotation link for this object.
List<Dataset>	getDatasets() Gets all the datasets in the project available from OMERO.
String	getDescription() Gets the project description.
List<Image>	getImages(Browser browser) Gets all images in the project available from OMERO.
String	getName() Gets the project name.
void	reload(Browser browser) Reloads the project from OMERO.
void	removeDataset(Client client, Dataset dataset) Removes a dataset from the project in OMERO.
void	setDescription(String description) Sets the description of the project.
void	setName(String name) Sets the name of the project.

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, getUpdated, 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.containers.Project

addDataset, asDataObject, getChildren, getDatasets, getDatasets, getImages, getImages, getImagesLike, getImagesTagged, getImagesTagged, getImagesWithKey, getImagesWithKeyValuePair, getParents

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, link, linkIfNotLinked, rate, unlink

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, distinct, flatten, getCreated, getElementsOf, getGroupId, getId, getOwner, getUpdated, saveAndUpdate

Field Detail

ANNOTATION_LINK

public static final String ANNOTATION_LINK

Annotation link name for this type of object

See Also:

Constant Field Values

Constructor Detail

ProjectWrapper

public ProjectWrapper(ProjectData project)

Constructor of the ProjectWrapper class.

Parameters:

project - ProjectData to be contained.

ProjectWrapper

public ProjectWrapper(DataManager dm,
                      String name,
                      String description)
               throws ServiceException,
                      AccessException,
                      ExecutionException

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

Parameters:

dm - The data manager.

name - Project name.

description - Project description.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

Method Detail

getName

public String getName()

Gets the project name.

Specified by:

getName in interface RepositoryObject

Returns:

See above.

setName

public void setName(String name)

Sets the name of the project.

Specified by:

setName in interface Project

Parameters:

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

Throws:

IllegalArgumentException - If the name is null.

getDescription

public String getDescription()

Gets the project description.

Specified by:

getDescription in interface RepositoryObject

Returns:

See above.

setDescription

public void setDescription(String description)

Sets the description of the project.

Specified by:

setDescription in interface Project

Parameters:

description - The description of the project.

annotationLinkType

protected String annotationLinkType()

Returns the type of annotation link for this object.

Specified by:

annotationLinkType in class AnnotatableWrapper<ProjectData>

Returns:

See above.

getDatasets

public List<Dataset> getDatasets()

Gets all the datasets in the project available from OMERO.

Specified by:

getDatasets in interface Project

Returns:

Collection of Dataset.

addDataset

public Dataset addDataset(DataManager dm,
                          String name,
                          String description)
                   throws ServiceException,
                          AccessException,
                          ExecutionException

Creates a dataset and adds it to the project in OMERO. .

The project needs to be reloaded afterwards to list the new dataset.

Specified by:

addDataset in interface Project

Parameters:

dm - The data manager.

name - Dataset name.

description - Dataset description.

Returns:

The object saved in OMERO.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

removeDataset

public void removeDataset(Client client,
                          Dataset dataset)
                   throws ServiceException,
                          AccessException,
                          ExecutionException,
                          InterruptedException

Removes a dataset from the project in OMERO.

Specified by:

removeDataset in interface Project

Parameters:

client - The client handling the connection.

dataset - Dataset to remove.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

InterruptedException - If block(long) does not return.

getImages

public List<Image> getImages(Browser browser)
                      throws ServiceException,
                             AccessException,
                             ExecutionException

Gets all images in the project available from OMERO.

Specified by:

getImages in interface Project

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

reload

public void reload(Browser browser)
            throws ServiceException,
                   AccessException,
                   ExecutionException

Reloads the project from OMERO.

Specified by:

reload in interface Project

Specified by:

reload in interface RepositoryObject

Parameters:

browser - The data browser.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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