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
`private List<Annotation>`	`annotationLinks`
`private Time`	`deltaT`
`private Time`	`exposureTime`
`private String`	`hashSHA1`
`private static org.slf4j.Logger`	`LOGGER` Logger for this class.
`static String`	`NAMESPACE`
`private Pixels`	`pixels`
`private Length`	`positionX`
`private Length`	`positionY`
`private Length`	`positionZ`
`private NonNegativeInteger`	`theC`
`private NonNegativeInteger`	`theT`
`private NonNegativeInteger`	`theZ`

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()`
`Time`	`getDeltaT()`
`static String`	`getDeltaTUnitXsdDefault()`
`Time`	`getExposureTime()`
`static String`	`getExposureTimeUnitXsdDefault()`
`String`	`getHashSHA1()`
`Annotation`	`getLinkedAnnotation(int index)`
`Pixels`	`getPixels()`
`Length`	`getPositionX()`
`static String`	`getPositionXUnitXsdDefault()`
`Length`	`getPositionY()`
`static String`	`getPositionYUnitXsdDefault()`
`Length`	`getPositionZ()`
`static String`	`getPositionZUnitXsdDefault()`
`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(Time deltaT)`
`void`	`setExposureTime(Time exposureTime)`
`void`	`setHashSHA1(String hashSHA1)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`void`	`setPixels(Pixels pixels_BackReference)`
`void`	`setPositionX(Length positionX)`
`void`	`setPositionY(Length positionY)`
`void`	`setPositionZ(Length 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
  - LOGGER
```
private static final org.slf4j.Logger LOGGER
```
    Logger for this class.
  - exposureTime
```
private Time exposureTime
```
  - positionZ
```
private Length positionZ
```
  - positionX
```
private Length positionX
```
  - positionY
```
private Length positionY
```
  - deltaT
```
private Time deltaT
```
  - theC
```
private NonNegativeInteger theC
```
  - theZ
```
private NonNegativeInteger theZ
```
  - theT
```
private NonNegativeInteger theT
```
  - hashSHA1
```
private String hashSHA1
```
  - annotationLinks
```
private List<Annotation> annotationLinks
```
  - pixels
```
private Pixels pixels
```
- 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 Time getExposureTime()
```
  - setExposureTime
```
public void setExposureTime(Time exposureTime)
```
  - getPositionZ
```
public Length getPositionZ()
```
  - setPositionZ
```
public void setPositionZ(Length positionZ)
```
  - getPositionX
```
public Length getPositionX()
```
  - setPositionX
```
public void setPositionX(Length positionX)
```
  - getPositionY
```
public Length getPositionY()
```
  - setPositionY
```
public void setPositionY(Length positionY)
```
  - getDeltaT
```
public Time getDeltaT()
```
  - setDeltaT
```
public void setDeltaT(Time deltaT)
```
  - getTheC
```
public NonNegativeInteger getTheC()
```
  - setTheC
```
public void setTheC(NonNegativeInteger theC)
```
  - getTheZ
```
public NonNegativeInteger getTheZ()
```
  - setTheZ
```
public void setTheZ(NonNegativeInteger theZ)
```
  - getPositionZUnitXsdDefault
```
public static String getPositionZUnitXsdDefault()
```
  - getPositionXUnitXsdDefault
```
public static String getPositionXUnitXsdDefault()
```
  - getDeltaTUnitXsdDefault
```
public static String getDeltaTUnitXsdDefault()
```
  - getTheT
```
public NonNegativeInteger getTheT()
```
  - setTheT
```
public void setTheT(NonNegativeInteger theT)
```
  - getExposureTimeUnitXsdDefault
```
public static String getExposureTimeUnitXsdDefault()
```
  - getPositionYUnitXsdDefault
```
public static String getPositionYUnitXsdDefault()
```
  - 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

LOGGER

exposureTime

positionZ

positionX

positionY

deltaT

theC

theZ

theT

hashSHA1

annotationLinks

pixels

Constructor Detail

Plane

Plane

Plane

Method Detail

update

link

getExposureTime

setExposureTime

getPositionZ

setPositionZ

getPositionX

setPositionX

getPositionY

setPositionY

getDeltaT

setDeltaT

getTheC

setTheC

getTheZ

setTheZ

getPositionZUnitXsdDefault

getPositionXUnitXsdDefault

getDeltaTUnitXsdDefault

getTheT

setTheT

getExposureTimeUnitXsdDefault

getPositionYUnitXsdDefault

getHashSHA1

setHashSHA1

sizeOfLinkedAnnotationList

copyLinkedAnnotationList

getLinkedAnnotation

setLinkedAnnotation

linkAnnotation

unlinkAnnotation

getPixels

setPixels

asXMLElement

asXMLElement