ome.xml.model

Class Laser

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.ManufacturerSpec

ome.xml.model.LightSource

ome.xml.model.Laser

All Implemented Interfaces:

OMEModelObject

public class Laser
extends LightSource

Field Summary

Fields

Modifier and Type	Field and Description
private PositiveInteger	frequencyMultiplication
private LaserMedium	laserMedium
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE
private Boolean	pockelCell
private Pulse	pulse
private LightSource	pump
private Frequency	repetitionRate
private Boolean	tuneable
private LaserType	type
private Length	wavelength

Constructor Summary

Constructors

Constructor and Description
Laser() Default constructor.
Laser(Element element, OMEModel model) Constructs Laser recursively from an XML DOM tree.
Laser(Laser 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 Laser_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
PositiveInteger	getFrequencyMultiplication()
LaserMedium	getLaserMedium()
LightSource	getLinkedPump()
Boolean	getPockelCell()
Pulse	getPulse()
Frequency	getRepetitionRate()
static String	getRepetitionRateUnitXsdDefault()
Boolean	getTuneable()
LaserType	getType()
Length	getWavelength()
static String	getWavelengthUnitXsdDefault()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	linkPump(LightSource o)
void	setFrequencyMultiplication(PositiveInteger frequencyMultiplication)
void	setLaserMedium(LaserMedium laserMedium)
void	setPockelCell(Boolean pockelCell)
void	setPulse(Pulse pulse)
void	setRepetitionRate(Frequency repetitionRate)
void	setTuneable(Boolean tuneable)
void	setType(LaserType type)
void	setWavelength(Length wavelength)
void	unlinkPump(LightSource o)
void	update(Element element, OMEModel model) Updates Laser recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.LightSource

copyLinkedAnnotationList, getID, getInstrument, getLinkedAnnotation, getPower, getPowerUnitXsdDefault, linkAnnotation, setID, setInstrument, setLinkedAnnotation, setPower, sizeOfLinkedAnnotationList, unlinkAnnotation

Methods inherited from class ome.xml.model.ManufacturerSpec

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

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.

pockelCell

private Boolean pockelCell

tuneable

private Boolean tuneable

laserMedium

private LaserMedium laserMedium

pulse

private Pulse pulse

wavelength

private Length wavelength

frequencyMultiplication

private PositiveInteger frequencyMultiplication

type

private LaserType type

repetitionRate

private Frequency repetitionRate

pump

private LightSource pump

Constructor Detail

Laser

public Laser()

Default constructor.

Laser

public Laser(Element element,
     OMEModel model)
      throws EnumerationException

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

Laser

public Laser(Laser orig)

Copy constructor.

Method Detail

update

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

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

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 LightSource

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.

getRepetitionRateUnitXsdDefault

public static String getRepetitionRateUnitXsdDefault()

getPockelCell

public Boolean getPockelCell()

setPockelCell

public void setPockelCell(Boolean pockelCell)

getTuneable

public Boolean getTuneable()

setTuneable

public void setTuneable(Boolean tuneable)

getLaserMedium

public LaserMedium getLaserMedium()

setLaserMedium

public void setLaserMedium(LaserMedium laserMedium)

getPulse

public Pulse getPulse()

setPulse

public void setPulse(Pulse pulse)

getWavelength

public Length getWavelength()

setWavelength

public void setWavelength(Length wavelength)

getFrequencyMultiplication

public PositiveInteger getFrequencyMultiplication()

setFrequencyMultiplication

public void setFrequencyMultiplication(PositiveInteger frequencyMultiplication)

getType

public LaserType getType()

setType

public void setType(LaserType type)

getRepetitionRate

public Frequency getRepetitionRate()

setRepetitionRate

public void setRepetitionRate(Frequency repetitionRate)

getWavelengthUnitXsdDefault

public static String getWavelengthUnitXsdDefault()

getLinkedPump

public LightSource getLinkedPump()

linkPump

public void linkPump(LightSource o)

unlinkPump

public void unlinkPump(LightSource o)

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

Overrides:

asXMLElement in class LightSource

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 Laser_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 LightSource

Parameters:

document - Destination document for element creation, etc.

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

Returns:

element populated with properties from this class.