Package ome.xml.model

Class ROI

    • Constructor Detail

      • ROI

        public ROI()
        Default constructor.
      • ROI

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

        public ROI​(ROI orig)
        Copy constructor.
    • Method Detail

      • update

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

        public Union getUnion()
      • setUnion

        public void setUnion​(Union union)
      • sizeOfLinkedAnnotationList

        public int sizeOfLinkedAnnotationList()
      • copyLinkedAnnotationList

        public List<Annotation> copyLinkedAnnotationList()
      • getLinkedAnnotation

        public Annotation getLinkedAnnotation​(int index)
      • linkAnnotation

        public boolean linkAnnotation​(Annotation o)
      • unlinkAnnotation

        public boolean unlinkAnnotation​(Annotation o)
      • getDescription

        public String getDescription()
      • setDescription

        public void setDescription​(String description)
      • sizeOfLinkedImageList

        public int sizeOfLinkedImageList()
      • copyLinkedImageList

        public List<Image> copyLinkedImageList()
      • getLinkedImage

        public Image getLinkedImage​(int index)
      • setLinkedImage

        public Image setLinkedImage​(int index,
                                    Image o)
      • linkImage

        public boolean linkImage​(Image o)
      • unlinkImage

        public boolean unlinkImage​(Image o)
      • sizeOfLinkedMicrobeamManipulationList

        public int sizeOfLinkedMicrobeamManipulationList()
      • getLinkedMicrobeamManipulation

        public MicrobeamManipulation getLinkedMicrobeamManipulation​(int index)
      • sizeOfLinkedFolderList

        public int sizeOfLinkedFolderList()
      • copyLinkedFolderList

        public List<Folder> copyLinkedFolderList()
      • getLinkedFolder

        public Folder getLinkedFolder​(int index)
      • setLinkedFolder

        public Folder setLinkedFolder​(int index,
                                      Folder o)
      • linkFolder

        public boolean linkFolder​(Folder o)
      • unlinkFolder

        public boolean unlinkFolder​(Folder o)
      • asXMLElement

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