Package ome.xml.model

Class Folder

    • Constructor Detail

      • Folder

        public Folder()
        Default constructor.

      • Folder

        public Folder​(org.w3c.dom.Element element,
              OMEModel model)
       throws EnumerationException
        Constructs Folder 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.

      • Folder

        public Folder​(Folder orig)
        Copy constructor.

    • Method Detail

      • update

        public void update​(org.w3c.dom.Element element,
                   OMEModel model)
            throws EnumerationException
        Updates Folder 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 java.lang.String getID()

      • setID

        public void setID​(java.lang.String id)

      • getName

        public java.lang.String getName()

      • setName

        public void setName​(java.lang.String name)

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)

      • sizeOfLinkedFolderList

        public int sizeOfLinkedFolderList()

      • copyLinkedFolderList

        public java.util.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)

      • sizeOfLinkedImageList

        public int sizeOfLinkedImageList()

      • copyLinkedImageList

        public java.util.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)

      • sizeOfLinkedROIList

        public int sizeOfLinkedROIList()

      • copyLinkedROIList

        public java.util.List<ROI> copyLinkedROIList()

      • getLinkedROI

        public ROI getLinkedROI​(int index)

      • setLinkedROI

        public ROI setLinkedROI​(int index,
                        ROI o)

      • linkROI

        public boolean linkROI​(ROI o)

      • unlinkROI

        public boolean unlinkROI​(ROI o)

      • sizeOfLinkedAnnotationList

        public int sizeOfLinkedAnnotationList()

      • copyLinkedAnnotationList

        public java.util.List<Annotation> copyLinkedAnnotationList()

      • getLinkedAnnotation

        public Annotation getLinkedAnnotation​(int index)

      • linkAnnotation

        public boolean linkAnnotation​(Annotation o)

      • unlinkAnnotation

        public boolean unlinkAnnotation​(Annotation o)

      • sizeOfLinkedChildFolderList

        public int sizeOfLinkedChildFolderList()

      • copyLinkedChildFolderList

        public java.util.List<Folder> copyLinkedChildFolderList()

      • getLinkedChildFolder

        public Folder getLinkedChildFolder​(int index)

      • setLinkedChildFolder

        public Folder setLinkedChildFolder​(int index,
                                   Folder o)

      • linkChildFolder

        public boolean linkChildFolder​(Folder o)

      • unlinkChildFolder

        public boolean unlinkChildFolder​(Folder o)

      • asXMLElement

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