ome.xml.model

Class Dichroic

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.ManufacturerSpec

ome.xml.model.Dichroic

All Implemented Interfaces:

OMEModelObject

public class Dichroic
extends ManufacturerSpec

Field Summary

Fields

Modifier and Type	Field and Description
private List<Annotation>	annotationLinks
private List<FilterSet>	filterSets
private String	id
private Instrument	instrument
private List<LightPath>	lightPaths
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE

Constructor Summary

Constructors

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

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 Dichroic_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
List<Annotation>	copyLinkedAnnotationList()
List<FilterSet>	copyLinkedFilterSetList()
List<LightPath>	copyLinkedLightPathList()
String	getID()
Instrument	getInstrument()
Annotation	getLinkedAnnotation(int index)
FilterSet	getLinkedFilterSet(int index)
LightPath	getLinkedLightPath(int index)
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
boolean	linkAnnotation(Annotation o)
boolean	linkFilterSet(FilterSet o)
boolean	linkLightPath(LightPath o)
void	setID(String id)
void	setInstrument(Instrument instrument_BackReference)
Annotation	setLinkedAnnotation(int index, Annotation o)
FilterSet	setLinkedFilterSet(int index, FilterSet o)
LightPath	setLinkedLightPath(int index, LightPath o)
int	sizeOfLinkedAnnotationList()
int	sizeOfLinkedFilterSetList()
int	sizeOfLinkedLightPathList()
boolean	unlinkAnnotation(Annotation o)
boolean	unlinkFilterSet(FilterSet o)
boolean	unlinkLightPath(LightPath o)
void	update(Element element, OMEModel model) Updates Dichroic recursively from an XML DOM tree.

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.

id

private String id

annotationLinks

private List<Annotation> annotationLinks

instrument

private Instrument instrument

filterSets

private List<FilterSet> filterSets

lightPaths

private List<LightPath> lightPaths

Constructor Detail

Dichroic

public Dichroic()

Default constructor.

Dichroic

public Dichroic(Element element,
        OMEModel model)
         throws EnumerationException

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

Dichroic

public Dichroic(Dichroic orig)

Copy constructor.

Method Detail

update

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

Updates Dichroic 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)

sizeOfLinkedAnnotationList

public int sizeOfLinkedAnnotationList()

copyLinkedAnnotationList

public 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)

getInstrument

public Instrument getInstrument()

setInstrument

public void setInstrument(Instrument instrument_BackReference)

sizeOfLinkedFilterSetList

public int sizeOfLinkedFilterSetList()

copyLinkedFilterSetList

public List<FilterSet> copyLinkedFilterSetList()

getLinkedFilterSet

public FilterSet getLinkedFilterSet(int index)

setLinkedFilterSet

public FilterSet setLinkedFilterSet(int index,
                           FilterSet o)

linkFilterSet

public boolean linkFilterSet(FilterSet o)

unlinkFilterSet

public boolean unlinkFilterSet(FilterSet o)

sizeOfLinkedLightPathList

public int sizeOfLinkedLightPathList()

copyLinkedLightPathList

public List<LightPath> copyLinkedLightPathList()

getLinkedLightPath

public LightPath getLinkedLightPath(int index)

setLinkedLightPath

public LightPath setLinkedLightPath(int index,
                           LightPath o)

linkLightPath

public boolean linkLightPath(LightPath o)

unlinkLightPath

public boolean unlinkLightPath(LightPath 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 ManufacturerSpec

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

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

Returns:

element populated with properties from this class.