Package ome.xml.model

Class Shape

All Implemented Interfaces:
OMEModelObject
Direct Known Subclasses:
Ellipse, Label, Line, Mask, Point, Polygon, Polyline, Rectangle

public abstract class Shape extends AbstractOMEModelObject
  • Field Details

  • Constructor Details

    • Shape

      public Shape()
      Default constructor.
    • Shape

      public Shape(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(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 String getStrokeWidthUnitXsdDefault()
    • getStrokeDashArray

      public String getStrokeDashArray()
    • setStrokeDashArray

      public void setStrokeDashArray(String strokeDashArray)
    • getText

      public String getText()
    • setText

      public void setText(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 String getFontSizeUnitXsdDefault()
    • getFontStyle

      public FontStyle getFontStyle()
    • setFontStyle

      public void setFontStyle(FontStyle fontStyle)
    • getLocked

      public Boolean getLocked()
    • setLocked

      public void setLocked(Boolean locked)
    • getID

      public String getID()
    • setID

      public void setID(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 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 Element asXMLElement(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 Element asXMLElement(Document document, 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.