Package ome.xml.model

Class Mask

    • Constructor Detail

      • Mask

        public Mask()
        Default constructor.
      • Mask

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

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

      • update

        public void update​(Element element,
                           OMEModel model)
                    throws EnumerationException
        Updates Mask 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 Shape
        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 Shape
        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.
      • setX

        public void setX​(Double x)
      • setY

        public void setY​(Double y)
      • getWidth

        public Double getWidth()
      • setWidth

        public void setWidth​(Double width)
      • getHeight

        public Double getHeight()
      • setHeight

        public void setHeight​(Double height)
      • getBinData

        public BinData getBinData()
      • setBinData

        public void setBinData​(BinData binData)
      • 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 Shape
        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 Mask_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 Shape
        Parameters:
        document - Destination document for element creation, etc.
        Mask_element - Element from the subclass. If null a new element will be created of this class.
        Returns:
        element populated with properties from this class.