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
-
-
Constructor Summary
Constructors Constructor Description MicrobeamManipulation()
Default constructor.MicrobeamManipulation(MicrobeamManipulation orig)
Copy constructor.MicrobeamManipulation(Element element, OMEModel model)
Constructs MicrobeamManipulation recursively from an XML DOM tree.
-
Method Summary
-
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
-
MicrobeamManipulation
public MicrobeamManipulation()
Default constructor.
-
MicrobeamManipulation
public MicrobeamManipulation(Element element, OMEModel model) throws EnumerationException
Constructs 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
public MicrobeamManipulation(MicrobeamManipulation orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
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
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 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 String getID()
-
setID
public void setID(String id)
-
getType
public MicrobeamManipulationType getType()
-
setType
public void setType(MicrobeamManipulationType type)
-
getDescription
public String getDescription()
-
setDescription
public void setDescription(String description)
-
sizeOfLinkedROIList
public int sizeOfLinkedROIList()
-
getLinkedROI
public ROI getLinkedROI(int index)
-
linkROI
public boolean linkROI(ROI o)
-
unlinkROI
public boolean unlinkROI(ROI o)
-
getLinkedExperimenter
public Experimenter getLinkedExperimenter()
-
linkExperimenter
public void linkExperimenter(Experimenter o)
-
unlinkExperimenter
public void unlinkExperimenter(Experimenter o)
-
sizeOfLightSourceSettingsList
public int sizeOfLightSourceSettingsList()
-
copyLightSourceSettingsList
public List<LightSourceSettings> copyLightSourceSettingsList()
-
clearLightSourceSettingsList
public void clearLightSourceSettingsList()
-
getLightSourceSettings
public LightSourceSettings getLightSourceSettings(int index)
-
setLightSourceSettings
public LightSourceSettings setLightSourceSettings(int index, LightSourceSettings lightSourceSettings)
-
addLightSourceSettings
public void addLightSourceSettings(LightSourceSettings lightSourceSettings)
-
removeLightSourceSettings
public void removeLightSourceSettings(LightSourceSettings lightSourceSettings)
-
sizeOfLinkedImageList
public int sizeOfLinkedImageList()
-
getLinkedImage
public Image getLinkedImage(int index)
-
linkImage
public boolean linkImage(Image o)
-
unlinkImage
public boolean unlinkImage(Image o)
-
getExperiment
public Experiment getExperiment()
-
setExperiment
public void setExperiment(Experiment experiment_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
- 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 Element asXMLElement(Document document, 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.
-
-