Package ome.xml.model
Class WellSample
- java.lang.Object
-
- ome.xml.model.AbstractOMEModelObject
-
- ome.xml.model.WellSample
-
- All Implemented Interfaces:
OMEModelObject
public class WellSample extends AbstractOMEModelObject
-
-
Constructor Summary
Constructors Constructor Description WellSample()
Default constructor.WellSample(WellSample orig)
Copy constructor.WellSample(Element element, OMEModel model)
Constructs WellSample 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
-
WellSample
public WellSample()
Default constructor.
-
WellSample
public WellSample(Element element, OMEModel model) throws EnumerationException
Constructs WellSample 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.
-
WellSample
public WellSample(WellSample orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
Updates WellSample 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)
-
getPositionX
public Length getPositionX()
-
setPositionX
public void setPositionX(Length positionX)
-
getPositionXUnitXsdDefault
public static String getPositionXUnitXsdDefault()
-
getPositionY
public Length getPositionY()
-
setPositionY
public void setPositionY(Length positionY)
-
getPositionYUnitXsdDefault
public static String getPositionYUnitXsdDefault()
-
getTimepoint
public Timestamp getTimepoint()
-
setTimepoint
public void setTimepoint(Timestamp timepoint)
-
getIndex
public NonNegativeInteger getIndex()
-
setIndex
public void setIndex(NonNegativeInteger index)
-
getLinkedImage
public Image getLinkedImage()
-
linkImage
public void linkImage(Image o)
-
unlinkImage
public void unlinkImage(Image o)
-
sizeOfLinkedPlateAcquisitionList
public int sizeOfLinkedPlateAcquisitionList()
-
copyLinkedPlateAcquisitionList
public List<PlateAcquisition> copyLinkedPlateAcquisitionList()
-
getLinkedPlateAcquisition
public PlateAcquisition getLinkedPlateAcquisition(int index)
-
setLinkedPlateAcquisition
public PlateAcquisition setLinkedPlateAcquisition(int index, PlateAcquisition o)
-
linkPlateAcquisition
public boolean linkPlateAcquisition(PlateAcquisition o)
-
unlinkPlateAcquisition
public boolean unlinkPlateAcquisition(PlateAcquisition o)
-
getWell
public Well getWell()
-
setWell
public void setWell(Well well_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 WellSample_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.WellSample_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-