Package org.docx4j.model.datastorage

Class BindingTraverserXSLT

java.lang.Object

org.docx4j.model.datastorage.BindingTraverserCommonImpl

org.docx4j.model.datastorage.BindingTraverserXSLT

All Implemented Interfaces:

BindingTraverserInterface

public class BindingTraverserXSLT
extends BindingTraverserCommonImpl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BindingTraverserXSLT.BookmarkCounter	Workaround for the fact that Xalan doesn't let us pass an AtomicInteger into an extension function.

Field Summary

Fields

Modifier and Type	Field	Description
private DomToXPathMap	domToXPathMap
static boolean	ENABLE_XPATH_CACHE
private static Boolean	importXHTMLMissing
private static org.slf4j.Logger	log
private static byte[]	placeholderBytes
private static DocumentFragment	placeholderFragment
private static final String	placeholderResource
private static final String	placeholderResourceFallback
(package private) static Templates	xslt

Fields inherited from class org.docx4j.model.datastorage.BindingTraverserCommonImpl

bookmarkId

Constructor Summary

Constructors

Constructor	Description
BindingTraverserXSLT()

Method Summary

Modifier and Type	Method	Description
static DocumentFragment	convertFlatOPC(WordprocessingMLPackage pkg, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, Map<String,Xpaths.Xpath> xpathsMap, String sdtParent, String contentChild, NodeIterator rPrNodeIt, String tag)	Convert the FlatOPC into an AltChunk, which Xalan can insert into XSLT output.
static DocumentFragment	convertXHTML(BindingTraverserState bindingTraverserState, WordprocessingMLPackage pkg, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, Map<String,Xpaths.Xpath> xpathsMap, NodeIterator sdtPrNodeIt, String sdtParent, String contentChild, Map<String,Integer> sequenceCounters, BindingTraverserXSLT.BookmarkCounter bookmarkCounter)	Convert the input XHTML into a WordML w3c DocumentFragment, which Xalan can insert into XSLT output.
static DocumentFragment	convertXHTMLtoAltChunk(BindingTraverserState bindingTraverserState, WordprocessingMLPackage pkg, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, Map<String,Xpaths.Xpath> xpathsMap, NodeIterator sdtPrNodeIt, String sdtParent, String contentChild, Map<String,Integer> sequenceCounters, BindingTraverserXSLT.BookmarkCounter bookmarkCounter)	Convert the input XHTML into an altChunk, which you'll rely on Word to convert to real Word content.
protected static DocumentFragment	createPlaceholder(RPr rPr)	Calling code should set w:sdtPr/w:showingPlaceholder (ie bind.xslt), so RemovalHandler can do the right thing for Quantifier.ALL_BUT_PLACEHOLDERS case.
protected static DocumentFragment	createPlaceholder(RPr rPr, String sdtParent)	Used from convertXHTML, since bind.xslt leaves it to extension function to insert correct element structure.
private static void	createPlaceholderBytes()
private static void	createPlaceholderFragment()
private static String	evaluate(Xpaths.Xpath xpath, BindingTraverserState bindingTraverserState, WordprocessingMLPackage pkg, Map<String,CustomXmlPart> customXmlDataStorageParts)
private static Boolean	getCheckboxResult(CTDataBinding dataBinding, CustomXmlPart part)
private static PartName	getNewPartName(String prefix, String suffix, RelationshipsPart rp)
static String	getRepeatPositionCondition(Map<String,Xpaths.Xpath> xpathsMap, String odTag)
private static Xpaths.Xpath	getXpathFromTag(Tag tag, Map<String,Xpaths.Xpath> xpathsMap)
static Boolean	importXHTMLMissing()
static void	log(org.docx4j.org.apache.xalan.extensions.ExpressionContext expressionContext, String message)
static void	log(NodeIterator nodeIterator)	Deprecated.
static void	logXml(NodeIterator nodeIterator)
private static String	normalisePath(String xpIn)	Massage an XPath into the form it is in in our cache, so a hit is likely.
static DocumentFragment	nullResultParagraph(String sdtParent, String message)
void	setDomToXPathMap(DomToXPathMap domToXPathMap)
Object	traverseToBind(JaxbXmlPart part, OpcPackage pkg, Map<String,Xpaths.Xpath> xpathsMap)	Traverse (typically a clone of) the part, binding content controls.
private Object	unmarshal(Node n, boolean continu)	Unmarshal a node using Context.jc, WITHOUT fallback to pre-processing in case of failure.
static DocumentFragment	w14Checkbox(WordprocessingMLPackage wmlPackage, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, NodeIterator sdtPrNodeIt, String sdtParent, String contentChild)	Support for w14 checkbox.
static String	w14CheckboxAttr(Map<String,CustomXmlPart> customXmlDataStorageParts, NodeIterator sdtPrNodeIt)	Set w14:checked correctly
private static DocumentFragment	xhtmlError(String sdtParent, Document docContainer, DocumentFragment docfrag, String errMsg)
static DocumentFragment	xpathDate(WordprocessingMLPackage wmlPackage, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, NodeIterator sdtPrNodeIt, String sdtParent, String contentChild, NodeIterator dateNodeIt)
static DocumentFragment	xpathGenerateRuns(Map<String,String> pathMap, WordprocessingMLPackage pkg, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, String storeItemId, String xpath, String prefixMappings, SdtPr sdtPr, String sdtParent, String contentChild, boolean multiLine, BindingTraverserXSLT.BookmarkCounter bookmarkCounter)
static DocumentFragment	xpathGenerateRuns(BindingTraverserState bindingTraverserState, WordprocessingMLPackage pkg, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, String storeItemId, String xpath, String prefixMappings, NodeIterator sdtPrNodeIt, String sdtParent, String contentChild, boolean multiLine, BindingTraverserXSLT.BookmarkCounter bookmarkCounter)	bind.xslt calls this, for case where 'od:xpath' is not present
static DocumentFragment	xpathGenerateRuns(BindingTraverserState bindingTraverserState, WordprocessingMLPackage pkg, JaxbXmlPart sourcePart, Map<String,CustomXmlPart> customXmlDataStorageParts, Map<String,Xpaths.Xpath> xpathsMap, NodeIterator sdtPrNodeIt, String sdtParent, String contentChild, boolean multiLine, BindingTraverserXSLT.BookmarkCounter bookmarkCounter)	bind.xslt calls this, for case where 'od:xpath' is present
static DocumentFragment	xpathInjectImage(WordprocessingMLPackage wmlPackage, JaxbXmlPart sourcePart, Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts, String storeItemId, String xpath, String prefixMappings, String sdtParent, String contentChild, String cx, String cy)
static DocumentFragment	xpathInjectImage(WordprocessingMLPackage wmlPackage, JaxbXmlPart sourcePart, Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts, Map<String,Xpaths.Xpath> xpathsMap, String odTag, String sdtParent, String contentChild)
static String	xpathInjectImageRelId(WordprocessingMLPackage wmlPackage, JaxbXmlPart sourcePart, Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts, String storeItemId, String xpath, String prefixMappings)	Pass back to XSLT, the value of w:blip/@r:embed, preserving everything else about the existing template image.
static String	xpathInjectImageRelId(WordprocessingMLPackage wmlPackage, JaxbXmlPart sourcePart, Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts, Map<String,Xpaths.Xpath> xpathsMap, String tag)	Process a rich text control containing an image.

