ome.xml.model

Class StageLabel

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.StageLabel

All Implemented Interfaces:

OMEModelObject

public class StageLabel
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOGGER Logger for this class.
private String	name
static String	NAMESPACE
private Length	x
private Length	y
private Length	z

Constructor Summary

Constructors

Constructor and Description
StageLabel() Default constructor.
StageLabel(Element element, OMEModel model) Constructs StageLabel recursively from an XML DOM tree.
StageLabel(StageLabel 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 StageLabel_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
String	getName()
Length	getX()
static String	getXUnitXsdDefault()
Length	getY()
static String	getYUnitXsdDefault()
Length	getZ()
static String	getZUnitXsdDefault()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	setName(String name)
void	setX(Length x)
void	setY(Length y)
void	setZ(Length z)
void	update(Element element, OMEModel model) Updates StageLabel 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.

name

private String name

y

private Length y

x

private Length x

z

private Length z

Constructor Detail

StageLabel

public StageLabel()

Default constructor.

StageLabel

public StageLabel(Element element,
          OMEModel model)
           throws EnumerationException

Constructs StageLabel 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.

StageLabel

public StageLabel(StageLabel orig)

Copy constructor.

Method Detail

update

public void update(Element element,
          OMEModel model)
            throws EnumerationException

Updates StageLabel 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.

getName

public String getName()

setName

public void setName(String name)

getZUnitXsdDefault

public static String getZUnitXsdDefault()

getYUnitXsdDefault

public static String getYUnitXsdDefault()

getXUnitXsdDefault

public static String getXUnitXsdDefault()

getY

public Length getY()

setY

public void setY(Length y)

getX

public Length getX()

setX

public void setX(Length x)

getZ

public Length getZ()

setZ

public void setZ(Length z)

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 StageLabel_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.

StageLabel_element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.