Top Description Fields Constructors Methods
org.eclipse.persistence.internal.oxm

public Class UnmarshalXPathEngine<XML_FIELD extends Field>

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, org.eclipse.persistence.exceptions.XMLMarshalException, org.eclipse.persistence.internal.oxm.mappings.Field, org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy, .XMLNullRepresentationType, org.eclipse.persistence.oxm.record.XMLEntry, .XMLRecord, org.eclipse.persistence.platform.xml.XMLNamespaceResolver, .XMLNodeList, .XMLPlatform, .XMLPlatformFactory, org.w3c.dom.Attr, .Element, .Node, .NodeList

INTERNAL:

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

Since
Oracle TopLink 10.1.3

Field Summary

Modifier and TypeField and Description
private static UnmarshalXPathEngine<XML_FIELD extends Field>
private XMLPlatform

Constructor Summary

AccessConstructor and Description
public
UnmarshalXPathEngine()

The default constructor creates a platform instance

Method Summary

Modifier and TypeMethod and Description
private void
addXMLEntry(Node entryNode, XML_FIELD xmlField, List<XMLEntry> entries)

public static UnmarshalXPathEngine<XML_FIELD extends Field>
getInstance()

Return the XPathEngine singleton.

private NodeList
getNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean concatText)

private Node
getSingleNode(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)

private boolean
sameName(Node node, String name)

private boolean
sameNamespaceURI(Node node, String namespaceURI)

private NodeList
selectAllText(Node contextNode)

private NodeList
selectAttributeNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)

public NodeList
selectElementNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)

private NodeList
selectElementNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, int position)

public NodeList

Returns:

a list of nodes matching the XPath statement
selectNodes
(Node
the node relative to which the XPath statement will be executed
contextNode
,
XML_FIELD
the field containing the XPath statement to be executed
xmlField
,
XMLNamespaceResolver
used to resolve namespace prefixes to the corresponding namespace URI
xmlNamespaceResolver
)

Execute the XPath statement relative to the context node.

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

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

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

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

private void
selectNodes(Node contextNode, List<XPathFragment<XML_FIELD extends Field>> xpathFragments, XMLNamespaceResolver xmlNamespaceResolver, List<XMLEntry> entries)

private NodeList
selectNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean omitText, boolean concatText)

private Node
selectSingleAttribute(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)

private Node
selectSingleElement(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)

private Node
selectSingleElement(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, int position)

public Object

Returns:

the first node located matching the XPath statement
selectSingleNode
(Node
the node relative to which the XPath statement will be executed
contextNode
,
XML_FIELD
the field containing the XPath statement to be executed
xmlField
,
XMLNamespaceResolver
used to resolve namespace prefixes to the corresponding namespace URI
xmlNamespaceResolver
,
boolean checkForXsiNil)

Execute the XPath statement relative to the context node.

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

private Object
selectSingleNode(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, boolean checkForXsiNil)

private Node
selectSingleText(Node contextNode)

private NodeList
selectTextNodes(Node contextNode, AbstractNullPolicy nullPolicy, boolean concatText)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

instanceback to summary
private static UnmarshalXPathEngine<XML_FIELD extends Field> instance
xmlPlatformback to summary
private XMLPlatform xmlPlatform

Constructor Detail

UnmarshalXPathEngineback to summary
public UnmarshalXPathEngine()

The default constructor creates a platform instance

Method Detail

addXMLEntryback to summary
private void addXMLEntry(Node entryNode, XML_FIELD xmlField, List<XMLEntry> entries)
getInstanceback to summary
public static UnmarshalXPathEngine<XML_FIELD extends Field> getInstance()

Return the XPathEngine singleton.

getNodesback to summary
private NodeList getNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean concatText)
getSingleNodeback to summary
private Node getSingleNode(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)
sameNameback to summary
private boolean sameName(Node node, String name)
sameNamespaceURIback to summary
private boolean sameNamespaceURI(Node node, String namespaceURI)
selectAllTextback to summary
private NodeList selectAllText(Node contextNode)
selectAttributeNodesback to summary
private NodeList selectAttributeNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)
selectElementNodesback to summary
public NodeList selectElementNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)
selectElementNodesback to summary
private NodeList selectElementNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, int position)
selectNodesback to summary
public NodeList selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver) throws XMLMarshalException

Execute the XPath statement relative to the context node.

Parameters
contextNode:Node

the node relative to which the XPath statement will be executed

xmlField:XML_FIELD

the field containing the XPath statement to be executed

xmlNamespaceResolver:XMLNamespaceResolver

used to resolve namespace prefixes to the corresponding namespace URI

Returns:NodeList

a list of nodes matching the XPath statement

selectNodesback to summary
public NodeList selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy) throws XMLMarshalException
selectNodesback to summary
public NodeList selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean omitText) throws XMLMarshalException
selectNodesback to summary
public NodeList selectNodes(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean omitText, boolean concatinateTextNodes)
selectNodesback to summary
public List<XMLEntry> selectNodes(Node contextNode, List<XML_FIELD> xmlFields, XMLNamespaceResolver xmlNamespaceResolver) throws XMLMarshalException
selectNodesback to summary
private void selectNodes(Node contextNode, List<XPathFragment<XML_FIELD extends Field>> xpathFragments, XMLNamespaceResolver xmlNamespaceResolver, List<XMLEntry> entries)
selectNodesback to summary
private NodeList selectNodes(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, AbstractNullPolicy nullPolicy, boolean omitText, boolean concatText)
selectSingleAttributeback to summary
private Node selectSingleAttribute(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)
selectSingleElementback to summary
private Node selectSingleElement(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver)
selectSingleElementback to summary
private Node selectSingleElement(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, int position)
selectSingleNodeback to summary
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:Node

the node relative to which the XPath statement will be executed

xmlField:XML_FIELD

the field containing the XPath statement to be executed

xmlNamespaceResolver:XMLNamespaceResolver

used to resolve namespace prefixes to the corresponding namespace URI

Returns:Object

the first node located matching the XPath statement

selectSingleNodeback to summary
public Object selectSingleNode(Node contextNode, XML_FIELD xmlField, XMLNamespaceResolver xmlNamespaceResolver) throws XMLMarshalException
selectSingleNodeback to summary
private Object selectSingleNode(Node contextNode, XPathFragment<XML_FIELD extends Field> xPathFragment, XMLNamespaceResolver xmlNamespaceResolver, boolean checkForXsiNil)
selectSingleTextback to summary
private Node selectSingleText(Node contextNode)
selectTextNodesback to summary
private NodeList selectTextNodes(Node contextNode, AbstractNullPolicy nullPolicy, boolean concatText)