com.aspose.words

Class XmlMapping

java.lang.Object

com.aspose.words.XmlMapping

All Implemented Interfaces:

java.lang.Cloneable

public class XmlMapping
extends java.lang.Object
implements java.lang.Cloneable

Specifies the information that is used to establish a mapping between the parent structured document tag and an XML element stored within a custom XML data part in the document.

To learn more, visit the Structured Document Tags or Content Control documentation article.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes mapping of the parent structured document to XML data.
CustomXmlPart	getCustomXmlPart() Returns the custom XML data part to which the parent structured document tag is mapped.
java.lang.String	getPrefixMappings() Returns XML namespace prefix mappings to evaluate the getXPath().
java.lang.String	getStoreItemId() Specifies the custom XML data identifier for the custom XML data part which shall be used to evaluate the getXPath() expression.
java.lang.String	getXPath() Returns the XPath expression, which is evaluated to find the custom XML node that is mapped to the parent structured document tag.
boolean	isMapped() Returns true if the parent structured document tag is successfully mapped to XML data.
protected java.lang.Object	memberwiseClone()
boolean	setMapping(CustomXmlPart customXmlPart, java.lang.String xPath, java.lang.String prefixMapping) Sets a mapping between the parent structured document tag and an XML node of a custom XML data part.

Methods inherited from class java.lang.Object

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

Method Detail

setMapping

public boolean setMapping(CustomXmlPart customXmlPart,
                          java.lang.String xPath,
                          java.lang.String prefixMapping)
                   throws java.lang.Exception

Sets a mapping between the parent structured document tag and an XML node of a custom XML data part.

Parameters:

customXmlPart - A custom XML data part to map to.

xPath - An XPath expression to find the XML node.

prefixMapping - XML namespace prefix mappings to evaluate the XPath.

Returns:

A flag indicating whether the parent structured document tag is successfully mapped to the XML node.

Throws:

java.lang.Exception

delete

public void delete()

Deletes mapping of the parent structured document to XML data.

getPrefixMappings

public java.lang.String getPrefixMappings()

Returns XML namespace prefix mappings to evaluate the getXPath(). Specifies the set of prefix mappings, which shall be used to interpret the XPath expression when the XPath expression is evaluated against the custom XML data parts in the document.

Returns:

XML namespace prefix mappings to evaluate the getXPath().

getXPath

public java.lang.String getXPath()

Returns the XPath expression, which is evaluated to find the custom XML node that is mapped to the parent structured document tag.

Returns:

The XPath expression, which is evaluated to find the custom XML node that is mapped to the parent structured document tag.

getCustomXmlPart

public CustomXmlPart getCustomXmlPart()

Returns the custom XML data part to which the parent structured document tag is mapped.

Returns:

The custom XML data part to which the parent structured document tag is mapped.

isMapped

public boolean isMapped()
                 throws java.lang.Exception

Returns true if the parent structured document tag is successfully mapped to XML data.

Returns:

true if the parent structured document tag is successfully mapped to XML data.

Throws:

java.lang.Exception

getStoreItemId

public java.lang.String getStoreItemId()

Specifies the custom XML data identifier for the custom XML data part which shall be used to evaluate the getXPath() expression.

Returns:

The corresponding String value.

memberwiseClone

protected java.lang.Object memberwiseClone()