org.zwobble.mammoth

Class DocumentConverter

java.lang.Object

org.zwobble.mammoth.DocumentConverter

public class DocumentConverter
extends Object

Constructor Summary

Constructors

Constructor and Description
DocumentConverter()

Method Summary

Modifier and Type	Method and Description
DocumentConverter	addStyleMap(String styleMap) Add a style map to specify the mapping of Word styles to HTML.
Result<String>	convertToHtml(File file) Converts file into an HTML string.
Result<String>	convertToHtml(InputStream stream) Converts stream into an HTML string.
DocumentConverter	disableDefaultStyleMap() By default, any added style maps are combined with the default style map.
DocumentConverter	disableEmbeddedStyleMap() By default, if the document contains an embedded style map, then it is combined with the default style map.
Result<String>	extractRawText(File file) Extract the raw text of the document.
Result<String>	extractRawText(InputStream stream) Extract the raw text of the document.
DocumentConverter	idPrefix(String idPrefix) A string to prepend to any generated IDs, such as those used by bookmarks, footnotes and endnotes.
DocumentConverter	imageConverter(ImageConverter.ImgElement imageConverter) By default, images are converted to <img> elements with the source included inline in the src attribute.
DocumentConverter	preserveEmptyParagraphs() By default, empty paragraphs are ignored.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentConverter

public DocumentConverter()

Method Detail

idPrefix

public DocumentConverter idPrefix(String idPrefix)

A string to prepend to any generated IDs, such as those used by bookmarks, footnotes and endnotes. Defaults to the empty string.

preserveEmptyParagraphs

public DocumentConverter preserveEmptyParagraphs()

By default, empty paragraphs are ignored. Call this to preserve empty paragraphs in the output.

addStyleMap

public DocumentConverter addStyleMap(String styleMap)

Add a style map to specify the mapping of Word styles to HTML. The most recently added style map has the greatest precedence.

disableDefaultStyleMap

public DocumentConverter disableDefaultStyleMap()

By default, any added style maps are combined with the default style map. Call this to stop using the default style map altogether.

disableEmbeddedStyleMap

public DocumentConverter disableEmbeddedStyleMap()

By default, if the document contains an embedded style map, then it is combined with the default style map. Call this to ignore any embedded style maps.

imageConverter

public DocumentConverter imageConverter(ImageConverter.ImgElement imageConverter)

By default, images are converted to <img> elements with the source included inline in the src attribute. Call this to change how images are converted.

convertToHtml

public Result<String> convertToHtml(InputStream stream)
                             throws IOException

Converts stream into an HTML string. Note that using this method instead of convertToHtml(File file) means that relative paths to other files, such as images, cannot be resolved.

Throws:

IOException

convertToHtml

public Result<String> convertToHtml(File file)
                             throws IOException

Converts file into an HTML string.

Throws:

IOException

extractRawText

public Result<String> extractRawText(InputStream stream)
                              throws IOException

Extract the raw text of the document. This will ignore all formatting in the document. Each paragraph is followed by two newlines.

Throws:

IOException

extractRawText

public Result<String> extractRawText(File file)
                              throws IOException

Extract the raw text of the document. This will ignore all formatting in the document. Each paragraph is followed by two newlines.

Throws:

IOException