Package org.xwiki.officeimporter.document

Class XHTMLOfficeDocument

java.lang.Object

org.xwiki.officeimporter.document.XHTMLOfficeDocument

All Implemented Interfaces:

Closeable, AutoCloseable, OfficeDocument

public class XHTMLOfficeDocument
extends Object
implements OfficeDocument

A OfficeDocument backed by a w3c Document containing xhtml markup.

Since:

2.1M1

Version:

$Id: 2425e8e960a397980311bdc131527293b15d8515 $

Constructor Summary

Constructors

Constructor	Description
XHTMLOfficeDocument(Document document, Set<File> artifactFiles, OfficeConverterResult converterResult)	Creates a new XHTMLOfficeDocument.

Method Summary

Modifier and Type	Method	Description
void	close()
Set<File>	getArtifactsFiles()	Returns the files corresponding to all the artifacts for this office document, except the conversion of the document itself.
String	getContentAsString()	Returns the content of this document as a string.
Document	getContentDocument()	Returns the content of this office document.
OfficeConverterResult	getConverterResult()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XHTMLOfficeDocument

public XHTMLOfficeDocument(Document document,
                           Set<File> artifactFiles,
                           OfficeConverterResult converterResult)

Creates a new XHTMLOfficeDocument.

Parameters:

document - the w3c dom representing the office document.

artifactFiles - artifacts for this office document.

converterResult - the OfficeConverterResult used to build that object.

Since:

13.1RC1

Method Detail

getContentDocument

public Document 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.

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.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface OfficeDocument

Throws:

IOException

getConverterResult

public OfficeConverterResult getConverterResult()

Specified by:

getConverterResult in interface OfficeDocument

Returns:

the converter result.