Package ome.xml.model
Class Detector
- java.lang.Object
-
- ome.xml.model.AbstractOMEModelObject
-
- ome.xml.model.ManufacturerSpec
-
- ome.xml.model.Detector
-
- All Implemented Interfaces:
OMEModelObject
public class Detector extends ManufacturerSpec
-
-
Method Summary
All Methods Static 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 Detector_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.List<Annotation>
copyLinkedAnnotationList()
Double
getAmplificationGain()
Double
getGain()
String
getID()
Instrument
getInstrument()
Annotation
getLinkedAnnotation(int index)
Double
getOffset()
DetectorType
getType()
ElectricPotential
getVoltage()
static String
getVoltageUnitXsdDefault()
Double
getZoom()
boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.boolean
linkAnnotation(Annotation o)
void
setAmplificationGain(Double amplificationGain)
void
setGain(Double gain)
void
setID(String id)
void
setInstrument(Instrument instrument_BackReference)
Annotation
setLinkedAnnotation(int index, Annotation o)
void
setOffset(Double offset)
void
setType(DetectorType type)
void
setVoltage(ElectricPotential voltage)
void
setZoom(Double zoom)
int
sizeOfLinkedAnnotationList()
boolean
unlinkAnnotation(Annotation o)
void
update(Element element, OMEModel model)
Updates Detector 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
-
-
-
-
Field Detail
-
NAMESPACE
public static final String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Detector
public Detector()
Default constructor.
-
Detector
public Detector(Element element, OMEModel model) throws EnumerationException
Constructs Detector 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.
-
Detector
public Detector(Detector orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
Updates Detector recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in classManufacturerSpec
- 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 classManufacturerSpec
- 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.
-
getGain
public Double getGain()
-
setGain
public void setGain(Double gain)
-
getVoltage
public ElectricPotential getVoltage()
-
setVoltage
public void setVoltage(ElectricPotential voltage)
-
getVoltageUnitXsdDefault
public static String getVoltageUnitXsdDefault()
-
getOffset
public Double getOffset()
-
setOffset
public void setOffset(Double offset)
-
getZoom
public Double getZoom()
-
setZoom
public void setZoom(Double zoom)
-
getAmplificationGain
public Double getAmplificationGain()
-
setAmplificationGain
public void setAmplificationGain(Double amplificationGain)
-
getID
public String getID()
-
setID
public void setID(String id)
-
getType
public DetectorType getType()
-
setType
public void setType(DetectorType type)
-
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 interfaceOMEModelObject
- Overrides:
asXMLElement
in classManufacturerSpec
- 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 Detector_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 classManufacturerSpec
- Parameters:
document
- Destination document for element creation, etc.Detector_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-