org.docx4j.model.datastorage

Class OpenDoPEHandler

java.lang.Object

org.docx4j.model.datastorage.OpenDoPEHandler

public class OpenDoPEHandler
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	BINDING_CONTENTTYPE
static String	BINDING_HANDLER
static String	BINDING_PROGID
static String	BINDING_RESULT_CONDITION_FALSE
static String	BINDING_RESULT_RPTD
static String	BINDING_RESULT_RPTD_ZERO
static String	BINDING_RESULT_RPTD_ZERO_W15
static String	BINDING_ROLE_COMPONENT
static String	BINDING_ROLE_COMPONENT_AFTER
static String	BINDING_ROLE_COMPONENT_BEFORE
static String	BINDING_ROLE_CONDITIONAL
static String	BINDING_ROLE_NARRATIVE
static String	BINDING_ROLE_REPEAT
static String	BINDING_ROLE_RPT_POS_CON
static String	BINDING_ROLE_XPATH
long	cloneTime
long	fixBTime

Constructor Summary

Constructors

Constructor and Description
OpenDoPEHandler(WordprocessingMLPackage wordMLPackage)

Method Summary

Modifier and Type	Method and Description
void	extensionMissing(Exception e)
static DocxFetcher	getDocxFetcher()
AtomicInteger	getNextBookmarkId() Provide a way to for user to fetch the starting bookmark ID number for use in the next stage (ie Binding Traverse).
protected static Set<ContentAccessor>	getParts(WordprocessingMLPackage srcPackage)
static SdtPr	getSdtPr(Object o)
void	makeContinuous(SectPr sectPr)
WordprocessingMLPackage	preprocess() Preprocess content controls which have tag "od:condition|od:repeat|od:component".
static void	setDocxFetcher(DocxFetcher docxFetcher)

Methods inherited from class java.lang.Object

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

Field Detail

BINDING_ROLE_XPATH

public static final String BINDING_ROLE_XPATH

See Also:

Constant Field Values

BINDING_ROLE_CONDITIONAL

public static final String BINDING_ROLE_CONDITIONAL

See Also:

Constant Field Values

BINDING_RESULT_CONDITION_FALSE

public static final String BINDING_RESULT_CONDITION_FALSE

See Also:

Constant Field Values

BINDING_ROLE_REPEAT

public static final String BINDING_ROLE_REPEAT

See Also:

Constant Field Values

BINDING_RESULT_RPTD_ZERO

public static final String BINDING_RESULT_RPTD_ZERO

See Also:

Constant Field Values

BINDING_RESULT_RPTD_ZERO_W15

public static final String BINDING_RESULT_RPTD_ZERO_W15

See Also:

Constant Field Values

BINDING_RESULT_RPTD

public static final String BINDING_RESULT_RPTD

See Also:

Constant Field Values

BINDING_ROLE_RPT_POS_CON

public static final String BINDING_ROLE_RPT_POS_CON

See Also:

Constant Field Values

BINDING_ROLE_NARRATIVE

public static final String BINDING_ROLE_NARRATIVE

See Also:

Constant Field Values

BINDING_ROLE_COMPONENT

public static final String BINDING_ROLE_COMPONENT

See Also:

Constant Field Values

BINDING_ROLE_COMPONENT_BEFORE

public static final String BINDING_ROLE_COMPONENT_BEFORE

See Also:

Constant Field Values

BINDING_ROLE_COMPONENT_AFTER

public static final String BINDING_ROLE_COMPONENT_AFTER

See Also:

Constant Field Values

BINDING_CONTENTTYPE

public static final String BINDING_CONTENTTYPE

See Also:

Constant Field Values

BINDING_HANDLER

public static final String BINDING_HANDLER

See Also:

Constant Field Values

BINDING_PROGID

public static final String BINDING_PROGID

See Also:

Constant Field Values

cloneTime

public long cloneTime

fixBTime

public long fixBTime

Constructor Detail

OpenDoPEHandler

public OpenDoPEHandler(WordprocessingMLPackage wordMLPackage)
                throws Docx4JException

Throws:

Docx4JException

Method Detail

getNextBookmarkId

public AtomicInteger getNextBookmarkId()

Provide a way to for user to fetch the starting bookmark ID number for use in the next stage (ie Binding Traverse). If it isn't fetched/set, the value will have to be recalculated (less efficient).

Since:

3.2.1

preprocess

public WordprocessingMLPackage preprocess()
                                   throws Docx4JException

Preprocess content controls which have tag "od:condition|od:repeat|od:component". It is "preprocess" in the sense that it is "pre" opening in Word The algorithm is as follows: Inject components first. Look at each top level SDT (ShallowTraversor). If it does not have a real data binding, it might have a bindingrole tag we need to process (processBindingRoleIfAny). Conditionals are easy. processRepeat method: - clones the sdt n times - invokes DeepTraversor which changes xpath binding on descendant sdts (both sdts with real bindings and sdts with bindingrole tags). It is not the job of DeepTraversor to expand out any other repeats it might encounter, or to resolve conditionals. Those things are done by ShallowTraversor, to which control returns, as it continues its traverse. The implementation of 13 Sept 2010 replaced the previous XPath based implementation, which did not support nested repeats. I've chosen to build this around TraversalUtil, instead of using XSLT, and this seems to have worked out nicely. The implementation of 10 October 2010 replaced the v1 conventions implementation with a v2 implementation. The main method in this class can convert v1 documents to v2. The v2 implementation is not yet complete. All v1 features are implemented, but not the new v2 stuff (eg complex conditions).

Parameters:

documentPart -

Throws:

Exception

Docx4JException

getDocxFetcher

public static DocxFetcher getDocxFetcher()

setDocxFetcher

public static void setDocxFetcher(DocxFetcher docxFetcher)

getParts

protected static Set<ContentAccessor> getParts(WordprocessingMLPackage srcPackage)

makeContinuous

public void makeContinuous(SectPr sectPr)

extensionMissing

public void extensionMissing(Exception e)

getSdtPr

public static SdtPr getSdtPr(Object o)