Methods inherited from class org.docx4j.model.datastorage.BindingTraverserCommonImpl

getNextBookmarkId, setStartingIdForNewBookmarks

Methods inherited from class java.lang.Object

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

Field Details

log

private static org.slf4j.Logger log

ENABLE_XPATH_CACHE

public static boolean ENABLE_XPATH_CACHE

xslt

static Templates xslt

domToXPathMap

private DomToXPathMap domToXPathMap

placeholderFragment

private static DocumentFragment placeholderFragment

placeholderBytes

private static byte[] placeholderBytes

placeholderResourceFallback

private static final String placeholderResourceFallback

See Also:

• Constant Field Values

placeholderResource

private static final String placeholderResource

See Also:

• Constant Field Values

importXHTMLMissing

private static Boolean importXHTMLMissing

Constructor Details

BindingTraverserXSLT

public BindingTraverserXSLT()

Method Details

setDomToXPathMap

public void setDomToXPathMap(DomToXPathMap domToXPathMap)

traverseToBind

public Object traverseToBind(JaxbXmlPart part,
 OpcPackage pkg,
 Map<String,Xpaths.Xpath> xpathsMap)
                      throws Docx4JException

Description copied from interface: BindingTraverserInterface

Traverse (typically a clone of) the part, binding content controls. Returns JAXB content tree.

Specified by:

traverseToBind in interface BindingTraverserInterface

Specified by:

traverseToBind in class BindingTraverserCommonImpl

Parameters:

part -

pkg -

doc -

xPathsPart -

Throws:

