Objective (OME XML library 6.3.4 API)

java.lang.Object
- ome.xml.model.AbstractOMEModelObject
- - ome.xml.model.ManufacturerSpec
  - - ome.xml.model.Objective

All Implemented Interfaces:: OMEModelObject

public class Objective
extends ManufacturerSpec

Field Summary

Fields
Modifier and Type Field and Description

static String NAMESPACE

Fields
Modifier and Type	Field and Description
`static String`	`NAMESPACE`

Constructor Summary

Constructors
Constructor and Description
`Objective()` Default constructor.
`Objective(Element element, OMEModel model)` Constructs Objective recursively from an XML DOM tree.
`Objective(Objective orig)` Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Element`	`asXMLElement(Document document)` Takes the entire object hierarchy and produces an XML DOM tree.
`Element`	`asXMLElement(Document document, Element Objective_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`List<Annotation>`	`copyLinkedAnnotationList()`
`Double`	`getCalibratedMagnification()`
`Correction`	`getCorrection()`
`String`	`getID()`
`Immersion`	`getImmersion()`
`Instrument`	`getInstrument()`
`Boolean`	`getIris()`
`Double`	`getLensNA()`
`Annotation`	`getLinkedAnnotation(int index)`
`Double`	`getNominalMagnification()`
`Length`	`getWorkingDistance()`
`static String`	`getWorkingDistanceUnitXsdDefault()`
`boolean`	`link(Reference reference, OMEModelObject o)` Link a given OME model object to this model object.
`boolean`	`linkAnnotation(Annotation o)`
`void`	`setCalibratedMagnification(Double calibratedMagnification)`
`void`	`setCorrection(Correction correction)`
`void`	`setID(String id)`
`void`	`setImmersion(Immersion immersion)`
`void`	`setInstrument(Instrument instrument_BackReference)`
`void`	`setIris(Boolean iris)`
`void`	`setLensNA(Double lensNA)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`void`	`setNominalMagnification(Double nominalMagnification)`
`void`	`setWorkingDistance(Length workingDistance)`
`int`	`sizeOfLinkedAnnotationList()`
`boolean`	`unlinkAnnotation(Annotation o)`
`void`	`update(Element element, OMEModel model)` Updates Objective recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.ManufacturerSpec
getLotNumber, getManufacturer, getModel, getSerialNumber, setLotNumber, setManufacturer, setModel, setSerialNumber

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 Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Objective
```
public Objective()
```
    Default constructor.
  - Objective
```
public Objective(Element element,
                 OMEModel model)
          throws EnumerationException
```
    Constructs Objective 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.
  - Objective
```
public Objective(Objective orig)
```
    Copy constructor.
- Method Detail
  - update
```
public void update(Element element,
                   OMEModel model)
            throws EnumerationException
```
    Updates Objective 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 ManufacturerSpec
    
    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 ManufacturerSpec
    
    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 String getID()
```
  - setID
```
public void setID(String id)
```
  - getCorrection
```
public Correction getCorrection()
```
  - setCorrection
```
public void setCorrection(Correction correction)
```
  - getImmersion
```
public Immersion getImmersion()
```
  - setImmersion
```
public void setImmersion(Immersion immersion)
```
  - getLensNA
```
public Double getLensNA()
```
  - setLensNA
```
public void setLensNA(Double lensNA)
```
  - getNominalMagnification
```
public Double getNominalMagnification()
```
  - setNominalMagnification
```
public void setNominalMagnification(Double nominalMagnification)
```
  - getCalibratedMagnification
```
public Double getCalibratedMagnification()
```
  - setCalibratedMagnification
```
public void setCalibratedMagnification(Double calibratedMagnification)
```
  - getWorkingDistance
```
public Length getWorkingDistance()
```
  - setWorkingDistance
```
public void setWorkingDistance(Length workingDistance)
```
  - getWorkingDistanceUnitXsdDefault
```
public static String getWorkingDistanceUnitXsdDefault()
```
  - getIris
```
public Boolean getIris()
```
  - setIris
```
public void setIris(Boolean iris)
```
  - 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)
```
  - getInstrument
```
public Instrument getInstrument()
```
  - setInstrument
```
public void setInstrument(Instrument instrument_BackReference)
```
  - 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 interface OMEModelObject
    
    Overrides:
    
    asXMLElement in class ManufacturerSpec
    
    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 Objective_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 ManufacturerSpec
    
    Parameters:
    
    document - Destination document for element creation, etc.
    
    Objective_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 Objective

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.ManufacturerSpec

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

Constructor Detail

Objective

Objective

Objective

Method Detail

update

link

getID

setID

getCorrection

setCorrection

getImmersion

setImmersion

getLensNA

setLensNA

getNominalMagnification

setNominalMagnification

getCalibratedMagnification

setCalibratedMagnification

getWorkingDistance

setWorkingDistance

getWorkingDistanceUnitXsdDefault

getIris

setIris

sizeOfLinkedAnnotationList

copyLinkedAnnotationList

getLinkedAnnotation

setLinkedAnnotation

linkAnnotation

unlinkAnnotation

getInstrument

setInstrument

asXMLElement

asXMLElement