Class OfficeDocument


  • public class OfficeDocument
    extends java.lang.Object
    This class implements reading of ODF files from various sources
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String CONTENTXML  
      protected static java.lang.String STYLESXML  
    • Constructor Summary

      Constructors 
      Constructor Description
      OfficeDocument()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.w3c.dom.Document getContentDOM()
      Return a DOM Document object of the content.xml file.
      EmbeddedObject getEmbeddedObject​(java.lang.String sName)
      Returns the embedded object corresponding to the name provided.
      org.w3c.dom.Document getMetaDOM()
      Return a DOM Document object of the meta.xml file.
      org.w3c.dom.Document getStyleDOM()
      Return a DOM Document object of the style.xml file.
      boolean isPackageFormat()
      Package or flat format?
      void read​(java.io.InputStream is)
      Read the Office Document from the given InputStream.
      void read​(org.w3c.dom.Document dom)
      Read the document from a DOM tree (flat XML format)
      protected void removeEmbeddedObject​(java.lang.String sName)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OfficeDocument

        public OfficeDocument()
    • Method Detail

      • isPackageFormat

        public boolean isPackageFormat()
        Package or flat format?
        Returns:
        true if the document is in package format, false if it's flat XML
      • getContentDOM

        public org.w3c.dom.Document getContentDOM()
        Return a DOM Document object of the content.xml file. file. Note that a content DOM is not created when the constructor is called, but only after the read method has been invoked
        Returns:
        DOM Document object.
      • getMetaDOM

        public org.w3c.dom.Document getMetaDOM()
        Return a DOM Document object of the meta.xml file. Note that a meta DOM is not created when the constructor is called, but only after the read method has been invoked
        Returns:
        DOM Document object.
      • getStyleDOM

        public org.w3c.dom.Document getStyleDOM()
        Return a DOM Document object of the style.xml file. Note that a style DOM is not created when the constructor is called, but only after the read method has been invoked
        Returns:
        DOM Document object.
      • getEmbeddedObject

        public EmbeddedObject getEmbeddedObject​(java.lang.String sName)
        Returns the embedded object corresponding to the name provided. The name should be stripped of any preceding path characters, such as '/', '.' or '#'.
        Parameters:
        sName - The name of the embedded object to retrieve.
        Returns:
        An EmbeddedObject instance representing the named object.
      • removeEmbeddedObject

        protected void removeEmbeddedObject​(java.lang.String sName)
      • read

        public void read​(org.w3c.dom.Document dom)
        Read the document from a DOM tree (flat XML format)
        Parameters:
        dom - the DOM tree
      • read

        public void read​(java.io.InputStream is)
                  throws java.io.IOException
        Read the Office Document from the given InputStream. Performs simple type detection to determine package or flat format
        Parameters:
        is - Office document InputStream.
        Throws:
        java.io.IOException - If any I/O error occurs.
        org.xml.sax.SAXException