Plane (Bio-Formats API)

java.lang.Object
- ome.xml.model.AbstractOMEModelObject
- - ome.xml.model.Plane

All Implemented Interfaces:: OMEModelObject

public class Plane
extends AbstractOMEModelObject

Field Summary

Fields
Modifier and Type Field and Description

static String NAMESPACE

Fields
Modifier and Type	Field and Description
`static String`	`NAMESPACE`

Constructor Summary

Constructors
Constructor and Description
`Plane()` Default constructor.
`Plane(Element element, OMEModel model)` Constructs Plane recursively from an XML DOM tree.
`Plane(Plane orig)` Copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Element`	`asXMLElement(Document document)` Takes the entire object hierarchy and produces an XML DOM tree.
`protected Element`	`asXMLElement(Document document, Element Plane_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`List<Annotation>`	`copyLinkedAnnotationList()`
`Double`	`getDeltaT()`
`Double`	`getExposureTime()`
`String`	`getHashSHA1()`
`Annotation`	`getLinkedAnnotation(int index)`
`Pixels`	`getPixels()`
`Double`	`getPositionX()`
`Double`	`getPositionY()`
`Double`	`getPositionZ()`
`NonNegativeInteger`	`getTheC()`
`NonNegativeInteger`	`getTheT()`
`NonNegativeInteger`	`getTheZ()`
`boolean`	`link(Reference reference, OMEModelObject o)` Link a given OME model object to this model object.
`boolean`	`linkAnnotation(Annotation o)`
`void`	`setDeltaT(Double deltaT)`
`void`	`setExposureTime(Double exposureTime)`
`void`	`setHashSHA1(String hashSHA1)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`void`	`setPixels(Pixels pixels_BackReference)`
`void`	`setPositionX(Double positionX)`
`void`	`setPositionY(Double positionY)`
`void`	`setPositionZ(Double positionZ)`
`void`	`setTheC(NonNegativeInteger theC)`
`void`	`setTheT(NonNegativeInteger theT)`
`void`	`setTheZ(NonNegativeInteger theZ)`
`int`	`sizeOfLinkedAnnotationList()`
`boolean`	`unlinkAnnotation(Annotation o)`
`void`	`update(Element element, OMEModel model)` Updates Plane 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 Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - 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 Detail
  - 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.
  - getExposureTime
```
public Double getExposureTime()
```
  - setExposureTime
```
public void setExposureTime(Double exposureTime)
```
  - getPositionZ
```
public Double getPositionZ()
```
  - setPositionZ
```
public void setPositionZ(Double positionZ)
```
  - getPositionX
```
public Double getPositionX()
```
  - setPositionX
```
public void setPositionX(Double positionX)
```
  - getPositionY
```
public Double getPositionY()
```
  - setPositionY
```
public void setPositionY(Double positionY)
```
  - getDeltaT
```
public Double getDeltaT()
```
  - setDeltaT
```
public void setDeltaT(Double deltaT)
```
  - getTheC
```
public NonNegativeInteger getTheC()
```
  - setTheC
```
public void setTheC(NonNegativeInteger theC)
```
  - getTheZ
```
public NonNegativeInteger getTheZ()
```
  - setTheZ
```
public void setTheZ(NonNegativeInteger theZ)
```
  - getTheT
```
public NonNegativeInteger getTheT()
```
  - setTheT
```
public void setTheT(NonNegativeInteger theT)
```
  - 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
```
protected 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.

Class Plane

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

Constructor Detail

Plane

Plane

Plane

Method Detail

update

link

getExposureTime

setExposureTime

getPositionZ

setPositionZ

getPositionX

setPositionX

getPositionY

setPositionY

getDeltaT

setDeltaT

getTheC

setTheC

getTheZ

setTheZ

getTheT

setTheT

getHashSHA1

setHashSHA1

sizeOfLinkedAnnotationList

copyLinkedAnnotationList

getLinkedAnnotation

setLinkedAnnotation

linkAnnotation

unlinkAnnotation

getPixels

setPixels

asXMLElement

asXMLElement