Package ome.xml.model

Class Screen

All Implemented Interfaces:
OMEModelObject

public class Screen extends AbstractOMEModelObject
  • Field Details

  • Constructor Details

    • Screen

      public Screen()
      Default constructor.
    • Screen

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

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

    • update

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

      public String getName()
    • setName

      public void setName(String name)
    • getProtocolIdentifier

      public String getProtocolIdentifier()
    • setProtocolIdentifier

      public void setProtocolIdentifier(String protocolIdentifier)
    • getProtocolDescription

      public String getProtocolDescription()
    • setProtocolDescription

      public void setProtocolDescription(String protocolDescription)
    • getReagentSetDescription

      public String getReagentSetDescription()
    • setReagentSetDescription

      public void setReagentSetDescription(String reagentSetDescription)
    • getReagentSetIdentifier

      public String getReagentSetIdentifier()
    • setReagentSetIdentifier

      public void setReagentSetIdentifier(String reagentSetIdentifier)
    • getType

      public String getType()
    • setType

      public void setType(String type)
    • getDescription

      public String getDescription()
    • setDescription

      public void setDescription(String description)
    • sizeOfReagentList

      public int sizeOfReagentList()
    • copyReagentList

      public List<Reagent> copyReagentList()
    • clearReagentList

      public void clearReagentList()
    • getReagent

      public Reagent getReagent(int index)
    • setReagent

      public Reagent setReagent(int index, Reagent reagent)
    • addReagent

      public void addReagent(Reagent reagent)
    • removeReagent

      public void removeReagent(Reagent reagent)
    • sizeOfLinkedPlateList

      public int sizeOfLinkedPlateList()
    • copyLinkedPlateList

      public List<Plate> copyLinkedPlateList()
    • getLinkedPlate

      public Plate getLinkedPlate(int index)
    • setLinkedPlate

      public Plate setLinkedPlate(int index, Plate o)
    • linkPlate

      public boolean linkPlate(Plate o)
    • unlinkPlate

      public boolean unlinkPlate(Plate 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)
    • 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 Screen_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.
      Screen_element - Element from the subclass. If null a new element will be created of this class.
      Returns:
      element populated with properties from this class.