Package ome.xml.model

Class Shape

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.Shape

All Implemented Interfaces:

OMEModelObject

Direct Known Subclasses:

Ellipse, Label, Line, Mask, Point, Polygon, Polyline, Rectangle

public abstract class Shape
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
Shape()	Default constructor.
Shape(Shape orig)	Copy constructor.
Shape(org.w3c.dom.Element element, OMEModel model)	Constructs Shape recursively from an XML DOM tree.

Method Summary

Modifier and Type	Method	Description
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document)	Takes the entire object hierarchy and produces an XML DOM tree.
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Shape_element)	Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
java.util.List<Annotation>	copyLinkedAnnotationList()
Color	getFillColor()
FillRule	getFillRule()
FontFamily	getFontFamily()
Length	getFontSize()
static java.lang.String	getFontSizeUnitXsdDefault()
FontStyle	getFontStyle()
java.lang.String	getID()
Annotation	getLinkedAnnotation(int index)
java.lang.Boolean	getLocked()
Color	getStrokeColor()
java.lang.String	getStrokeDashArray()
Length	getStrokeWidth()
static java.lang.String	getStrokeWidthUnitXsdDefault()
java.lang.String	getText()
NonNegativeInteger	getTheC()
NonNegativeInteger	getTheT()
NonNegativeInteger	getTheZ()
AffineTransform	getTransform()
Union	getUnion()
boolean	link(Reference reference, OMEModelObject o)	Link a given OME model object to this model object.
boolean	linkAnnotation(Annotation o)
void	setFillColor(Color fillColor)
void	setFillRule(FillRule fillRule)
void	setFontFamily(FontFamily fontFamily)
void	setFontSize(Length fontSize)
void	setFontStyle(FontStyle fontStyle)
void	setID(java.lang.String id)
Annotation	setLinkedAnnotation(int index, Annotation o)
void	setLocked(java.lang.Boolean locked)
void	setStrokeColor(Color strokeColor)
void	setStrokeDashArray(java.lang.String strokeDashArray)
void	setStrokeWidth(Length strokeWidth)
void	setText(java.lang.String text)
void	setTheC(NonNegativeInteger theC)
void	setTheT(NonNegativeInteger theT)
void	setTheZ(NonNegativeInteger theZ)
void	setTransform(AffineTransform transform)
void	setUnion(Union union_BackReference)
int	sizeOfLinkedAnnotationList()
boolean	unlinkAnnotation(Annotation o)
void	update(org.w3c.dom.Element element, OMEModel model)	Updates Shape recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject

getChildrenByTagName, stripNamespacePrefix

Methods inherited from class java.lang.Object

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

Field Details

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Details

Shape

public Shape()

Default constructor.

Shape

public Shape(org.w3c.dom.Element element, OMEModel model) throws EnumerationException

Constructs Shape recursively from an XML DOM tree.

Parameters:

element - Root of the XML DOM tree to construct a model object graph from.

model - Handler for the OME model which keeps track of instances and references seen during object population.

Throws:

EnumerationException - If there is an error instantiating an enumeration during model object creation.

Shape

public Shape(Shape orig)

Copy constructor.

Method Details

update

public void update(org.w3c.dom.Element element, OMEModel model) throws EnumerationException

Updates Shape recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.

Specified by:

update in interface OMEModelObject

Overrides:

update in class AbstractOMEModelObject

Parameters:

element - Root of the XML DOM tree to construct a model object graph from.

model - Handler for the OME model which keeps track of instances and references seen during object population.

Throws:

EnumerationException - If there is an error instantiating an enumeration during model object creation.

link

public boolean link(Reference reference, OMEModelObject o)

Description copied from interface: OMEModelObject

Link a given OME model object to this model object.

Specified by:

link in interface OMEModelObject

Overrides:

link in class AbstractOMEModelObject

Parameters:

reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.

o - Model object to link to.

Returns:

true if this model object was able to handle the reference, false otherwise.

getFillColor

public Color getFillColor()

setFillColor

public void setFillColor(Color fillColor)

getFillRule

public FillRule getFillRule()

setFillRule

public void setFillRule(FillRule fillRule)

getStrokeColor

public Color getStrokeColor()

setStrokeColor

public void setStrokeColor(Color strokeColor)

getStrokeWidth

public Length getStrokeWidth()

setStrokeWidth

public void setStrokeWidth(Length strokeWidth)

getStrokeWidthUnitXsdDefault

public static java.lang.String getStrokeWidthUnitXsdDefault()

getStrokeDashArray

public java.lang.String getStrokeDashArray()

setStrokeDashArray

public void setStrokeDashArray(java.lang.String strokeDashArray)

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

getFontFamily

public FontFamily getFontFamily()

setFontFamily

public void setFontFamily(FontFamily fontFamily)

getFontSize

public Length getFontSize()

setFontSize

public void setFontSize(Length fontSize)

getFontSizeUnitXsdDefault

public static java.lang.String getFontSizeUnitXsdDefault()

getFontStyle

public FontStyle getFontStyle()

setFontStyle

public void setFontStyle(FontStyle fontStyle)

getLocked

public java.lang.Boolean getLocked()

setLocked

public void setLocked(java.lang.Boolean locked)

getID

public java.lang.String getID()

setID

public void setID(java.lang.String id)

getTheZ

public NonNegativeInteger getTheZ()

setTheZ

public void setTheZ(NonNegativeInteger theZ)

getTheT

public NonNegativeInteger getTheT()

setTheT

public void setTheT(NonNegativeInteger theT)

getTheC

public NonNegativeInteger getTheC()

setTheC

public void setTheC(NonNegativeInteger theC)

getTransform

public AffineTransform getTransform()

setTransform

public void setTransform(AffineTransform transform)

sizeOfLinkedAnnotationList

public int sizeOfLinkedAnnotationList()

copyLinkedAnnotationList

public java.util.List<Annotation> copyLinkedAnnotationList()

getLinkedAnnotation

public Annotation getLinkedAnnotation(int index)

setLinkedAnnotation

public Annotation setLinkedAnnotation(int index, Annotation o)

linkAnnotation

public boolean linkAnnotation(Annotation o)

unlinkAnnotation

public boolean unlinkAnnotation(Annotation o)

getUnion

public Union getUnion()

setUnion

public void setUnion(Union union_BackReference)

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document)

Description copied from interface: OMEModelObject

Takes the entire object hierarchy and produces an XML DOM tree.

Specified by:

asXMLElement in interface OMEModelObject

Specified by:

asXMLElement in class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

Returns:

XML DOM tree root element for this model object.

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Shape_element)

Description copied from class: AbstractOMEModelObject

Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.

Overrides:

asXMLElement in class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

Shape_element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.