ome.xml.model

Class LightSource

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.ManufacturerSpec

ome.xml.model.LightSource

All Implemented Interfaces:

OMEModelObject

Direct Known Subclasses:

Arc, Filament, Laser, LightEmittingDiode

public abstract class LightSource
extends ManufacturerSpec

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
LightSource() Default constructor.
LightSource(Element element, OMEModel model) Constructs LightSource recursively from an XML DOM tree.

Method Summary

Methods

Modifier and Type	Method and Description
protected Element	asXMLElement(Document document, Element LightSource_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
String	getID()
Instrument	getInstrument()
Double	getPower()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	setID(String id)
void	setInstrument(Instrument instrument_BackReference)
void	setPower(Double power)
void	update(Element element, OMEModel model) Updates LightSource recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.ManufacturerSpec

asXMLElement, getLotNumber, getManufacturer, getModel, getSerialNumber, setLotNumber, setManufacturer, setModel, setSerialNumber

Methods inherited from class ome.xml.model.AbstractOMEModelObject

getChildrenByTagName, stripNamespacePrefix, update

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

LightSource

public LightSource()

Default constructor.

LightSource

public LightSource(Element element,
           OMEModel model)
            throws EnumerationException

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

Method Detail

update

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

Updates LightSource 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 ManufacturerSpec

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 ManufacturerSpec

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.

getID

public String getID()

setID

public void setID(String id)

getPower

public Double getPower()

setPower

public void setPower(Double power)

getInstrument

public Instrument getInstrument()

setInstrument

public void setInstrument(Instrument instrument_BackReference)

asXMLElement

protected Element asXMLElement(Document document,
                   Element LightSource_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 ManufacturerSpec

Parameters:

document - Destination document for element creation, etc.

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

Returns:

element populated with properties from this class.