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
public class ObjectiveSettings extends Settings
-
-
Constructor Summary
Constructors Constructor Description ObjectiveSettings()
Default constructor.ObjectiveSettings(ObjectiveSettings orig)
Copy constructor.ObjectiveSettings(Element element, OMEModel model)
Constructs ObjectiveSettings recursively from an XML DOM tree.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Element
asXMLElement(Document document)
Takes the entire object hierarchy and produces an XML DOM tree.Element
asXMLElement(Document document, Element ObjectiveSettings_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.Double
getCorrectionCollar()
String
getID()
Retrieves the reference's target object ID.Medium
getMedium()
Objective
getObjective()
Double
getRefractiveIndex()
boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.void
setCorrectionCollar(Double correctionCollar)
void
setID(String id)
Sets the reference's target object ID.void
setMedium(Medium medium)
void
setObjective(Objective objective)
void
setRefractiveIndex(Double refractiveIndex)
void
update(Element element, OMEModel model)
Updates ObjectiveSettings recursively from an XML DOM tree.-
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
-
ObjectiveSettings
public ObjectiveSettings()
Default constructor.
-
ObjectiveSettings
public ObjectiveSettings(Element element, OMEModel model) throws EnumerationException
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
public ObjectiveSettings(ObjectiveSettings orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
Updates ObjectiveSettings recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in 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
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 classSettings
- 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()
Description copied from class:Reference
Retrieves the reference's target object ID.
-
setID
public void setID(String id)
Description copied from class:Reference
Sets the reference's target object ID.
-
getCorrectionCollar
public Double getCorrectionCollar()
-
setCorrectionCollar
public void setCorrectionCollar(Double correctionCollar)
-
getMedium
public Medium getMedium()
-
setMedium
public void setMedium(Medium medium)
-
getRefractiveIndex
public Double getRefractiveIndex()
-
setRefractiveIndex
public void setRefractiveIndex(Double refractiveIndex)
-
getObjective
public Objective getObjective()
-
setObjective
public void setObjective(Objective objective)
-
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
- Overrides:
asXMLElement
in classSettings
- 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 ObjectiveSettings_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 classSettings
- Parameters:
document
- Destination document for element creation, etc.ObjectiveSettings_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-