Package org.jaxen.dom4j

Class DocumentNavigator

java.lang.Object

org.jaxen.DefaultNavigator

org.jaxen.dom4j.DocumentNavigator

All Implemented Interfaces:

java.io.Serializable, org.jaxen.NamedAccessNavigator, org.jaxen.Navigator

public class DocumentNavigator
extends org.jaxen.DefaultNavigator
implements org.jaxen.NamedAccessNavigator

Interface for navigating around the DOM4J object model.

This class is not intended for direct usage, but is used by the Jaxen engine during evaluation.

Author:

bob mcwhirter, Stephen Colebourne

See Also:

XPath, Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentNavigator()

Method Summary

Modifier and Type	Method	Description
java.util.Iterator	getAttributeAxisIterator(java.lang.Object contextNode)
java.util.Iterator	getAttributeAxisIterator(java.lang.Object contextNode, java.lang.String localName, java.lang.String namespacePrefix, java.lang.String namespaceURI)	Retrieves an Iterator over the attribute elements that match the supplied name.
java.lang.String	getAttributeName(java.lang.Object obj)
java.lang.String	getAttributeNamespaceUri(java.lang.Object obj)
java.lang.String	getAttributeQName(java.lang.Object obj)
java.lang.String	getAttributeStringValue(java.lang.Object obj)
java.util.Iterator	getChildAxisIterator(java.lang.Object contextNode)
java.util.Iterator	getChildAxisIterator(java.lang.Object contextNode, java.lang.String localName, java.lang.String namespacePrefix, java.lang.String namespaceURI)	Retrieves an Iterator over the child elements that match the supplied name.
java.lang.String	getCommentStringValue(java.lang.Object obj)
java.lang.Object	getDocument(java.lang.String uri)
java.lang.Object	getDocumentNode(java.lang.Object contextNode)
java.lang.String	getElementName(java.lang.Object obj)
java.lang.String	getElementNamespaceUri(java.lang.Object obj)
java.lang.String	getElementQName(java.lang.Object obj)
java.lang.String	getElementStringValue(java.lang.Object obj)
static org.jaxen.Navigator	getInstance()	Retrieve the singleton instance of this DocumentNavigator.
java.util.Iterator	getNamespaceAxisIterator(java.lang.Object contextNode)
java.lang.String	getNamespacePrefix(java.lang.Object obj)
java.lang.String	getNamespaceStringValue(java.lang.Object obj)
short	getNodeType(java.lang.Object node)
java.util.Iterator	getParentAxisIterator(java.lang.Object contextNode)
java.lang.Object	getParentNode(java.lang.Object contextNode)
java.lang.String	getProcessingInstructionData(java.lang.Object obj)
java.lang.String	getProcessingInstructionTarget(java.lang.Object obj)
SAXReader	getSAXReader()
java.lang.String	getTextStringValue(java.lang.Object obj)
boolean	isAttribute(java.lang.Object obj)
boolean	isComment(java.lang.Object obj)
boolean	isDocument(java.lang.Object obj)
boolean	isElement(java.lang.Object obj)
boolean	isNamespace(java.lang.Object obj)
boolean	isProcessingInstruction(java.lang.Object obj)
boolean	isText(java.lang.Object obj)
org.jaxen.XPath	parseXPath(java.lang.String xpath)	Returns a parsed form of the given XPath string, which will be suitable for queries on DOM4J documents.
void	setSAXReader(SAXReader reader)
java.lang.String	translateNamespacePrefixToUri(java.lang.String prefix, java.lang.Object context)

Methods inherited from class org.jaxen.DefaultNavigator

getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getPrecedingAxisIterator, getPrecedingSiblingAxisIterator, getSelfAxisIterator

Methods inherited from interface org.jaxen.Navigator

getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getPrecedingAxisIterator, getPrecedingSiblingAxisIterator, getSelfAxisIterator

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentNavigator

public DocumentNavigator()

Method Detail

getInstance

public static org.jaxen.Navigator getInstance()

Retrieve the singleton instance of this DocumentNavigator.

isElement

public boolean isElement(java.lang.Object obj)

Specified by:

isElement in interface org.jaxen.Navigator

isComment

public boolean isComment(java.lang.Object obj)

Specified by:

isComment in interface org.jaxen.Navigator

isText

public boolean isText(java.lang.Object obj)

Specified by:

isText in interface org.jaxen.Navigator

isAttribute

public boolean isAttribute(java.lang.Object obj)

Specified by:

isAttribute in interface org.jaxen.Navigator

isProcessingInstruction

public boolean isProcessingInstruction(java.lang.Object obj)

Specified by:

isProcessingInstruction in interface org.jaxen.Navigator

isDocument

public boolean isDocument(java.lang.Object obj)

Specified by:

isDocument in interface org.jaxen.Navigator

isNamespace

public boolean isNamespace(java.lang.Object obj)

Specified by:

isNamespace in interface org.jaxen.Navigator

getElementName

public java.lang.String getElementName(java.lang.Object obj)

Specified by:

getElementName in interface org.jaxen.Navigator

getElementNamespaceUri

public java.lang.String getElementNamespaceUri(java.lang.Object obj)

Specified by:

getElementNamespaceUri in interface org.jaxen.Navigator

getElementQName

public java.lang.String getElementQName(java.lang.Object obj)

Specified by:

getElementQName in interface org.jaxen.Navigator

getAttributeName

public java.lang.String getAttributeName(java.lang.Object obj)

Specified by:

getAttributeName in interface org.jaxen.Navigator

getAttributeNamespaceUri

public java.lang.String getAttributeNamespaceUri(java.lang.Object obj)

Specified by:

