pojos
Class ShapeData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.ShapeData
Direct Known Subclasses:
EllipseData, LineData, MaskData, PointData, PolygonData, PolylineData, RectangleData, TextData

public abstract class ShapeData
extends DataObject

Hosts a shape.

Since:
3.0-Beta4
Version:
3.0 (Internal version: $Revision: $Date: $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk, Donald MacDonald      donald@lifesci.dundee.ac.uk

Field Summary
static boolean READONLY_FLAG
          Flag stating that the ROI is read only.
protected  ShapeSettingsData settings
          The representation of the shape.
 
Constructor Summary
protected ShapeData(omero.model.Shape shape)
          Creates a new instance.
protected ShapeData(omero.model.Shape shape, boolean clientObject)
          Creates a new instance.
 
Method Summary
 int getC()
          Returns the channel.
 ROICoordinate getROICoordinate()
          Get the ROICoordinate for the ShapeData
 ShapeSettingsData getShapeSettings()
          Returns the settings associated to the shape.
 int getT()
          Returns the timepoint.
 String getTransform()
          Returns the transformation.
 int getZ()
          Returns the z-section.
 boolean isClientObject()
          Is the object one that has been created client side.
 boolean isReadOnly()
          Is the object a read-only object.
 void setC(int theC)
          Set the channel
 void setClientObject(boolean clientSideObject)
          Set the object to be a client side object.
 void setDirty(boolean dirty)
          Has the figure been changed from the server side version.
 void setReadOnly(boolean readOnly)
          Set the Shape object to be readOnly
 void setROICoordinate(ROICoordinate coord)
          Set the ROICoordinate for the ShapeData
protected  void setShapeSettings(omero.model.Shape shape)
          Set the settings associated to the shape.
 void setT(int theT)
          Set the timepoint.
 void setTransform(String transform)
          Set the Affine transform of the shape.
 void setZ(int theZ)
          Set the z-section.
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setId, setValue, setVersion, timeOfEvent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

READONLY_FLAG

public static boolean READONLY_FLAG
Flag stating that the ROI is read only.


settings

protected ShapeSettingsData settings
The representation of the shape.

Constructor Detail

ShapeData

protected ShapeData(omero.model.Shape shape,
                    boolean clientObject)
Creates a new instance.

Parameters:
shape - The shape to host.
clientObject - Pass true if it is a client object, false otherwise.

ShapeData

protected ShapeData(omero.model.Shape shape)
Creates a new instance.

Parameters:
shape - The shape to host.
Method Detail

getShapeSettings

public ShapeSettingsData getShapeSettings()
Returns the settings associated to the shape.

Returns:
See above.

setShapeSettings

protected void setShapeSettings(omero.model.Shape shape)
Set the settings associated to the shape.

Parameters:
shape - See above.

isReadOnly

public boolean isReadOnly()
Is the object a read-only object.

Returns:
See above.

setReadOnly

public void setReadOnly(boolean readOnly)
Set the Shape object to be readOnly

Parameters:
readOnly - See above.

isClientObject

public boolean isClientObject()
Is the object one that has been created client side. If so the id will be null, or invalid.

Returns:
See above.

setClientObject

public void setClientObject(boolean clientSideObject)
Set the object to be a client side object. If so the id will be null or invalid.

Parameters:
clientSideObject - See above.

getZ

public int getZ()
Returns the z-section.

Returns:
See above.

setZ

public void setZ(int theZ)
Set the z-section.

Parameters:
See - above.

getC

public int getC()
Returns the channel.

Returns:
See above.

setC

public void setC(int theC)
Set the channel

Parameters:
See - above.

getT

public int getT()
Returns the timepoint.

Returns:
See above.

setT

public void setT(int theT)
Set the timepoint.

Parameters:
See - above.

setROICoordinate

public void setROICoordinate(ROICoordinate coord)
Set the ROICoordinate for the ShapeData

Parameters:
roiCoordinate - See above.

getROICoordinate

public ROICoordinate getROICoordinate()
Get the ROICoordinate for the ShapeData

Returns:
See above.

getTransform

public String getTransform()
Returns the transformation.

Returns:
See above.

setTransform

public void setTransform(String transform)
Set the Affine transform of the shape.

Parameters:
See - above.

setDirty

public void setDirty(boolean dirty)
Has the figure been changed from the server side version.

Overrides:
setDirty in class DataObject
Parameters:
dirty - See above.


OmeroJava Api

Version: Beta-4.2.0-r7571-b29

Copyright © 2009 The University of Dundee. All Rights Reserved.