omero.gateway.model

Class FolderData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.FolderData

public class FolderData
extends DataObject

Pojo wrapper for an OME Folder.

Author:

Dominik Lindner d.lindner@dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
FolderData() Creates a new instance.
FolderData(omero.model.Folder folder) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
List<AnnotationData>	copyAnnotationLinks() Copy the list of annotation links, see Folder.copyAnnotationLinks()
List<FolderData>	copyChildFolders() Copy the list of child folders, see Folder.copyChildFolders()
List<ImageData>	copyImageLinks() Copy the list of image links, see Folder.copyImageLinks()
List<ROIData>	copyROILinks() Copy the list of roi links, see Folder.copyRoiLinks()
String	getDescription() Get the description of the Folder
String	getFolderPathString() Returns the folder path as string
String	getFolderPathString(char pathSeparator) Returns the folder path as string using a custom path separator
String	getName() Get the name of the Folder
FolderData	getParentFolder() Get the the parent folder
int	imageCount() Get the number of images linked to this folder
int	roiCount() Get the number of ROIs linked to this folder
void	setDescription(String desc) Set the description of the Folder
void	setFolder(omero.model.Folder f) Set the Folder
void	setName(String name) Set the name of the Folder
void	setParentFolder(omero.model.Folder parent) Set the the parent folder
int	subfolderCount() Get the number of sub folders
String	toString() Overridden to return the name of the class and the object id.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderData

public FolderData()

Creates a new instance.

FolderData

public FolderData(omero.model.Folder folder)

Creates a new instance.

Parameters:

folder - Back pointer to the Folder model object. Mustn't be null.

Throws:

IllegalArgumentException - If the object is null.

Method Detail

getName

public String getName()

Get the name of the Folder

Returns:

See above

setName

public void setName(String name)

Set the name of the Folder

Parameters:

name - The name

getDescription

public String getDescription()

Get the description of the Folder

Returns:

See above

setDescription

public void setDescription(String desc)

Set the description of the Folder

Parameters:

desc - The description

getParentFolder

public FolderData getParentFolder()

Get the the parent folder

Returns:

See above.

setParentFolder

public void setParentFolder(omero.model.Folder parent)

Set the the parent folder

Parameters:

parent - The parent folder

setFolder

public void setFolder(omero.model.Folder f)

Set the Folder

Parameters:

f - The folder

subfolderCount

public int subfolderCount()

Get the number of sub folders

Returns:

See above.

imageCount

public int imageCount()

Get the number of images linked to this folder

Returns:

See above.

roiCount

public int roiCount()

Get the number of ROIs linked to this folder

Returns:

See above.

copyChildFolders

public List<FolderData> copyChildFolders()

Copy the list of child folders, see Folder.copyChildFolders()

Returns:

See above.

copyAnnotationLinks

public List<AnnotationData> copyAnnotationLinks()

Copy the list of annotation links, see Folder.copyAnnotationLinks()

Returns:

See above.

copyImageLinks

public List<ImageData> copyImageLinks()

Copy the list of image links, see Folder.copyImageLinks()

Returns:

See above.

copyROILinks

public List<ROIData> copyROILinks()

Copy the list of roi links, see Folder.copyRoiLinks()

Returns:

See above.

toString

public String toString()

Description copied from class: DataObject

Overridden to return the name of the class and the object id.

Overrides:

toString in class DataObject

See Also:

Object.toString()

getFolderPathString

public String getFolderPathString()

Returns the folder path as string

Returns:

See above

getFolderPathString

public String getFolderPathString(char pathSeparator)

Returns the folder path as string using a custom path separator

Parameters:

pathSeparator - The path separator character

Returns:

See above