Package ome.xml.model

Class Plane

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	Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
Plane()	Default constructor.
Plane(Plane orig)	Copy constructor.
Plane(org.w3c.dom.Element element, OMEModel model)	Constructs Plane recursively from an XML DOM tree.

Method Summary

Modifier and Type	Method	Description
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document)	Takes the entire object hierarchy and produces an XML DOM tree.
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Plane_element)	Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
java.util.List<Annotation>	copyLinkedAnnotationList()
Time	getDeltaT()
static java.lang.String	getDeltaTUnitXsdDefault()
Time	getExposureTime()
static java.lang.String	getExposureTimeUnitXsdDefault()
java.lang.String	getHashSHA1()
Annotation	getLinkedAnnotation(int index)
Pixels	getPixels()
Length	getPositionX()
static java.lang.String	getPositionXUnitXsdDefault()
Length	getPositionY()
static java.lang.String	getPositionYUnitXsdDefault()
Length	getPositionZ()
static java.lang.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(java.lang.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(org.w3c.dom.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 Details

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Details

Plane

public Plane()

Default constructor.

Plane

public Plane(org.w3c.dom.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(org.w3c.dom.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 java.lang.String getDeltaTUnitXsdDefault()

getExposureTime

public Time getExposureTime()

setExposureTime

public void setExposureTime(Time exposureTime)

getExposureTimeUnitXsdDefault

public static java.lang.String getExposureTimeUnitXsdDefault()

getPositionX

public Length getPositionX()

setPositionX

public void setPositionX(Length positionX)

getPositionXUnitXsdDefault

public static java.lang.String getPositionXUnitXsdDefault()

getPositionY

public Length getPositionY()

setPositionY

public void setPositionY(Length positionY)

getPositionYUnitXsdDefault

public static java.lang.String getPositionYUnitXsdDefault()

getPositionZ

public Length getPositionZ()

setPositionZ

public void setPositionZ(Length positionZ)

getPositionZUnitXsdDefault

public static java.lang.String getPositionZUnitXsdDefault()

getHashSHA1

public java.lang.String getHashSHA1()

setHashSHA1

public void setHashSHA1(java.lang.String hashSHA1)

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)

getPixels

public Pixels getPixels()

setPixels

public void setPixels(Pixels pixels_BackReference)

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.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 org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.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.