Package ome.xml.model
Class Instrument
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Instrument
- All Implemented Interfaces:
OMEModelObject
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Instrument(Instrument orig) Copy constructor.Instrument(Element element, OMEModel model) Constructs Instrument recursively from an XML DOM tree. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDetector(Detector detector) voidaddDichroic(Dichroic dichroic) voidvoidaddFilterSet(FilterSet filterSet) voidaddLightSource(LightSource lightSource) voidaddObjective(Objective objective) asXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element Instrument_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.voidvoidvoidvoidvoidvoidgetDetector(int index) getDichroic(int index) getFilter(int index) getFilterSet(int index) getID()getLightSource(int index) getLinkedAnnotation(int index) getLinkedImage(int index) getObjective(int index) booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.booleanbooleanvoidremoveDetector(Detector detector) voidremoveDichroic(Dichroic dichroic) voidremoveFilter(Filter filter) voidremoveFilterSet(FilterSet filterSet) voidremoveLightSource(LightSource lightSource) voidremoveObjective(Objective objective) setDetector(int index, Detector detector) setDichroic(int index, Dichroic dichroic) setFilterSet(int index, FilterSet filterSet) voidsetLightSource(int index, LightSource lightSource) setLinkedAnnotation(int index, Annotation o) setLinkedImage(int index, Image o) voidsetMicroscope(Microscope microscope) setObjective(int index, Objective objective) intintintintintintintintbooleanbooleanunlinkImage(Image o) voidUpdates Instrument recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
Instrument
public Instrument()Default constructor. -
Instrument
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
Copy constructor.
-
-
Method Details
-
update
Updates Instrument recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein 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
Description copied from interface:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Overrides:
linkin classAbstractOMEModelObject- Parameters:
reference- The type qualifier for the reference. This should be the corresponding reference type foro. If, for example,ois of typeImage,referenceMUST be of typeImageRef.o- Model object to link to.- Returns:
trueif this model object was able to handle the reference,falseotherwise.
-
getID
-
setID
-
getMicroscope
-
setMicroscope
-
sizeOfLightSourceList
public int sizeOfLightSourceList() -
copyLightSourceList
-
clearLightSourceList
public void clearLightSourceList() -
getLightSource
-
setLightSource
-
addLightSource
-
removeLightSource
-
sizeOfDetectorList
public int sizeOfDetectorList() -
copyDetectorList
-
clearDetectorList
public void clearDetectorList() -
getDetector
-
setDetector
-
addDetector
-
removeDetector
-
sizeOfObjectiveList
public int sizeOfObjectiveList() -
copyObjectiveList
-
clearObjectiveList
public void clearObjectiveList() -
getObjective
-
setObjective
-
addObjective
-
removeObjective
-
sizeOfFilterSetList
public int sizeOfFilterSetList() -
copyFilterSetList
-
clearFilterSetList
public void clearFilterSetList() -
getFilterSet
-
setFilterSet
-
addFilterSet
-
removeFilterSet
-
sizeOfFilterList
public int sizeOfFilterList() -
copyFilterList
-
clearFilterList
public void clearFilterList() -
getFilter
-
setFilter
-
addFilter
-
removeFilter
-
sizeOfDichroicList
public int sizeOfDichroicList() -
copyDichroicList
-
clearDichroicList
public void clearDichroicList() -
getDichroic
-
setDichroic
-
addDichroic
-
removeDichroic
-
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList() -
copyLinkedAnnotationList
-
getLinkedAnnotation
-
setLinkedAnnotation
-
linkAnnotation
-
unlinkAnnotation
-
sizeOfLinkedImageList
public int sizeOfLinkedImageList() -
copyLinkedImageList
-
getLinkedImage
-
setLinkedImage
-
linkImage
-
unlinkImage
-
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Specified by:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
Description copied from class:AbstractOMEModelObjectTakes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.Instrument_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-