Package org.docx4j.openpackaging.parts

Class JaxbXmlPartAltChunkHost<E>

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.JaxbXmlPart<E>

org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware<E>

org.docx4j.openpackaging.parts.JaxbXmlPartAltChunkHost<E>

All Implemented Interfaces:

AltChunkInterface, XPathEnabled<E>

Direct Known Subclasses:

DocumentPart, FooterPart, HeaderPart

public abstract class JaxbXmlPartAltChunkHost<E>
extends JaxbXmlPartXPathAware<E>
implements AltChunkInterface

Since:

3.0.0

Author:

jharrop

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	log

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

binder

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

jaxbElement, jc, MAX_BYTES_Unmarshal_Error

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor	Description
JaxbXmlPartAltChunkHost(PartName partName)

Method Summary

Modifier and Type	Method	Description
AlternativeFormatInputPart	addAltChunk(AltChunkType type, byte[] bytes)	Add content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
AlternativeFormatInputPart	addAltChunk(AltChunkType type, byte[] bytes, int index)	Add at index content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
AlternativeFormatInputPart	addAltChunk(AltChunkType type, byte[] bytes, ContentAccessor attachmentPoint)	Add content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
AlternativeFormatInputPart	addAltChunk(AltChunkType type, byte[] bytes, ContentAccessor attachmentPoint, int index)	Add at index content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
AlternativeFormatInputPart	addAltChunk(AltChunkType type, InputStream is)	Add content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
AlternativeFormatInputPart	addAltChunk(AltChunkType type, InputStream is, int index)	Add at index content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
AlternativeFormatInputPart	addAltChunk(AltChunkType type, InputStream is, ContentAccessor attachmentPoint)	Add content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
AlternativeFormatInputPart	addAltChunk(AltChunkType type, InputStream is, ContentAccessor attachmentPoint, int index)	Add at index content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content.
void	convertAltChunks()	Convert altChunks in this part to ordinary docx WordML content.

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

createBinderAndJaxbElement, getBinder, getJAXBAssociationsForXPath, getJAXBAssociationsForXPath, getJAXBNodesViaXPath, getJAXBNodesViaXPath, setJaxbElement, unmarshal, unmarshal

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

addMcChoiceNamespace, getConfiguredUnmarshaller, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getMceIgnorable, getXML, getXMLStreamReader, inputStreamToXSR, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, preprocess, replacePartContent, setContents, setJAXBContext, setJaxbElement, setMceIgnorable, transform, transformToDom, variableReplace

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setPartShortcut, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, reset, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

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

Field Details

log

protected static org.slf4j.Logger log

Constructor Details

JaxbXmlPartAltChunkHost

public JaxbXmlPartAltChunkHost(PartName partName)
                        throws InvalidFormatException

Throws:

InvalidFormatException

Method Details

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 byte[] bytes)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 byte[] bytes,
 int index)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add at index content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 InputStream is)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 InputStream is,
 int index)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add at index content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 byte[] bytes,
 ContentAccessor attachmentPoint)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 byte[] bytes,
 ContentAccessor attachmentPoint,
 int index)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add at index content from byte array of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 InputStream is,
 ContentAccessor attachmentPoint)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

addAltChunk

public AlternativeFormatInputPart addAltChunk(AltChunkType type,
 InputStream is,
 ContentAccessor attachmentPoint,
 int index)
                                       throws Docx4JException

Description copied from interface: AltChunkInterface

Add at index content from InputStream of type AltChunkType, in a way that leaves it up to downstream application (eg Word) to convert the content to docx content. Note re XHTML content: Unless you really want it converted by Word, users are advised to use docx4j's XHTMLImporter instead.

Specified by:

addAltChunk in interface AltChunkInterface

Returns:

Throws:

Docx4JException

convertAltChunks

public void convertAltChunks()
                      throws Docx4JException

Description copied from interface: AltChunkInterface

Convert altChunks in this part to ordinary docx WordML content. To convert an altChunk of type XHTML, this method requires docx4j-XHTMLImport.jar (LGPL) and its dependencies. Since 11.4.8, this method does the conversion in situ (ie rather than cloning the pkg), and does not convert docx altChunks. To handle those, use the MergeDocx component of Docx4j Enterprise.

Specified by:

convertAltChunks in interface AltChunkInterface

Throws:

Docx4JException