java.lang.Object

ome.xml.model.Instrument

All Implemented Interfaces:: OMEModelObject

public class Instrument
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type Field Description

static java.lang.String NAMESPACE

Constructor Summary

Constructors
Constructor	Description
`Instrument()`	Default constructor.
`Instrument(Instrument orig)`	Copy constructor.
`Instrument(org.w3c.dom.Element element, OMEModel model)`	Constructs Instrument recursively from an XML DOM tree.

Method Summary

Modifier and Type	Method	Description
`void`	`addDetector(Detector detector)`
`void`	`addDichroic(Dichroic dichroic)`
`void`	`addFilter(Filter filter)`
`void`	`addFilterSet(FilterSet filterSet)`
`void`	`addLightSource(LightSource lightSource)`
`void`	`addObjective(Objective objective)`
`org.w3c.dom.Element`	`asXMLElement(org.w3c.dom.Document document)`	Takes the entire object hierarchy and produces an XML DOM tree.
`org.w3c.dom.Element`	`asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Instrument_element)`	Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`java.util.List<Detector>`	`copyDetectorList()`
`java.util.List<Dichroic>`	`copyDichroicList()`
`java.util.List<Filter>`	`copyFilterList()`
`java.util.List<FilterSet>`	`copyFilterSetList()`
`java.util.List<LightSource>`	`copyLightSourceList()`
`java.util.List<Annotation>`	`copyLinkedAnnotationList()`
`java.util.List<Image>`	`copyLinkedImageList()`
`java.util.List<Objective>`	`copyObjectiveList()`
`Detector`	`getDetector(int index)`
`Dichroic`	`getDichroic(int index)`
`Filter`	`getFilter(int index)`
`FilterSet`	`getFilterSet(int index)`
`java.lang.String`	`getID()`
`LightSource`	`getLightSource(int index)`
`Annotation`	`getLinkedAnnotation(int index)`
`Image`	`getLinkedImage(int index)`
`Microscope`	`getMicroscope()`
`Objective`	`getObjective(int index)`
`boolean`	`link(Reference reference, OMEModelObject o)`	Link a given OME model object to this model object.
`boolean`	`linkAnnotation(Annotation o)`
`boolean`	`linkImage(Image o)`
`void`	`removeDetector(Detector detector)`
`void`	`removeDichroic(Dichroic dichroic)`
`void`	`removeFilter(Filter filter)`
`void`	`removeFilterSet(FilterSet filterSet)`
`void`	`removeLightSource(LightSource lightSource)`
`void`	`removeObjective(Objective objective)`
`Detector`	`setDetector(int index, Detector detector)`
`Dichroic`	`setDichroic(int index, Dichroic dichroic)`
`Filter`	`setFilter(int index, Filter filter)`
`FilterSet`	`setFilterSet(int index, FilterSet filterSet)`
`void`	`setID(java.lang.String id)`
`LightSource`	`setLightSource(int index, LightSource lightSource)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`Image`	`setLinkedImage(int index, Image o)`
`void`	`setMicroscope(Microscope microscope)`
`Objective`	`setObjective(int index, Objective objective)`
`int`	`sizeOfDetectorList()`
`int`	`sizeOfDichroicList()`
`int`	`sizeOfFilterList()`
`int`	`sizeOfFilterSetList()`
`int`	`sizeOfLightSourceList()`
`int`	`sizeOfLinkedAnnotationList()`
`int`	`sizeOfLinkedImageList()`
`int`	`sizeOfObjectiveList()`
`boolean`	`unlinkAnnotation(Annotation o)`
`boolean`	`unlinkImage(Image o)`
`void`	`update(org.w3c.dom.Element element, OMEModel model)`	Updates Instrument 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 Details
- NAMESPACE
  
  public static final java.lang.String NAMESPACE
  
  See Also:
  
  Constant Field Values
Constructor Details
- Instrument
  
  public Instrument()
  
  Default constructor.
- Instrument
  
  public Instrument(org.w3c.dom.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 Details
- update
  
  public void update(org.w3c.dom.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 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.
- getID
  
  public java.lang.String getID()
- setID
  
  public void setID(java.lang.String id)
- getMicroscope
  
  public Microscope getMicroscope()
- setMicroscope
  
  public void setMicroscope(Microscope microscope)
- sizeOfLightSourceList
  
  public int sizeOfLightSourceList()
- copyLightSourceList
  
  public java.util.List<LightSource> copyLightSourceList()
- 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()
- copyDetectorList
  
  public java.util.List<Detector> copyDetectorList()
- getDetector
  
  public Detector getDetector(int index)
- setDetector
  
  public Detector setDetector(int index, Detector detector)
- addDetector
  
  public void addDetector(Detector detector)
- removeDetector
  
  public void removeDetector(Detector detector)
- sizeOfObjectiveList
  
  public int sizeOfObjectiveList()
- copyObjectiveList
  
  public java.util.List<Objective> copyObjectiveList()
- getObjective
  
  public Objective getObjective(int index)
- setObjective
  
  public Objective setObjective(int index, Objective objective)
- addObjective
  
  public void addObjective(Objective objective)
- removeObjective
  
  public void removeObjective(Objective objective)
- sizeOfFilterSetList
  
  public int sizeOfFilterSetList()
- copyFilterSetList
  
  public java.util.List<FilterSet> copyFilterSetList()
- getFilterSet
  
  public FilterSet getFilterSet(int index)
- setFilterSet
  
  public FilterSet setFilterSet(int index, FilterSet filterSet)
- addFilterSet
  
  public void addFilterSet(FilterSet filterSet)
- removeFilterSet
  
  public void removeFilterSet(FilterSet filterSet)
- sizeOfFilterList
  
  public int sizeOfFilterList()
- copyFilterList
  
  public java.util.List<Filter> copyFilterList()
- getFilter
  
  public Filter getFilter(int index)
- setFilter
  
  public Filter setFilter(int index, Filter filter)
- addFilter
  
  public void addFilter(Filter filter)
- removeFilter
  
  public void removeFilter(Filter filter)
- sizeOfDichroicList
  
  public int sizeOfDichroicList()
- copyDichroicList
  
  public java.util.List<Dichroic> copyDichroicList()
- getDichroic
  
  public Dichroic getDichroic(int index)
- setDichroic
  
  public Dichroic setDichroic(int index, Dichroic dichroic)
- addDichroic
  
  public void addDichroic(Dichroic dichroic)
- removeDichroic
  
  public void removeDichroic(Dichroic dichroic)
- sizeOfLinkedAnnotationList
  
  public int sizeOfLinkedAnnotationList()
- copyLinkedAnnotationList
  
  public java.util.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()
- copyLinkedImageList
  
  public java.util.List<Image> copyLinkedImageList()
- getLinkedImage
  
  public Image getLinkedImage(int index)
- setLinkedImage
  
  public Image setLinkedImage(int index, Image o)
- linkImage
  
  public boolean linkImage(Image o)
- unlinkImage
  
  public boolean unlinkImage(Image o)
- asXMLElement
  
  public org.w3c.dom.Element asXMLElement(org.w3c.dom.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
  
  public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.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 class AbstractOMEModelObject
  
  Parameters:
  
  document - Destination document for element creation, etc.
  
  Instrument_element - Element from the subclass. If null a new element will be created of this class.
  
  Returns:
  
  element populated with properties from this class.

Class Instrument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details