Docx4JException

unmarshal

private Object unmarshal(Node n,
 boolean continu)
                  throws jakarta.xml.bind.JAXBException

Unmarshal a node using Context.jc, WITHOUT fallback to pre-processing in case of failure.

Parameters:

n -

Returns:

Throws:

jakarta.xml.bind.JAXBException

log

public static void log(org.docx4j.org.apache.xalan.extensions.ExpressionContext expressionContext,
 String message)

log

public static void log(NodeIterator nodeIterator)

Deprecated.

Parameters:

nodeIterator -

logXml

public static void logXml(NodeIterator nodeIterator)

createPlaceholder

protected static DocumentFragment createPlaceholder(RPr rPr)
                                             throws Exception

Calling code should set w:sdtPr/w:showingPlaceholder (ie bind.xslt), so RemovalHandler can do the right thing for Quantifier.ALL_BUT_PLACEHOLDERS case. bind.xslt inserts the correct element structure for a simple bind, so all we do here is return the w:r element.

Parameters:

rPr -

sdtParent -

Returns:

Throws:

Exception

createPlaceholder

protected static DocumentFragment createPlaceholder(RPr rPr,
 String sdtParent)
                                             throws Exception

Used from convertXHTML, since bind.xslt leaves it to extension function to insert correct element structure.

Parameters:

rPr -

sdtParent -

Returns:

Throws:

Exception

createPlaceholderFragment

private static void createPlaceholderFragment()
                                       throws Exception

Throws:

Exception

createPlaceholderBytes

private static void createPlaceholderBytes()
                                    throws Exception

Throws:

Exception

importXHTMLMissing

public static Boolean importXHTMLMissing()

Returns:

Since:

8.2.1

getXpathFromTag

private static Xpaths.Xpath getXpathFromTag(Tag tag,
 Map<String,Xpaths.Xpath> xpathsMap)

evaluate

private static String evaluate(Xpaths.Xpath xpath,
 BindingTraverserState bindingTraverserState,
 WordprocessingMLPackage pkg,
 Map<String,CustomXmlPart> customXmlDataStorageParts)

convertXHTMLtoAltChunk

public static DocumentFragment convertXHTMLtoAltChunk(BindingTraverserState bindingTraverserState,
 WordprocessingMLPackage pkg,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 Map<String,Xpaths.Xpath> xpathsMap,
 NodeIterator sdtPrNodeIt,
 String sdtParent,
 String contentChild,
 Map<String,Integer> sequenceCounters,
 BindingTraverserXSLT.BookmarkCounter bookmarkCounter)

Convert the input XHTML into an altChunk, which you'll rely on Word to convert to real Word content. Note that the input XHTML must be suitable for the context ie you can't insert block level stuff (eg p) into a run level sdt. For Word to be happy, you'll need to be binding something like: <html><head><title>Import me</title></head><body><p>Hello World!</p></body></html> rather than eg <p>Hello World!</p>

Since:

8.2.1

convertXHTML

public static DocumentFragment convertXHTML(BindingTraverserState bindingTraverserState,
 WordprocessingMLPackage pkg,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 Map<String,Xpaths.Xpath> xpathsMap,
 NodeIterator sdtPrNodeIt,
 String sdtParent,
 String contentChild,
 Map<String,Integer> sequenceCounters,
 BindingTraverserXSLT.BookmarkCounter bookmarkCounter)

Convert the input XHTML into a WordML w3c DocumentFragment, which Xalan can insert into XSLT output. Note that the input XHTML must be suitable for the context ie you can't insert block level stuff (eg p) into a run level sdt. This method requires docx4j-XHTMLImport.jar (LGPL) and its dependencies in order to function.

xhtmlError

private static DocumentFragment xhtmlError(String sdtParent,
 Document docContainer,
 DocumentFragment docfrag,
 String errMsg)

Parameters:

sdtParent -

docContainer -

docfrag -

errMsg -

Returns:

xpathGenerateRuns

public static DocumentFragment xpathGenerateRuns(BindingTraverserState bindingTraverserState,
 WordprocessingMLPackage pkg,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 Map<String,Xpaths.Xpath> xpathsMap,
 NodeIterator sdtPrNodeIt,
 String sdtParent,
 String contentChild,
 boolean multiLine,
 BindingTraverserXSLT.BookmarkCounter bookmarkCounter)

bind.xslt calls this, for case where 'od:xpath' is present

xpathGenerateRuns

