Package ome.xml.model

Class Well

All Implemented Interfaces:
OMEModelObject

public class Well extends AbstractOMEModelObject
  • Field Details

  • Constructor Details

    • Well

      public Well()
      Default constructor.
    • Well

      public Well(Element element, OMEModel model) throws EnumerationException
      Constructs Well 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.
    • Well

      public Well(Well orig)
      Copy constructor.
  • Method Details

    • update

      public void update(Element element, OMEModel model) throws EnumerationException
      Updates Well 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.
    • getID

      public String getID()
    • setID

      public void setID(String id)
    • getColumn

      public NonNegativeInteger getColumn()
    • setColumn

      public void setColumn(NonNegativeInteger column)
    • getRow

      public NonNegativeInteger getRow()
    • setRow

      public void setRow(NonNegativeInteger row)
    • getExternalDescription

      public String getExternalDescription()
    • setExternalDescription

      public void setExternalDescription(String externalDescription)
    • getExternalIdentifier

      public String getExternalIdentifier()
    • setExternalIdentifier

      public void setExternalIdentifier(String externalIdentifier)
    • getType

      public String getType()
    • setType

      public void setType(String type)
    • getColor

      public Color getColor()
    • setColor

      public void setColor(Color color)
    • sizeOfWellSampleList

      public int sizeOfWellSampleList()
    • copyWellSampleList

      public List<WellSample> copyWellSampleList()
    • clearWellSampleList

      public void clearWellSampleList()
    • getWellSample

      public WellSample getWellSample(int index)
    • setWellSample

      public WellSample setWellSample(int index, WellSample wellSample)
    • addWellSample

      public void addWellSample(WellSample wellSample)
    • removeWellSample

      public void removeWellSample(WellSample wellSample)
    • getLinkedReagent

      public Reagent getLinkedReagent()
    • linkReagent

      public void linkReagent(Reagent o)
    • unlinkReagent

      public void unlinkReagent(Reagent 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)
    • getPlate

      public Plate getPlate()
    • setPlate

      public void setPlate(Plate plate_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

      public Element asXMLElement(Document document, Element Well_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.
      Well_element - Element from the subclass. If null a new element will be created of this class.
      Returns:
      element populated with properties from this class.