Package ome.xml.model

Class AnnotationRef

All Implemented Interfaces:
OMEModelObject

public class AnnotationRef extends Reference
  • Field Details

  • Constructor Details

    • AnnotationRef

      public AnnotationRef()
      Default constructor.
    • AnnotationRef

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

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

    • update

      public void update(Element element, OMEModel model) throws EnumerationException
      Updates AnnotationRef 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 Reference
      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 Reference
      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()
      Description copied from class: Reference
      Retrieves the reference's target object ID.
      Specified by:
      getID in class Reference
      Returns:
      See above.
    • setID

      public void setID(String id)
      Description copied from class: Reference
      Sets the reference's target object ID.
      Specified by:
      setID in class Reference
      Parameters:
      id - The object ID to set.
    • 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
      Overrides:
      asXMLElement in class Reference
      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 AnnotationRef_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 Reference
      Parameters:
      document - Destination document for element creation, etc.
      AnnotationRef_element - Element from the subclass. If null a new element will be created of this class.
      Returns:
      element populated with properties from this class.