Package org.docx4j.model.datastorage

Class OpenDoPEReverter

java.lang.Object

org.docx4j.model.datastorage.OpenDoPEReverter

public class OpenDoPEReverter
extends Object

Reverse the action of OpenDoPEHandler. Useful where a user has edited an instance docx, but you want to regenerate with fresh XML data. This won't work if RemovalHandler has been used to removed the content controls. Note that any edits made by hand within a condition or repeat will be lost, so it is recommended that after regenerating from this reverted template, you do a document compare (eg in Word) against your previous instance to pick up any edits in a condition or repeat which this process will have dropped). This class modifies the instance, so you'll need to clone or copy it first if that's a problem.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	OpenDoPEReverter.TopLevelSdtInstanceFinder
private static class	OpenDoPEReverter.TopLevelSdtTemplateFinder

Field Summary

Fields

Modifier and Type	Field	Description
private WordprocessingMLPackage	instancePkg
private OpenDoPEReverter.TopLevelSdtInstanceFinder	instanceSdtPrFinder
private static org.slf4j.Logger	log
private WordprocessingMLPackage	openDopePkg
(package private) Map<BigInteger,Object>	templateConditionSdtsByID
(package private) Map<BigInteger,Object>	templateRepeatSdtsByID

Constructor Summary

Constructors

Constructor	Description
OpenDoPEReverter(WordprocessingMLPackage openDopePkg, WordprocessingMLPackage instancePkg)

Method Summary

Modifier and Type	Method	Description
private void	findSdtsInTemplate(WordprocessingMLPackage pkg, OpenDoPEReverter.TopLevelSdtTemplateFinder sdtPrFinder, boolean instanceCountOnly)
private void	findSdtsInTemplatePart(ContentAccessor content, OpenDoPEReverter.TopLevelSdtTemplateFinder sdtPrFinder, boolean instanceCountOnly)
private void	handleRepeats()
private void	handleSdtsInInstance()
private void	handleSdtsInInstancePart(ContentAccessor content)
private void	repairBoundSdts()	If an SDT contained a hyperlink, we will have removed its w:dataBinding and w:text.
private void	replaceConditions()
boolean	revert()
private boolean	sanityCheck()	What about the case where the one repeat is used twice? That's ok, as long as there is some other object between the two lots of repeats.

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

openDopePkg

private WordprocessingMLPackage openDopePkg

instancePkg

private WordprocessingMLPackage instancePkg

templateConditionSdtsByID

Map<BigInteger,Object> templateConditionSdtsByID

templateRepeatSdtsByID

Map<BigInteger,Object> templateRepeatSdtsByID

instanceSdtPrFinder

private OpenDoPEReverter.TopLevelSdtInstanceFinder instanceSdtPrFinder

Constructor Details

OpenDoPEReverter

public OpenDoPEReverter(WordprocessingMLPackage openDopePkg,
 WordprocessingMLPackage instancePkg)

Method Details

revert

public boolean revert()
               throws Docx4JException

Throws:

Docx4JException

sanityCheck

private boolean sanityCheck()
                     throws Docx4JException

What about the case where the one repeat is used twice? That's ok, as long as there is some other object between the two lots of repeats. Limitation: The user could screw this up, by manually inserting a paragraph between 2 instances of a repeat. Result would be that an instance is kept, and converted back into an extra repeat! So have a sanity check that count of repeats and conditions in result matches what we have in the original template.

Throws:

Docx4JException

findSdtsInTemplate

private void findSdtsInTemplate(WordprocessingMLPackage pkg,
 OpenDoPEReverter.TopLevelSdtTemplateFinder sdtPrFinder,
 boolean instanceCountOnly)
                         throws Docx4JException

Throws:

Docx4JException

findSdtsInTemplatePart

private void findSdtsInTemplatePart(ContentAccessor content,
 OpenDoPEReverter.TopLevelSdtTemplateFinder sdtPrFinder,
 boolean instanceCountOnly)
                             throws Docx4JException

Throws:

Docx4JException

handleSdtsInInstance

private void handleSdtsInInstance()
                           throws Docx4JException

Throws:

Docx4JException

handleSdtsInInstancePart

private void handleSdtsInInstancePart(ContentAccessor content)
                               throws Docx4JException

Throws:

Docx4JException

replaceConditions

private void replaceConditions()

handleRepeats

private void handleRepeats()

repairBoundSdts

private void repairBoundSdts()
                      throws Docx4JException

If an SDT contained a hyperlink, we will have removed its w:dataBinding and w:text. So check SDT's and add back in if necessary.

Throws:

Docx4JException