Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.oxm

Class UnmarshalXPathEngine<XML_FIELD extends Field>

java.lang.Object

org.eclipse.persistence.internal.oxm.UnmarshalXPathEngine<XML_FIELD>

public class UnmarshalXPathEngine<XML_FIELD extends Field>
extends Object

INTERNAL:

Purpose: Utility class for finding XML nodes using XPath expressions.

Since:

Oracle TopLink 10.1.3

Constructor Summary

Constructors

Constructor	Description
UnmarshalXPathEngine()	The default constructor creates a platform instance

Method Summary

Modifier and Type	Method	Description
static UnmarshalXPathEngine	getInstance()	Return the XPathEngine singleton.
NodeList	selectElementNodes(Node contextNode, XPathFragment xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)
List<XMLEntry>	selectNodes(Node contextNode, List<XML_FIELD> xmlFields, XMLNamespaceResolver xmlNamespaceResolver)
NodeList	selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver)	Execute the XPath statement relative to the context node.
NodeList	selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy)
NodeList	selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean omitText)
NodeList	selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean omitText, boolean concatinateTextNodes)
Object	selectSingleNode(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver)
Object	selectSingleNode(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver, boolean checkForXsiNil)	Execute the XPath statement relative to the context node.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnmarshalXPathEngine

public UnmarshalXPathEngine()

The default constructor creates a platform instance

Method Detail

getInstance

public static UnmarshalXPathEngine getInstance()

Return the XPathEngine singleton.

selectSingleNode

public Object selectSingleNode(Node contextNode,
                               XML_FIELD xmlField,
                               XMLNamespaceResolver xmlNamespaceResolver,
                               boolean checkForXsiNil)
                        throws XMLMarshalException

Execute the XPath statement relative to the context node.

Parameters:

contextNode - the node relative to which the XPath statement will be executed

xmlField - the field containing the XPath statement to be executed

xmlNamespaceResolver - used to resolve namespace prefixes to the corresponding namespace URI

Returns:

the first node located matching the XPath statement

Throws:

XMLMarshalException

selectSingleNode

public Object selectSingleNode(Node contextNode,
                               XML_FIELD xmlField,
                               XMLNamespaceResolver xmlNamespaceResolver)
                        throws XMLMarshalException

Throws:

XMLMarshalException

selectNodes

public NodeList selectNodes(Node contextNode,
                            XML_FIELD xmlField,
                            XMLNamespaceResolver xmlNamespaceResolver)
                     throws XMLMarshalException

Execute the XPath statement relative to the context node.

Parameters:

contextNode - the node relative to which the XPath statement will be executed

xmlField - the field containing the XPath statement to be executed

xmlNamespaceResolver - used to resolve namespace prefixes to the corresponding namespace URI

Returns:

a list of nodes matching the XPath statement

Throws:

XMLMarshalException

selectNodes

public NodeList selectNodes(Node contextNode,
                            XML_FIELD xmlField,
                            XMLNamespaceResolver xmlNamespaceResolver,
                            AbstractNullPolicy nullPolicy)
                     throws XMLMarshalException

Throws:

XMLMarshalException

selectNodes

public NodeList selectNodes(Node contextNode,
                            XML_FIELD xmlField,
                            XMLNamespaceResolver xmlNamespaceResolver,
                            AbstractNullPolicy nullPolicy,
                            boolean omitText)
                     throws XMLMarshalException

Throws:

XMLMarshalException

selectNodes

public NodeList selectNodes(Node contextNode,
                            XML_FIELD xmlField,
                            XMLNamespaceResolver xmlNamespaceResolver,
                            AbstractNullPolicy nullPolicy,
                            boolean omitText,
                            boolean concatinateTextNodes)

selectNodes

public List<XMLEntry> selectNodes(Node contextNode,
                                  List<XML_FIELD> xmlFields,
                                  XMLNamespaceResolver xmlNamespaceResolver)
                           throws XMLMarshalException

Throws:

XMLMarshalException

selectElementNodes

public NodeList selectElementNodes(Node contextNode,
                                   XPathFragment xPathFragment,
                                   XMLNamespaceResolver xmlNamespaceResolver)