omero.gateway.model

Class ROIData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ROIData

public class ROIData
extends DataObject

Converts the ROI object.

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
ROIData() Create a new instance of an ROIData object.
ROIData(omero.model.Roi roi) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addShapeData(ShapeData shape) Adds ShapeData object to ROIData.
ROICoordinate	firstPlane() Return the first plane that the ROI starts on.
Collection<FolderData>	getFolders() Get the folders this ROI is part of
ImageData	getImage() Returns the image for the ROI.
Iterator<List<ShapeData>>	getIterator() Returns the iterator of the collection of the map.
int	getPlaneCount() Returns the number of planes occupied by the ROI.
int	getShapeCount() Returns the number of shapes in the ROI.
List<ShapeData>	getShapes(int z, int t) Returns the list of shapes on a given plane.
Iterator<List<ShapeData>>	getShapesInRange(ROICoordinate start, ROICoordinate end) Returns an iterator of the Shapes in the ROI in the range [start, end].
String	getUuid() Get the UUID
boolean	isClientSide() Returns true if the object a client-side object, false otherwise.
ROICoordinate	lastPlane() Returns the last plane that the ROI ends on.
void	removeShapeData(ShapeData shape) Removes the ShapeData object from ROIData.
void	setClientSide(boolean clientSide) Sets the flag indicating if the object is a client-side object or not.
void	setImage(omero.model.Image image) Sets the image for the ROI.
void	setUuid(String uuid) Set the UUID

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

Constructor Detail

ROIData

public ROIData(omero.model.Roi roi)

Creates a new instance.

Parameters:

roi - The ROI hosted by the component.

ROIData

public ROIData()

Create a new instance of an ROIData object.

Method Detail

setImage

public void setImage(omero.model.Image image)

Sets the image for the ROI.

Parameters:

image - See above.

getImage

public ImageData getImage()

Returns the image for the ROI.

Returns:

See above.

addShapeData

public void addShapeData(ShapeData shape)

Adds ShapeData object to ROIData.

Parameters:

shape - See above.

removeShapeData

public void removeShapeData(ShapeData shape)

Removes the ShapeData object from ROIData.

Parameters:

shape - See above.

getPlaneCount

public int getPlaneCount()

Returns the number of planes occupied by the ROI.

Returns:

See above.

getShapeCount

public int getShapeCount()

Returns the number of shapes in the ROI.

Returns:

See above.

getShapes

public List<ShapeData> getShapes(int z,
                                 int t)

Returns the list of shapes on a given plane.

Parameters:

z - The z-section.

t - The timepoint.

Returns:

See above.

getIterator

public Iterator<List<ShapeData>> getIterator()

Returns the iterator of the collection of the map.

Returns:

See above.

firstPlane

public ROICoordinate firstPlane()

Return the first plane that the ROI starts on.

Returns:

See above.

lastPlane

public ROICoordinate lastPlane()

Returns the last plane that the ROI ends on.

Returns:

See above.

getShapesInRange

public Iterator<List<ShapeData>> getShapesInRange(ROICoordinate start,
                                                  ROICoordinate end)

Returns an iterator of the Shapes in the ROI in the range [start, end].

Parameters:

start - The starting plane where the Shapes should reside.

end - The final plane where the Shapes should reside.

Returns:

See above.

isClientSide

public boolean isClientSide()

Returns true if the object a client-side object, false otherwise.

Returns:

See above.

setClientSide

public void setClientSide(boolean clientSide)

Sets the flag indicating if the object is a client-side object or not.

Parameters:

clientSide - Passed true if it is a client-side object, false otherwise.

getFolders

public Collection<FolderData> getFolders()

Get the folders this ROI is part of

Returns:

See above.

getUuid

public String getUuid()

Get the UUID

Returns:

See above

setUuid

public void setUuid(String uuid)

Set the UUID

Parameters:

uuid - The UUID