org.xmlfield.core.api

Interface XmlFieldSelector

All Known Implementing Classes:

DomJaxenSelector, DomXalanSelector

public interface XmlFieldSelector

The XPath selector interface used to select xpath expression on an xml field node.

Author:

Guillaume Mary

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	selectXPathToBoolean(NamespaceMap namespaces, String xpath, XmlFieldNode node) Select xpath expression to an xml field node and return the result as a boolean.
XmlFieldNode	selectXPathToNode(NamespaceMap namespaces, String xpath, XmlFieldNode node) Select xpath expression to an xml field node and return the result as an xml field node.
XmlFieldNodeList	selectXPathToNodeList(NamespaceMap namespaces, String xpath, XmlFieldNode node) Select xpath expression to an xml field node and return the result as an xml field node list.
Double	selectXPathToNumber(NamespaceMap namespaces, String xpath, XmlFieldNode node) Select xpath expression to an xml field node and return the result as a double.
String	selectXPathToString(NamespaceMap namespaces, String xpath, XmlFieldNode node) Select xpath expression to an xml field node and return the result as a string.

Method Detail

selectXPathToBoolean

Boolean selectXPathToBoolean(NamespaceMap namespaces,
                           String xpath,
                           XmlFieldNode node)
                             throws XmlFieldXPathException

Select xpath expression to an xml field node and return the result as a boolean.

Parameters:

namespaces - xml namespaces

xpath - xpath expression

node - xml field node

Returns:

result of the xpath evaluation

Throws:

XmlFieldXPathException - exception thrown when the xpath evaluation failed

selectXPathToNode

XmlFieldNode selectXPathToNode(NamespaceMap namespaces,
                             String xpath,
                             XmlFieldNode node)
                               throws XmlFieldXPathException

Select xpath expression to an xml field node and return the result as an xml field node.

Parameters:

namespaces - xml namespaces

xpath - xpath expression

node - xml field node

Returns:

result of the xpath evaluation

Throws:

XmlFieldXPathException - exception thrown when the xpath evaluation failed

selectXPathToNodeList

XmlFieldNodeList selectXPathToNodeList(NamespaceMap namespaces,
                                     String xpath,
                                     XmlFieldNode node)
                                       throws XmlFieldXPathException

Select xpath expression to an xml field node and return the result as an xml field node list.

Parameters:

namespaces - xml namespaces

xpath - xpath expression

node - xml field node

Returns:

result of the xpath evaluation

Throws:

XmlFieldXPathException - exception thrown when the xpath evaluation failed

selectXPathToNumber

Double selectXPathToNumber(NamespaceMap namespaces,
                         String xpath,
                         XmlFieldNode node)
                           throws XmlFieldXPathException

Select xpath expression to an xml field node and return the result as a double.

Parameters:

namespaces - xml namespaces

xpath - xpath expression

node - xml field node

Returns:

result of the xpath evaluation

Throws:

XmlFieldXPathException - exception thrown when the xpath evaluation failed

selectXPathToString

String selectXPathToString(NamespaceMap namespaces,
                         String xpath,
                         XmlFieldNode node)
                           throws XmlFieldXPathException

Select xpath expression to an xml field node and return the result as a string.

Parameters:

namespaces - xml namespaces

xpath - xpath expression

node - xml field node

Returns:

result of the xpath evaluation

Throws:

XmlFieldXPathException - exception thrown when the xpath evaluation failed