Package ome.xml.model
Class ObjectiveSettings
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Reference
ome.xml.model.Settings
ome.xml.model.ObjectiveSettings
- All Implemented Interfaces:
OMEModelObject
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Copy constructor.ObjectiveSettings(Element element, OMEModel model) Constructs ObjectiveSettings recursively from an XML DOM tree. -
Method Summary
Modifier and TypeMethodDescriptionasXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element ObjectiveSettings_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.getID()Retrieves the reference's target object ID.booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.voidsetCorrectionCollar(Double correctionCollar) voidSets the reference's target object ID.voidvoidsetObjective(Objective objective) voidsetRefractiveIndex(Double refractiveIndex) voidUpdates ObjectiveSettings recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
ObjectiveSettings
public ObjectiveSettings()Default constructor. -
ObjectiveSettings
Constructs ObjectiveSettings 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.
-
ObjectiveSettings
Copy constructor.
-
-
Method Details
-
update
Updates ObjectiveSettings recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein classSettings- 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 classSettings- 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
Description copied from class:ReferenceRetrieves the reference's target object ID. -
setID
Description copied from class:ReferenceSets the reference's target object ID. -
getCorrectionCollar
-
setCorrectionCollar
-
getMedium
-
setMedium
-
getRefractiveIndex
-
setRefractiveIndex
-
getObjective
-
setObjective
-
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Overrides:
asXMLElementin classSettings- 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 classSettings- Parameters:
document- Destination document for element creation, etc.ObjectiveSettings_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-