Package org.xwiki.officeimporter.document

Class XDOMOfficeDocument

    • Constructor Detail

      • XDOMOfficeDocument

        @Unstable
public XDOMOfficeDocument​(XDOM xdom,
                          Set<File> artifactFiles,
                          org.xwiki.component.manager.ComponentManager componentManager,
                          OfficeConverterResult converterResult)
        Creates a new XDOMOfficeDocument.
        Parameters:
        xdom - XDOM corresponding to office document content.
        artifactFiles - artifacts for this office document.
        componentManager - ComponentManager used to lookup for various renderers.
        converterResult - the OfficeConverterResult used to build that object.
        Since:
        13.1RC1

    • Method Detail

      • getContentDocument

        public XDOM getContentDocument()
        Description copied from interface: OfficeDocument
        Returns the content of this office document. Content document type may vary depending on the implementation. For an example, a particular implementation might return an html DOM object while another implementation might return an XDOM.
        Specified by:
        getContentDocument in interface OfficeDocument
        Returns:
        content of this document.

      • getContentAsString

        public String getContentAsString()
        Description copied from interface: OfficeDocument
        Returns the content of this document as a string.
        Specified by:
        getContentAsString in interface OfficeDocument
        Returns:
        content of this document as a string.

      • getContentAsString

        public String getContentAsString​(String syntaxId)
        Renders the XDOM encapsulated by this document into the given syntax.
        Parameters:
        syntaxId - string identifier of the syntax.
        Returns:
        content of this document in the given syntax or null if the syntax is invalid.

      • getArtifactsFiles

        public Set<File> getArtifactsFiles()
        Description copied from interface: OfficeDocument
        Returns the files corresponding to all the artifacts for this office document, except the conversion of the document itself. Artifacts are generated during the import operation if the original office document contains embedded non-textual elements. Also, some office formats (like presentations) result in multiple output files when converted into html. In this case all these output files will be considered as artifacts.
        Specified by:
        getArtifactsFiles in interface OfficeDocument
        Returns:
        the set of artifacts related to this office document.

      • getTitle

        public String getTitle()
        Tries to extract a title suitable for this document. This is done by navigating the internal XDOM and finding a matching header block.
        Returns:
        a title suitable for this document or null if no title can be found.