Package ome.xml.model

Class BinaryFile

    • Constructor Detail

      • BinaryFile

        public BinaryFile()
        Default constructor.
      • BinaryFile

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

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

      • update

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

        public String getFileName()
      • setFileName

        public void setFileName​(String fileName)
      • getMIMEType

        public String getMIMEType()
      • setMIMEType

        public void setMIMEType​(String mimeType)
      • getExternal

        public External getExternal()
      • setExternal

        public void setExternal​(External external)
      • getBinData

        public BinData getBinData()
      • setBinData

        public void setBinData​(BinData binData)
      • asXMLElement

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