fr.igred.omero.containers

Class DatasetWrapper

java.lang.Object

fr.igred.omero.ObjectWrapper<T>

fr.igred.omero.AnnotatableWrapper<T>

fr.igred.omero.ImportWrapper<DatasetData>

fr.igred.omero.containers.DatasetWrapper

All Implemented Interfaces:

Annotatable, Dataset, RemoteObject, RepositoryObject

public class DatasetWrapper
extends ImportWrapper<DatasetData>
implements Dataset

Class containing a DatasetData object.

Wraps function calls to the DatasetData 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
DatasetWrapper(DatasetData dataset) Constructor of the DatasetWrapper class
DatasetWrapper(String name, String description) Constructor of the DatasetWrapper class

Method Summary

Modifier and Type	Method and Description
protected String	annotationLinkType() Returns the type of annotation link for this object.
String	getDescription() Gets the DatasetData description
List<Image>	getImages() Gets all the images in the dataset (if it was properly loaded from OMERO).
List<Image>	getImages(Browser browser) Gets all images in the dataset available from OMERO.
String	getName() Gets the DatasetData name
List<Long>	importImage(ConnectionHandler client, String path) Imports one image file to the dataset in OMERO.
boolean	importImages(ConnectionHandler client, String... paths) Imports all images candidates in the paths to the dataset in OMERO.
void	reload(Browser browser) Reloads the dataset from OMERO.
void	removeImage(Client client, Image image) Removes an image from the dataset in OMERO.
void	setDescription(String description) Sets the description of the dataset.
void	setName(String name) Sets the name of the dataset.

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

addImage, addImages, asDataObject, getChildren, getImages, getImagesLike, getImagesTagged, getImagesTagged, getImagesWithKey, getImagesWithKeyValuePair, getParents, getProjects, importAndReplaceImages, importAndReplaceImages, replaceImages

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

DatasetWrapper

public DatasetWrapper(String name,
                      String description)

Constructor of the DatasetWrapper class

Parameters:

name - Name of the dataset.

description - Description of the dataset.

DatasetWrapper

public DatasetWrapper(DatasetData dataset)

Constructor of the DatasetWrapper class

Parameters:

dataset - Dataset to be contained.

Method Detail

getName

public String getName()

Gets the DatasetData name

Specified by:

getName in interface RepositoryObject

Returns:

DatasetData name.

setName

public void setName(String name)

Sets the name of the dataset.

Specified by:

setName in interface Dataset

Parameters:

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

Throws:

IllegalArgumentException - If the name is null.

getDescription

public String getDescription()

Gets the DatasetData description

Specified by:

getDescription in interface RepositoryObject

Returns:

DatasetData description.

setDescription

public void setDescription(String description)

Sets the description of the dataset.

Specified by:

setDescription in interface Dataset

Parameters:

description - The description of the dataset.

annotationLinkType

protected String annotationLinkType()

Returns the type of annotation link for this object.

Specified by:

annotationLinkType in class AnnotatableWrapper<DatasetData>

Returns:

See above.

getImages

public List<Image> getImages()

Gets all the images in the dataset (if it was properly loaded from OMERO).

Specified by:

getImages in interface Dataset

Returns:

See above.

getImages

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

Gets all images in the dataset available from OMERO.

Specified by:

getImages in interface Dataset

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.

removeImage

public void removeImage(Client client,
                        Image image)
                 throws ServiceException,
                        AccessException,
                        ExecutionException,
                        InterruptedException

Removes an image from the dataset in OMERO.

Specified by:

removeImage in interface Dataset

Parameters:

client - The client handling the connection.

image - Image 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.

importImages

public boolean importImages(ConnectionHandler client,
                            String... paths)
                     throws ServiceException,
                            AccessException,
                            IOException

Imports all images candidates in the paths to the dataset in OMERO.

Specified by:

importImages in interface Dataset

Overrides:

importImages in class ImportWrapper<DatasetData>

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.

IOException - Cannot read file.

importImage

public List<Long> importImage(ConnectionHandler client,
                              String path)
                       throws ServiceException,
                              AccessException,
                              IOException

Imports one image file to the dataset in OMERO.

Specified by:

importImage in interface Dataset

Overrides:

importImage in class ImportWrapper<DatasetData>

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.

IOException - Cannot read file.

reload

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

Reloads the dataset from OMERO.

Specified by:

reload in interface Dataset

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.