ome.xml.model

Class TransmittanceRange

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.TransmittanceRange

All Implemented Interfaces:

OMEModelObject

public class TransmittanceRange
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field and Description
private Length	cutIn
private Length	cutInTolerance
private Length	cutOut
private Length	cutOutTolerance
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE
private PercentFraction	transmittance

Constructor Summary

Constructors

Constructor and Description
TransmittanceRange() Default constructor.
TransmittanceRange(Element element, OMEModel model) Constructs TransmittanceRange recursively from an XML DOM tree.
TransmittanceRange(TransmittanceRange 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 TransmittanceRange_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
Length	getCutIn()
Length	getCutInTolerance()
static String	getCutInToleranceUnitXsdDefault()
static String	getCutInUnitXsdDefault()
Length	getCutOut()
Length	getCutOutTolerance()
static String	getCutOutToleranceUnitXsdDefault()
static String	getCutOutUnitXsdDefault()
PercentFraction	getTransmittance()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	setCutIn(Length cutIn)
void	setCutInTolerance(Length cutInTolerance)
void	setCutOut(Length cutOut)
void	setCutOutTolerance(Length cutOutTolerance)
void	setTransmittance(PercentFraction transmittance)
void	update(Element element, OMEModel model) Updates TransmittanceRange 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.

transmittance

private PercentFraction transmittance

cutInTolerance

private Length cutInTolerance

cutOutTolerance

private Length cutOutTolerance

cutIn

private Length cutIn

cutOut

private Length cutOut

Constructor Detail

TransmittanceRange

public TransmittanceRange()

Default constructor.

TransmittanceRange

public TransmittanceRange(Element element,
                  OMEModel model)
                   throws EnumerationException

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

TransmittanceRange

public TransmittanceRange(TransmittanceRange orig)

Copy constructor.

Method Detail

update

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

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

getTransmittance

public PercentFraction getTransmittance()

setTransmittance

public void setTransmittance(PercentFraction transmittance)

getCutInTolerance

public Length getCutInTolerance()

setCutInTolerance

public void setCutInTolerance(Length cutInTolerance)

getCutOutTolerance

public Length getCutOutTolerance()

setCutOutTolerance

public void setCutOutTolerance(Length cutOutTolerance)

getCutOutToleranceUnitXsdDefault

public static String getCutOutToleranceUnitXsdDefault()

getCutInToleranceUnitXsdDefault

public static String getCutInToleranceUnitXsdDefault()

getCutIn

public Length getCutIn()

setCutIn

public void setCutIn(Length cutIn)

getCutOutUnitXsdDefault

public static String getCutOutUnitXsdDefault()

getCutInUnitXsdDefault

public static String getCutInUnitXsdDefault()

getCutOut

public Length getCutOut()

setCutOut

public void setCutOut(Length cutOut)

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

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

Returns:

element populated with properties from this class.