Package ome.xml.model
Class Instrument
- java.lang.Object
-
- ome.xml.model.AbstractOMEModelObject
-
- ome.xml.model.Instrument
-
- All Implemented Interfaces:
OMEModelObject
public class Instrument extends AbstractOMEModelObject
-
-
Constructor Summary
Constructors Constructor Description Instrument()
Default constructor.Instrument(Instrument orig)
Copy constructor.Instrument(Element element, OMEModel model)
Constructs Instrument recursively from an XML DOM tree.
-
Method Summary
-
Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
-
-
-
Field Detail
-
NAMESPACE
public static final String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Instrument
public Instrument()
Default constructor.
-
Instrument
public Instrument(Element element, OMEModel model) throws EnumerationException
Constructs Instrument 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.
-
Instrument
public Instrument(Instrument orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
Updates Instrument recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in classAbstractOMEModelObject
- 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 interfaceOMEModelObject
- Overrides:
link
in classAbstractOMEModelObject
- Parameters:
reference
- The type qualifier for the reference. This should be the corresponding reference type foro
. If, for example,o
is of typeImage
,reference
MUST be of typeImageRef
.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)
-
getMicroscope
public Microscope getMicroscope()
-
setMicroscope
public void setMicroscope(Microscope microscope)
-
sizeOfLightSourceList
public int sizeOfLightSourceList()
-
copyLightSourceList
public List<LightSource> copyLightSourceList()
-
clearLightSourceList
public void clearLightSourceList()
-
getLightSource
public LightSource getLightSource(int index)
-
setLightSource
public LightSource setLightSource(int index, LightSource lightSource)
-
addLightSource
public void addLightSource(LightSource lightSource)
-
removeLightSource
public void removeLightSource(LightSource lightSource)
-
sizeOfDetectorList
public int sizeOfDetectorList()
-
clearDetectorList
public void clearDetectorList()
-
getDetector
public Detector getDetector(int index)
-
addDetector
public void addDetector(Detector detector)
-
removeDetector
public void removeDetector(Detector detector)
-
sizeOfObjectiveList
public int sizeOfObjectiveList()
-
clearObjectiveList
public void clearObjectiveList()
-
getObjective
public Objective getObjective(int index)
-
addObjective
public void addObjective(Objective objective)
-
removeObjective
public void removeObjective(Objective objective)
-
sizeOfFilterSetList
public int sizeOfFilterSetList()
-
clearFilterSetList
public void clearFilterSetList()
-
getFilterSet
public FilterSet getFilterSet(int index)
-
addFilterSet
public void addFilterSet(FilterSet filterSet)
-
removeFilterSet
public void removeFilterSet(FilterSet filterSet)
-
sizeOfFilterList
public int sizeOfFilterList()
-
clearFilterList
public void clearFilterList()
-
getFilter
public Filter getFilter(int index)
-
addFilter
public void addFilter(Filter filter)
-
removeFilter
public void removeFilter(Filter filter)
-
sizeOfDichroicList
public int sizeOfDichroicList()
-
clearDichroicList
public void clearDichroicList()
-
getDichroic
public Dichroic getDichroic(int index)
-
addDichroic
public void addDichroic(Dichroic dichroic)
-
removeDichroic
public void removeDichroic(Dichroic dichroic)
-
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)
-
sizeOfLinkedImageList
public int sizeOfLinkedImageList()
-
getLinkedImage
public Image getLinkedImage(int index)
-
linkImage
public boolean linkImage(Image o)
-
unlinkImage
public boolean unlinkImage(Image 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 interfaceOMEModelObject
- Specified by:
asXMLElement
in classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
public Element asXMLElement(Document document, Element Instrument_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 classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.Instrument_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-