Package ome.xml.model
Class Shape
- java.lang.Object
-
- ome.xml.model.AbstractOMEModelObject
-
- ome.xml.model.Shape
-
- All Implemented Interfaces:
OMEModelObject
public abstract class Shape extends AbstractOMEModelObject
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringNAMESPACE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description org.w3c.dom.ElementasXMLElement(org.w3c.dom.Document document)Takes the entire object hierarchy and produces an XML DOM tree.org.w3c.dom.ElementasXMLElement(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()ColorgetFillColor()FillRulegetFillRule()FontFamilygetFontFamily()LengthgetFontSize()static java.lang.StringgetFontSizeUnitXsdDefault()FontStylegetFontStyle()java.lang.StringgetID()AnnotationgetLinkedAnnotation(int index)java.lang.BooleangetLocked()ColorgetStrokeColor()java.lang.StringgetStrokeDashArray()LengthgetStrokeWidth()static java.lang.StringgetStrokeWidthUnitXsdDefault()java.lang.StringgetText()NonNegativeIntegergetTheC()NonNegativeIntegergetTheT()NonNegativeIntegergetTheZ()AffineTransformgetTransform()UniongetUnion()booleanlink(Reference reference, OMEModelObject o)Link a given OME model object to this model object.booleanlinkAnnotation(Annotation o)voidsetFillColor(Color fillColor)voidsetFillRule(FillRule fillRule)voidsetFontFamily(FontFamily fontFamily)voidsetFontSize(Length fontSize)voidsetFontStyle(FontStyle fontStyle)voidsetID(java.lang.String id)AnnotationsetLinkedAnnotation(int index, Annotation o)voidsetLocked(java.lang.Boolean locked)voidsetStrokeColor(Color strokeColor)voidsetStrokeDashArray(java.lang.String strokeDashArray)voidsetStrokeWidth(Length strokeWidth)voidsetText(java.lang.String text)voidsetTheC(NonNegativeInteger theC)voidsetTheT(NonNegativeInteger theT)voidsetTheZ(NonNegativeInteger theZ)voidsetTransform(AffineTransform transform)voidsetUnion(Union union_BackReference)intsizeOfLinkedAnnotationList()booleanunlinkAnnotation(Annotation o)voidupdate(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
-
-
-
-
Field Detail
-
NAMESPACE
public static final java.lang.String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Shape
public Shape()
Default constructor.
-
Shape
public Shape(org.w3c.dom.Element element, OMEModel model) throws EnumerationExceptionConstructs 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 Detail
-
update
public void update(org.w3c.dom.Element element, OMEModel model) throws EnumerationExceptionUpdates Shape recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein classAbstractOMEModelObject- 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:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Overrides:
linkin classAbstractOMEModelObject- Parameters:
reference- The type qualifier for the reference. This should be the corresponding reference type foro. If, for example,ois of typeImage,referenceMUST be of typeImageRef.o- Model object to link to.- Returns:
trueif this model object was able to handle the reference,falseotherwise.
-
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:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Specified by:
asXMLElementin classAbstractOMEModelObject- 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:AbstractOMEModelObjectTakes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.Shape_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-
-