getAttributeNamespaceUri in interface org.jaxen.Navigator

getAttributeQName

public java.lang.String getAttributeQName(java.lang.Object obj)

Specified by:

getAttributeQName in interface org.jaxen.Navigator

getChildAxisIterator

public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)

Specified by:

getChildAxisIterator in interface org.jaxen.Navigator

Overrides:

getChildAxisIterator in class org.jaxen.DefaultNavigator

getChildAxisIterator

public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode,
                                               java.lang.String localName,
                                               java.lang.String namespacePrefix,
                                               java.lang.String namespaceURI)

Retrieves an Iterator over the child elements that match the supplied name.

Specified by:

getChildAxisIterator in interface org.jaxen.NamedAccessNavigator

Parameters:

contextNode - the origin context node

localName - the local name of the children to return, always present

namespacePrefix - the prefix of the namespace of the children to return

namespaceURI - the uri of the namespace of the children to return

Returns:

an Iterator that traverses the named children, or null if none

getParentAxisIterator

public java.util.Iterator getParentAxisIterator(java.lang.Object contextNode)

Specified by:

getParentAxisIterator in interface org.jaxen.Navigator

Overrides:

getParentAxisIterator in class org.jaxen.DefaultNavigator

getAttributeAxisIterator

public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)

Specified by:

getAttributeAxisIterator in interface org.jaxen.Navigator

Overrides:

getAttributeAxisIterator in class org.jaxen.DefaultNavigator

getAttributeAxisIterator

public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode,
                                                   java.lang.String localName,
                                                   java.lang.String namespacePrefix,
                                                   java.lang.String namespaceURI)

Retrieves an Iterator over the attribute elements that match the supplied name.

Specified by:

getAttributeAxisIterator in interface org.jaxen.NamedAccessNavigator

Parameters:

contextNode - the origin context node

localName - the local name of the attributes to return, always present

namespacePrefix - the prefix of the namespace of the attributes to return

namespaceURI - the URI of the namespace of the attributes to return

Returns:

an Iterator that traverses the named attributes, not null

getNamespaceAxisIterator

public java.util.Iterator getNamespaceAxisIterator(java.lang.Object contextNode)

Specified by:

getNamespaceAxisIterator in interface org.jaxen.Navigator

Overrides:

getNamespaceAxisIterator in class org.jaxen.DefaultNavigator

getDocumentNode

public java.lang.Object getDocumentNode(java.lang.Object contextNode)

Specified by:

getDocumentNode in interface org.jaxen.Navigator

Overrides:

getDocumentNode in class org.jaxen.DefaultNavigator

parseXPath

public org.jaxen.XPath parseXPath(java.lang.String xpath)
                           throws org.jaxen.saxpath.SAXPathException

Returns a parsed form of the given XPath string, which will be suitable for queries on DOM4J documents.

Specified by:

parseXPath in interface org.jaxen.Navigator

Throws:

org.jaxen.saxpath.SAXPathException

getParentNode

public java.lang.Object getParentNode(java.lang.Object contextNode)

Specified by:

getParentNode in interface org.jaxen.Navigator

Overrides:

getParentNode in class org.jaxen.DefaultNavigator

getTextStringValue

public java.lang.String getTextStringValue(java.lang.Object obj)

Specified by:

getTextStringValue in interface org.jaxen.Navigator

getElementStringValue

public java.lang.String getElementStringValue(java.lang.Object obj)

Specified by:

getElementStringValue in interface org.jaxen.Navigator

getAttributeStringValue

public java.lang.String getAttributeStringValue(java.lang.Object obj)

Specified by:

getAttributeStringValue in interface org.jaxen.Navigator

getNamespaceStringValue

public java.lang.String getNamespaceStringValue(java.lang.Object obj)

Specified by:

getNamespaceStringValue in interface org.jaxen.Navigator

getNamespacePrefix

public java.lang.String getNamespacePrefix(java.lang.Object obj)

Specified by:

getNamespacePrefix in interface org.jaxen.Navigator

getCommentStringValue

public java.lang.String getCommentStringValue(java.lang.Object obj)

Specified by:

getCommentStringValue in interface org.jaxen.Navigator

translateNamespacePrefixToUri

public java.lang.String translateNamespacePrefixToUri(java.lang.String prefix,
                                                      java.lang.Object context)

Specified by:

translateNamespacePrefixToUri in interface org.jaxen.Navigator

Overrides:

translateNamespacePrefixToUri in class org.jaxen.DefaultNavigator

getNodeType

public short getNodeType(java.lang.Object node)

Specified by:

getNodeType in interface org.jaxen.Navigator

Overrides:

getNodeType in class org.jaxen.DefaultNavigator

getDocument

public java.lang.Object getDocument(java.lang.String uri)
                             throws org.jaxen.FunctionCallException

Specified by:

getDocument in interface org.jaxen.Navigator

Overrides:

getDocument in class org.jaxen.DefaultNavigator

Throws:

org.jaxen.FunctionCallException

getProcessingInstructionTarget

public java.lang.String getProcessingInstructionTarget(java.lang.Object obj)

Specified by:

getProcessingInstructionTarget in interface org.jaxen.Navigator

Overrides:

getProcessingInstructionTarget in class org.jaxen.DefaultNavigator

getProcessingInstructionData

public java.lang.String getProcessingInstructionData(java.lang.Object obj)

Specified by:

getProcessingInstructionData in interface org.jaxen.Navigator

Overrides:

getProcessingInstructionData in class org.jaxen.DefaultNavigator

getSAXReader

public SAXReader getSAXReader()

setSAXReader

public void setSAXReader(SAXReader reader)