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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
WellSample() Default constructor.
WellSample(Element element, OMEModel model) Constructs WellSample recursively from an XML DOM tree.

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 WellSample_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
List<Annotation>	copyLinkedAnnotationList()
List<PlateAcquisition>	copyLinkedPlateAcquisitionList()
String	getID()
NonNegativeInteger	getIndex()
Annotation	getLinkedAnnotation(int index)
Image	getLinkedImage()
PlateAcquisition	getLinkedPlateAcquisition(int index)
Double	getPositionX()
Double	getPositionY()
Timestamp	getTimepoint()
Well	getWell()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
boolean	linkAnnotation(Annotation o)
void	linkImage(Image o)
boolean	linkPlateAcquisition(PlateAcquisition o)
void	setID(String id)
void	setIndex(NonNegativeInteger index)
Annotation	setLinkedAnnotation(int index, Annotation o)
PlateAcquisition	setLinkedPlateAcquisition(int index, PlateAcquisition o)
void	setPositionX(Double positionX)
void	setPositionY(Double positionY)
void	setTimepoint(Timestamp timepoint)
void	setWell(Well well_BackReference)
int	sizeOfLinkedAnnotationList()
int	sizeOfLinkedPlateAcquisitionList()
boolean	unlinkAnnotation(Annotation o)
void	unlinkImage(Image o)
boolean	unlinkPlateAcquisition(PlateAcquisition o)
void	update(Element element, OMEModel model) Updates WellSample recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject

getChildrenByTagName, stripNamespacePrefix, update

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

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.

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 interface OMEModelObject

Overrides:

update in class AbstractOMEModelObject

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 AbstractOMEModelObject

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.

getIndex

public NonNegativeInteger getIndex()

setIndex

public void setIndex(NonNegativeInteger index)

getPositionX

public Double getPositionX()

setPositionX

public void setPositionX(Double positionX)

getPositionY

public Double getPositionY()

setPositionY

public void setPositionY(Double positionY)

getID

public String getID()

setID

public void setID(String id)

getTimepoint

public Timestamp getTimepoint()

setTimepoint

public void setTimepoint(Timestamp timepoint)

getLinkedImage

public Image getLinkedImage()

linkImage

public void linkImage(Image o)

unlinkImage

public void unlinkImage(Image o)

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)

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 interface OMEModelObject

Specified by:

asXMLElement in class AbstractOMEModelObject

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 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 class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

WellSample_element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.