Package ome.xml.model

Class Plane

All Implemented Interfaces:
OMEModelObject

public class Plane extends AbstractOMEModelObject
  • Field Details

  • Constructor Details

    • Plane

      public Plane()
      Default constructor.
    • Plane

      public Plane(Element element, OMEModel model) throws EnumerationException
      Constructs Plane 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.
    • Plane

      public Plane(Plane orig)
      Copy constructor.
  • Method Details

    • update

      public void update(Element element, OMEModel model) throws EnumerationException
      Updates Plane 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.
    • 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)
    • getDeltaT

      public Time getDeltaT()
    • setDeltaT

      public void setDeltaT(Time deltaT)
    • getDeltaTUnitXsdDefault

      public static String getDeltaTUnitXsdDefault()
    • getExposureTime

      public Time getExposureTime()
    • setExposureTime

      public void setExposureTime(Time exposureTime)
    • getExposureTimeUnitXsdDefault

      public static String getExposureTimeUnitXsdDefault()
    • getPositionX

      public Length getPositionX()
    • setPositionX

      public void setPositionX(Length positionX)
    • getPositionXUnitXsdDefault

      public static String getPositionXUnitXsdDefault()
    • getPositionY

      public Length getPositionY()
    • setPositionY

      public void setPositionY(Length positionY)
    • getPositionYUnitXsdDefault

      public static String getPositionYUnitXsdDefault()
    • getPositionZ

      public Length getPositionZ()
    • setPositionZ

      public void setPositionZ(Length positionZ)
    • getPositionZUnitXsdDefault

      public static String getPositionZUnitXsdDefault()
    • getHashSHA1

      public String getHashSHA1()
    • setHashSHA1

      public void setHashSHA1(String hashSHA1)
    • 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)
    • getPixels

      public Pixels getPixels()
    • setPixels

      public void setPixels(Pixels pixels_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 Plane_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.
      Plane_element - Element from the subclass. If null a new element will be created of this class.
      Returns:
      element populated with properties from this class.