Package org.docx4j.openpackaging.parts.opendope

Class JaxbCustomXmlDataStoragePart<E>

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

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

org.docx4j.openpackaging.parts.opendope.JaxbCustomXmlDataStoragePart<E>

All Implemented Interfaces:

CustomXmlPart

Direct Known Subclasses:

BibliographyPart, ComponentsPart, ConditionsPart, DocPropsCoverPagePart, QuestionsPart, StandardisedAnswersPart, XPathsPart

public abstract class JaxbCustomXmlDataStoragePart<E>
extends JaxbXmlPart<E>
implements CustomXmlPart

Field Summary

Fields

Modifier and Type	Field	Description
protected Document	doc	This part's XML contents.
private NamespacePrefixMappings	nsContext
private static XPath	xPath

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

jaxbElement, jc, log, 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
JaxbCustomXmlDataStoragePart(PartName partName)
JaxbCustomXmlDataStoragePart(PartName partName, jakarta.xml.bind.JAXBContext jc)

Method Summary

Modifier and Type	Method	Description
boolean	cachedXPathGetBoolean(String xpath, String prefixMappings)
String	cachedXPathGetString(String xpath, String prefixMappings)	Use org.apache.xpath.CachedXPathAPI, since this is much quicker than default javax.xml.xpath.XPath implementations (Apache's anyway) for large XML files.
void	discardCacheXPathObject()	Use this to null out the org.apache.xpath.CachedXPathAPI object, which you should do if you've changed your source document, or want to reclaim memory.
String	getItemId()
private NamespacePrefixMappings	getNamespaceContext()
void	init()
void	readyXPath()	XPaths are evaluated against a DOM document representation of the JAXBElement.
void	remove()	Remove this part from the pkg.
boolean	setNodeValueAtXPath(String xpath, String value, String prefixMappings)
void	setXML(Document xmlDocument)	Set the XML data
void	updateJaxbElementFromDocument()
boolean	xpathGetAsBoolean(String xpathB, String prefixMappings)
List<Node>	xpathGetNodes(String xpathString, String prefixMappings)
String	xpathGetString(String xpathString, String prefixMappings)

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, setJaxbElement, setMceIgnorable, transform, transformToDom, unmarshal, unmarshal, variableReplace

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

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, 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

Methods inherited from interface org.docx4j.openpackaging.parts.CustomXmlPart

getXML

Field Details

doc

protected Document doc

This part's XML contents. Not guaranteed to be up to date. Whether it is or not will depend on how the class which extends Part chooses to treat it. It may be that the class uses some other internal representation for its data.

xPath

private static XPath xPath

nsContext

private NamespacePrefixMappings nsContext

Constructor Details

JaxbCustomXmlDataStoragePart

public JaxbCustomXmlDataStoragePart(PartName partName)
                             throws InvalidFormatException

Throws:

InvalidFormatException

JaxbCustomXmlDataStoragePart

public JaxbCustomXmlDataStoragePart(PartName partName,
 jakarta.xml.bind.JAXBContext jc)
                             throws InvalidFormatException

Throws:

InvalidFormatException

Method Details

init

public void init()

readyXPath

public void readyXPath()

XPaths are evaluated against a DOM document representation of the JAXBElement. These aren't kept in sync, so you can use this method to update the DOM document from the JAXBElement.

updateJaxbElementFromDocument

public void updateJaxbElementFromDocument()

getNamespaceContext

private NamespacePrefixMappings getNamespaceContext()

xpathGetString

public String xpathGetString(String xpathString,
 String prefixMappings)
                      throws Docx4JException

Specified by:

xpathGetString in interface CustomXmlPart

Throws:

Docx4JException

cachedXPathGetString

public String cachedXPathGetString(String xpath,
 String prefixMappings)
                            throws Docx4JException

Description copied from interface: CustomXmlPart

Use org.apache.xpath.CachedXPathAPI, since this is much quicker than default javax.xml.xpath.XPath implementations (Apache's anyway) for large XML files. This is because Apache's old XPathAPI class instantiated a new XPathContext (and thus building a new DTMManager, and new DTMs) each time it was called. XPathAPIObject instead retains its context as long as the object persists, reusing the DTMs. There was the question of whether to declare it here or just implement it in CustomXmlDataStoragePart (since this is mostly of value in binding the user's XML data file). It is here since otherwise BindingHandler would fail on DocPropsCoverPagePart and StandardisedAnswersPart (both of which extend JaxbCustomXmlDataStoragePart).

Specified by:

cachedXPathGetString in interface CustomXmlPart

Returns:

Throws:

Docx4JException

See Also:

• CustomXmlPart.discardCacheXPathObject()

xpathGetAsBoolean

public boolean xpathGetAsBoolean(String xpathB,
 String prefixMappings)
                          throws Docx4JException

Specified by:

xpathGetAsBoolean in interface CustomXmlPart

Throws:

Docx4JException

Since:

11.5.5

cachedXPathGetBoolean

public boolean cachedXPathGetBoolean(String xpath,
 String prefixMappings)
                              throws Docx4JException

Specified by:

cachedXPathGetBoolean in interface CustomXmlPart

Throws:

Docx4JException

discardCacheXPathObject

public void discardCacheXPathObject()

Description copied from interface: CustomXmlPart

Use this to null out the org.apache.xpath.CachedXPathAPI object, which you should do if you've changed your source document, or want to reclaim memory.

Specified by:

discardCacheXPathObject in interface CustomXmlPart

xpathGetNodes

public List<Node> xpathGetNodes(String xpathString,
 String prefixMappings)
                         throws Docx4JException

Specified by:

xpathGetNodes in interface CustomXmlPart

Throws:

Docx4JException

setNodeValueAtXPath

public boolean setNodeValueAtXPath(String xpath,
 String value,
 String prefixMappings)
                            throws Docx4JException

Specified by:

setNodeValueAtXPath in interface CustomXmlPart

Throws:

Docx4JException

getItemId

public String getItemId()

Specified by:

getItemId in interface CustomXmlPart

Since:

3.0.2

remove

public void remove()

Remove this part from the pkg. Beware: it is up to you to make sure your content doesn't rely on this part being present! A symptom of that would be that Office now reports your file to be corrupt or in need of repair.

Overrides:

remove in class Part

Since:

3.0.2

setXML

public void setXML(Document xmlDocument)
            throws Docx4JException

Description copied from interface: CustomXmlPart

Set the XML data

Specified by:

setXML in interface CustomXmlPart

Throws:

Docx4JException