Package ome.xml.model
Class MicrobeamManipulation
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.MicrobeamManipulation
- All Implemented Interfaces:
OMEModelObject
public class MicrobeamManipulation extends AbstractOMEModelObject
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
Constructors Constructor Description MicrobeamManipulation()
Default constructor.MicrobeamManipulation(MicrobeamManipulation orig)
Copy constructor.MicrobeamManipulation(org.w3c.dom.Element element, OMEModel model)
Constructs MicrobeamManipulation recursively from an XML DOM tree. -
Method Summary
Modifier and Type Method Description void
addLightSourceSettings(LightSourceSettings lightSourceSettings)
org.w3c.dom.Element
asXMLElement(org.w3c.dom.Document document)
Takes the entire object hierarchy and produces an XML DOM tree.org.w3c.dom.Element
asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element MicrobeamManipulation_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.java.util.List<LightSourceSettings>
copyLightSourceSettingsList()
java.util.List<Image>
copyLinkedImageList()
java.util.List<ROI>
copyLinkedROIList()
java.lang.String
getDescription()
Experiment
getExperiment()
java.lang.String
getID()
LightSourceSettings
getLightSourceSettings(int index)
Experimenter
getLinkedExperimenter()
Image
getLinkedImage(int index)
ROI
getLinkedROI(int index)
MicrobeamManipulationType
getType()
boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.void
linkExperimenter(Experimenter o)
boolean
linkImage(Image o)
boolean
linkROI(ROI o)
void
removeLightSourceSettings(LightSourceSettings lightSourceSettings)
void
setDescription(java.lang.String description)
void
setExperiment(Experiment experiment_BackReference)
void
setID(java.lang.String id)
LightSourceSettings
setLightSourceSettings(int index, LightSourceSettings lightSourceSettings)
Image
setLinkedImage(int index, Image o)
ROI
setLinkedROI(int index, ROI o)
void
setType(MicrobeamManipulationType type)
int
sizeOfLightSourceSettingsList()
int
sizeOfLinkedImageList()
int
sizeOfLinkedROIList()
void
unlinkExperimenter(Experimenter o)
boolean
unlinkImage(Image o)
boolean
unlinkROI(ROI o)
void
update(org.w3c.dom.Element element, OMEModel model)
Updates MicrobeamManipulation recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
public static final java.lang.String NAMESPACE- See Also:
- Constant Field Values
-
-
Constructor Details
-
MicrobeamManipulation
public MicrobeamManipulation()Default constructor. -
MicrobeamManipulation
public MicrobeamManipulation(org.w3c.dom.Element element, OMEModel model) throws EnumerationExceptionConstructs MicrobeamManipulation 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.
-
MicrobeamManipulation
Copy constructor.
-
-
Method Details
-
update
Updates MicrobeamManipulation recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in classAbstractOMEModelObject
- 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:OMEModelObject
Link a given OME model object to this model object.- Specified by:
link
in interfaceOMEModelObject
- Overrides:
link
in classAbstractOMEModelObject
- 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 java.lang.String getID() -
setID
public void setID(java.lang.String id) -
getType
-
setType
-
getDescription
public java.lang.String getDescription() -
setDescription
public void setDescription(java.lang.String description) -
sizeOfLinkedROIList
public int sizeOfLinkedROIList() -
copyLinkedROIList
-
getLinkedROI
-
setLinkedROI
-
linkROI
-
unlinkROI
-
getLinkedExperimenter
-
linkExperimenter
-
unlinkExperimenter
-
sizeOfLightSourceSettingsList
public int sizeOfLightSourceSettingsList() -
copyLightSourceSettingsList
-
getLightSourceSettings
-
setLightSourceSettings
public LightSourceSettings setLightSourceSettings(int index, LightSourceSettings lightSourceSettings) -
addLightSourceSettings
-
removeLightSourceSettings
-
sizeOfLinkedImageList
public int sizeOfLinkedImageList() -
copyLinkedImageList
-
getLinkedImage
-
setLinkedImage
-
linkImage
-
unlinkImage
-
getExperiment
-
setExperiment
-
asXMLElement
public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document)Description copied from interface:OMEModelObject
Takes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElement
in interfaceOMEModelObject
- Specified by:
asXMLElement
in classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element MicrobeamManipulation_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 classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.MicrobeamManipulation_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-