Package fr.igred.omero.repository

Class FolderWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

fr.igred.omero.repository.GenericRepositoryObjectWrapper<FolderData>

fr.igred.omero.repository.FolderWrapper

public class FolderWrapper
extends GenericRepositoryObjectWrapper<FolderData>

Class containing a FolderData.

Implements function using the FolderData contained.

Nested Class Summary

Nested classes/interfaces inherited from class fr.igred.omero.repository.GenericRepositoryObjectWrapper

GenericRepositoryObjectWrapper.ReplacePolicy

Field Summary

Fields

Modifier and Type	Field	Description
static String	ANNOTATION_LINK

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
FolderWrapper(Client client, String name)	Constructor of the FolderWrapper class.
FolderWrapper(FolderData folder)	Constructor of the FolderWrapper class.
FolderWrapper(Folder folder)	Constructor of the FolderWrapper class.

Method Summary

Modifier and Type	Method	Description
void	addROI(Client client, ROIWrapper roi)	Add an ROI to the folder and associate it to the image id set(an image need to be associated)
protected void	addTag(Client client, TagAnnotationData tagData)	Private function.
protected String	annotationLinkType()	Returns the type of annotation link for this object
FolderData	asFolderData()	Gets the folder contained in the FolderWrapper
String	getDescription()	Gets the folder description
String	getName()	Gets the name of the folder
List<ROIWrapper>	getROIs(Client client)	Gets the ROI contained in the folder associated with the image id set (an image need to be associated)
void	setDescription(String description)	Sets the description of the folder.
void	setImage(long id)	Sets the image associated to the folder
void	setImage(ImageWrapper image)	Sets the image associated to the folder
void	setName(String name)	Sets the name of the folder.
void	unlinkAllROI(Client client)	Unlink all ROI, associated to the image set, in the folder.
void	unlinkROI(Client client, ROIWrapper roi)	Unlink an ROI, associated to the image set, in the folder.

Methods inherited from class fr.igred.omero.repository.GenericRepositoryObjectWrapper

addAndReplaceFile, addAndReplaceFile, addFile, addFileAnnotation, addMapAnnotation, addPairKeyValue, addTable, addTag, addTag, addTag, addTags, addTags, copyAnnotationLinks, getFileAnnotations, getKeyValuePairs, getMapAnnotations, getTable, getTables, getTags, getValue, removeLink, unlink

Methods inherited from class fr.igred.omero.GenericObjectWrapper

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, delete, distinct, getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATION_LINK

public static final String ANNOTATION_LINK

See Also:

Constant Field Values

Constructor Detail

FolderWrapper

public FolderWrapper(FolderData folder)

Constructor of the FolderWrapper class.

Parameters:

folder - FolderData to contain.

FolderWrapper

public FolderWrapper(Folder folder)

Constructor of the FolderWrapper class.

Parameters:

folder - Folder to contain.

FolderWrapper

public FolderWrapper(Client client,
                     String name)
              throws ServiceException,
                     OMEROServerError

Constructor of the FolderWrapper class. Save the folder in OMERO

Parameters:

client - The client handling the connection.

name - Name of the folder.

Throws:

ServiceException - Cannot connect to OMERO.

OMEROServerError - Server error.

Method Detail

annotationLinkType

protected String annotationLinkType()

Returns the type of annotation link for this object

Specified by:

annotationLinkType in class GenericRepositoryObjectWrapper<FolderData>

Returns:

See above.

addTag

protected void addTag(Client client,
                      TagAnnotationData tagData)
               throws ServiceException,
                      AccessException,
                      ExecutionException

Private function. Adds a tag to the object in OMERO, if possible.

Overrides:

addTag in class GenericRepositoryObjectWrapper<FolderData>

Parameters:

client - The client handling the connection.

tagData - Tag to be added.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getName

public String getName()

Gets the name of the folder

Specified by:

getName in class GenericRepositoryObjectWrapper<FolderData>

Returns:

name.

setName

public void setName(String name)

Sets the name of the folder.

Parameters:

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

Throws:

IllegalArgumentException - If the name is null.

asFolderData

public FolderData asFolderData()

Gets the folder contained in the FolderWrapper

Returns:

the FolderData.

getDescription

public String getDescription()

Gets the folder description

Specified by:

getDescription in class GenericRepositoryObjectWrapper<FolderData>

Returns:

The folder description.

setDescription

public void setDescription(String description)

Sets the description of the folder.

Parameters:

description - The folder description.

setImage

public void setImage(long id)

Sets the image associated to the folder

Parameters:

id - ID of the image to associate.

setImage

public void setImage(ImageWrapper image)

Sets the image associated to the folder

Parameters:

image - Image to associate.

addROI

public void addROI(Client client,
                   ROIWrapper roi)
            throws ServiceException,
                   AccessException,
                   ExecutionException

Add an ROI to the folder and associate it to the image id set(an image need to be associated)

Parameters:

client - The client handling the connection.

roi - ROI to add.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

ExecutionException - If the ROIFacility can't be retrieved or instantiated.

getROIs

public List<ROIWrapper> getROIs(Client client)
                         throws ServiceException,
                                AccessException,
                                ExecutionException

Gets the ROI contained in the folder associated with the image id set (an image need to be associated)

Parameters:

client - The client handling the connection.

Returns:

List of ROIWrapper containing the ROI.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

unlinkAllROI

public void unlinkAllROI(Client client)
                  throws ServiceException,
                         AccessException,
                         ExecutionException

Unlink all ROI, associated to the image set, in the folder. ROIs are now linked to the image directly

Parameters:

client - The client handling the connection.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

unlinkROI

public void unlinkROI(Client client,
                      ROIWrapper roi)
               throws ServiceException,
                      AccessException,
                      ExecutionException

Unlink an ROI, associated to the image set, in the folder. the ROI is now linked to the image directly

Parameters:

client - The client handling the connection.

roi - ROI to unlink.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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