ome.xml.model

Class Objective

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
private List<Annotation>	annotationLinks
private Double	calibratedMagnification
private Correction	correction
private String	id
private Immersion	immersion
private Instrument	instrument
private Boolean	iris
private Double	lensNA
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE
private Double	nominalMagnification
private Length	workingDistance

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

Methods

Modifier and Type	Method and Description
Element	asXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.
protected 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

LOGGER

private static final org.slf4j.Logger LOGGER

Logger for this class.

iris

private Boolean iris

workingDistance

private Length workingDistance

immersion

private Immersion immersion

correction

private Correction correction

lensNA

private Double lensNA

nominalMagnification

private Double nominalMagnification

calibratedMagnification

private Double calibratedMagnification

id

private String id

annotationLinks

private List<Annotation> annotationLinks

instrument

private Instrument instrument

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.

getIris

public Boolean getIris()

setIris

public void setIris(Boolean iris)

getWorkingDistance

public Length getWorkingDistance()

setWorkingDistance

public void setWorkingDistance(Length workingDistance)

getWorkingDistanceUnitXsdDefault

public static String getWorkingDistanceUnitXsdDefault()

getImmersion

public Immersion getImmersion()

setImmersion

public void setImmersion(Immersion immersion)

getCorrection

public Correction getCorrection()

setCorrection

public void setCorrection(Correction correction)

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)

getID

public String getID()

setID

public void setID(String id)

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

protected 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.