Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: xml :: xpath ::

interface XXPathAPI

Methods' Summary
registerNS  
unregisterNS  
registerExtension  
registerExtensionInstance  
eval Eval XPath Expression.  
evalNS Eval XPath Expression.  
selectNodeList Evaluate an XPath expression to select a list of nodes.  
selectNodeListNS Evaluate an XPath expression to select a list of nodes.  
selectSingleNode Evaluate an XPath expression to select a single node.  
selectSingleNodeNS Evaluate an XPath expression to select a single node.  
Methods' Details
registerNS
void
registerNS( [in] string  prefix,
[in] string  url );

unregisterNS
void
unregisterNS( [in] string  prefix,
[in] string  url );

registerExtension
void
registerExtension( [in] string  serviceName );

registerExtensionInstance
void
registerExtensionInstance( [in] XXPathExtension  aExtension );

eval
XXPathObject
eval( [in] ::com::sun::star::xml::dom::XNode  contextNode,
[in] string  expr )
raises( XPathException );

Description
Eval XPath Expression.
Parameter contextNode
the context node (expression is relative to this node)
Parameter expr
the XPath expression
Throws
XPathException if the expression is malformed, or evaluation fails
Returns
an object representing the result of the XPath evaluation
See also
XXPathObject
evalNS
XXPathObject
evalNS( [in] ::com::sun::star::xml::dom::XNode  contextNode,
[in] string  expr,
[in] ::com::sun::star::xml::dom::XNode  namespaceNode )
raises( XPathException );

Description
Eval XPath Expression.
Parameter contextNode
the context node (expression is relative to this node)
Parameter expr
the XPath expression
Parameter namespaceNode
all namespaces declared on this node will be registered
Throws
XPathException if the expression is malformed, or evaluation fails
Returns
an object representing the result of the XPath evaluation
See also
XXPathObject
selectNodeList
::com::sun::star::xml::dom::XNodeList
selectNodeList( [in] ::com::sun::star::xml::dom::XNode  contextNode,
[in] string  expr )
raises( XPathException );

Description
Evaluate an XPath expression to select a list of nodes.
Parameter contextNode
the context node (expression is relative to this node)
Parameter expr
the XPath expression
Throws
XPathException if the expression is malformed, or evaluation fails
Returns
result of the XPath evaluation: a list of nodes
See also
XNodeList
selectNodeListNS
::com::sun::star::xml::dom::XNodeList
selectNodeListNS( [in] ::com::sun::star::xml::dom::XNode  contextNode,
[in] string  str,
[in] ::com::sun::star::xml::dom::XNode  namespaceNode )
raises( XPathException );

Description
Evaluate an XPath expression to select a list of nodes.
Parameter contextNode
the context node (expression is relative to this node)
Parameter expr
the XPath expression
Parameter namespaceNode
all namespaces declared on this node will be registered
Throws
XPathException if the expression is malformed, or evaluation fails
Returns
result of the XPath evaluation: a list of nodes
See also
XNodeList
selectSingleNode
::com::sun::star::xml::dom::XNode
selectSingleNode( [in] ::com::sun::star::xml::dom::XNode  contextNode,
[in] string  expr )
raises( XPathException );

Description
Evaluate an XPath expression to select a single node.
Parameter contextNode
the context node (expression is relative to this node)
Parameter expr
the XPath expression
Throws
XPathException if the expression is malformed, or evaluation fails
Returns
result of the XPath evaluation: a single node
selectSingleNodeNS
::com::sun::star::xml::dom::XNode
selectSingleNodeNS( [in] ::com::sun::star::xml::dom::XNode  contextNode,
[in] string  str,
[in] ::com::sun::star::xml::dom::XNode  namespaceNode )
raises( XPathException );

Description
Evaluate an XPath expression to select a single node.
Parameter contextNode
the context node (expression is relative to this node)
Parameter expr
the XPath expression
Parameter namespaceNode
all namespaces declared on this node will be registered
Throws
XPathException if the expression is malformed, or evaluation fails
Returns
result of the XPath evaluation: a single node
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.