public static DocumentFragment xpathGenerateRuns(BindingTraverserState bindingTraverserState,
 WordprocessingMLPackage pkg,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 String storeItemId,
 String xpath,
 String prefixMappings,
 NodeIterator sdtPrNodeIt,
 String sdtParent,
 String contentChild,
 boolean multiLine,
 BindingTraverserXSLT.BookmarkCounter bookmarkCounter)

bind.xslt calls this, for case where 'od:xpath' is not present

normalisePath

private static String normalisePath(String xpIn)

Massage an XPath into the form it is in in our cache, so a hit is likely. For example, finding[6][1]/assets[1]/asset[32][1] to finding[6]/assets[1]/asset[32]

Parameters:

xpIn -

Returns:

xpathGenerateRuns

public static DocumentFragment xpathGenerateRuns(Map<String,String> pathMap,
 WordprocessingMLPackage pkg,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 String storeItemId,
 String xpath,
 String prefixMappings,
 SdtPr sdtPr,
 String sdtParent,
 String contentChild,
 boolean multiLine,
 BindingTraverserXSLT.BookmarkCounter bookmarkCounter)

xpathInjectImage

public static DocumentFragment xpathInjectImage(WordprocessingMLPackage wmlPackage,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts,
 Map<String,Xpaths.Xpath> xpathsMap,
 String odTag,
 String sdtParent,
 String contentChild)

Parameters:

wmlPackage -

sourcePart -

customXmlDataStorageParts -

xpathsMap -

odTag -

sdtParent -

contentChild -

cx -

cy -

Returns:

Since:

11.1.8

xpathInjectImage

public static DocumentFragment xpathInjectImage(WordprocessingMLPackage wmlPackage,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts,
 String storeItemId,
 String xpath,
 String prefixMappings,
 String sdtParent,
 String contentChild,
 String cx,
 String cy)

xpathInjectImageRelId

public static String xpathInjectImageRelId(WordprocessingMLPackage wmlPackage,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts,
 Map<String,Xpaths.Xpath> xpathsMap,
 String tag)

Process a rich text control containing an image.

Parameters:

wmlPackage -

sourcePart -

customXmlDataStorageParts -

xPathsPart -

tag -

Returns:

Since:

3.0.1

xpathInjectImageRelId

public static String xpathInjectImageRelId(WordprocessingMLPackage wmlPackage,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlDataStoragePart> customXmlDataStorageParts,
 String storeItemId,
 String xpath,
 String prefixMappings)

Pass back to XSLT, the value of w:blip/@r:embed, preserving everything else about the existing template image.

Parameters:

wmlPackage -

sourcePart -

customXmlDataStorageParts -

storeItemId -

xpath -

prefixMappings -

Returns:

Since:

3.0.0

getRepeatPositionCondition

public static String getRepeatPositionCondition(Map<String,Xpaths.Xpath> xpathsMap,
 String odTag)

nullResultParagraph

public static DocumentFragment nullResultParagraph(String sdtParent,
 String message)

xpathDate

public static DocumentFragment xpathDate(WordprocessingMLPackage wmlPackage,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 NodeIterator sdtPrNodeIt,
 String sdtParent,
 String contentChild,
 NodeIterator dateNodeIt)

convertFlatOPC

public static DocumentFragment convertFlatOPC(WordprocessingMLPackage pkg,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 Map<String,Xpaths.Xpath> xpathsMap,
 String sdtParent,
 String contentChild,
 NodeIterator rPrNodeIt,
 String tag)

Convert the FlatOPC into an AltChunk, which Xalan can insert into XSLT output.

Since:

3.0.1

w14Checkbox

public static DocumentFragment w14Checkbox(WordprocessingMLPackage wmlPackage,
 JaxbXmlPart sourcePart,
 Map<String,CustomXmlPart> customXmlDataStorageParts,
 NodeIterator sdtPrNodeIt,
 String sdtParent,
 String contentChild)

Support for w14 checkbox.

Since:

3.2.2

getCheckboxResult

private static Boolean getCheckboxResult(CTDataBinding dataBinding,
 CustomXmlPart part)
                                  throws Docx4JException

Throws:

Docx4JException

w14CheckboxAttr

public static String w14CheckboxAttr(Map<String,CustomXmlPart> customXmlDataStorageParts,
 NodeIterator sdtPrNodeIt)

Set w14:checked correctly

Since:

6.0.0

getNewPartName

private static PartName getNewPartName(String prefix,
 String suffix,
 RelationshipsPart rp)
                                throws InvalidFormatException

Throws:

InvalidFormatException