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
All Methods Static Methods Instance Methods Concrete Methods 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 anIterator
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 anIterator
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 thisDocumentNavigator
.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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jaxen.Navigator
getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getPrecedingAxisIterator, getPrecedingSiblingAxisIterator, getSelfAxisIterator
-
-
-
-
Method Detail
-
getInstance
public static org.jaxen.Navigator getInstance()
Retrieve the singleton instance of thisDocumentNavigator
.
-
isElement
public boolean isElement(java.lang.Object obj)
- Specified by:
isElement
in interfaceorg.jaxen.Navigator
-
isComment
public boolean isComment(java.lang.Object obj)
- Specified by:
isComment
in interfaceorg.jaxen.Navigator
-
isText
public boolean isText(java.lang.Object obj)
- Specified by:
isText
in interfaceorg.jaxen.Navigator
-
isAttribute
public boolean isAttribute(java.lang.Object obj)
- Specified by:
isAttribute
in interfaceorg.jaxen.Navigator
-
isProcessingInstruction
public boolean isProcessingInstruction(java.lang.Object obj)
- Specified by:
isProcessingInstruction
in interfaceorg.jaxen.Navigator
-
isDocument
public boolean isDocument(java.lang.Object obj)
- Specified by:
isDocument
in interfaceorg.jaxen.Navigator
-
isNamespace
public boolean isNamespace(java.lang.Object obj)
- Specified by:
isNamespace
in interfaceorg.jaxen.Navigator
-
getElementName
public java.lang.String getElementName(java.lang.Object obj)
- Specified by:
getElementName
in interfaceorg.jaxen.Navigator
-
getElementNamespaceUri
public java.lang.String getElementNamespaceUri(java.lang.Object obj)
- Specified by:
getElementNamespaceUri
in interfaceorg.jaxen.Navigator
-
getElementQName
public java.lang.String getElementQName(java.lang.Object obj)
- Specified by:
getElementQName
in interfaceorg.jaxen.Navigator
-
getAttributeName
public java.lang.String getAttributeName(java.lang.Object obj)
- Specified by:
getAttributeName
in interfaceorg.jaxen.Navigator
-
getAttributeNamespaceUri
public java.lang.String getAttributeNamespaceUri(java.lang.Object obj)
- Specified by:
getAttributeNamespaceUri
in interfaceorg.jaxen.Navigator
-
getAttributeQName
public java.lang.String getAttributeQName(java.lang.Object obj)
- Specified by:
getAttributeQName
in interfaceorg.jaxen.Navigator
-
getChildAxisIterator
public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)
- Specified by:
getChildAxisIterator
in interfaceorg.jaxen.Navigator
- Overrides:
getChildAxisIterator
in classorg.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 anIterator
over the child elements that match the supplied name.- Specified by:
getChildAxisIterator
in interfaceorg.jaxen.NamedAccessNavigator
- Parameters:
contextNode
- the origin context nodelocalName
- the local name of the children to return, always presentnamespacePrefix
- the prefix of the namespace of the children to returnnamespaceURI
- 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 interfaceorg.jaxen.Navigator
- Overrides:
getParentAxisIterator
in classorg.jaxen.DefaultNavigator
-
getAttributeAxisIterator
public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)
- Specified by:
getAttributeAxisIterator
in interfaceorg.jaxen.Navigator
- Overrides:
getAttributeAxisIterator
in classorg.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 anIterator
over the attribute elements that match the supplied name.- Specified by:
getAttributeAxisIterator
in interfaceorg.jaxen.NamedAccessNavigator
- Parameters:
contextNode
- the origin context nodelocalName
- the local name of the attributes to return, always presentnamespacePrefix
- the prefix of the namespace of the attributes to returnnamespaceURI
- 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 interfaceorg.jaxen.Navigator
- Overrides:
getNamespaceAxisIterator
in classorg.jaxen.DefaultNavigator
-
getDocumentNode
public java.lang.Object getDocumentNode(java.lang.Object contextNode)
- Specified by:
getDocumentNode
in interfaceorg.jaxen.Navigator
- Overrides:
getDocumentNode
in classorg.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 interfaceorg.jaxen.Navigator
- Throws:
org.jaxen.saxpath.SAXPathException
-
getParentNode
public java.lang.Object getParentNode(java.lang.Object contextNode)
- Specified by:
getParentNode
in interfaceorg.jaxen.Navigator
- Overrides:
getParentNode
in classorg.jaxen.DefaultNavigator
-
getTextStringValue
public java.lang.String getTextStringValue(java.lang.Object obj)
- Specified by:
getTextStringValue
in interfaceorg.jaxen.Navigator
-
getElementStringValue
public java.lang.String getElementStringValue(java.lang.Object obj)
- Specified by:
getElementStringValue
in interfaceorg.jaxen.Navigator
-
getAttributeStringValue
public java.lang.String getAttributeStringValue(java.lang.Object obj)
- Specified by:
getAttributeStringValue
in interfaceorg.jaxen.Navigator
-
getNamespaceStringValue
public java.lang.String getNamespaceStringValue(java.lang.Object obj)
- Specified by:
getNamespaceStringValue
in interfaceorg.jaxen.Navigator
-
getNamespacePrefix
public java.lang.String getNamespacePrefix(java.lang.Object obj)
- Specified by:
getNamespacePrefix
in interfaceorg.jaxen.Navigator
-
getCommentStringValue
public java.lang.String getCommentStringValue(java.lang.Object obj)
- Specified by:
getCommentStringValue
in interfaceorg.jaxen.Navigator
-
translateNamespacePrefixToUri
public java.lang.String translateNamespacePrefixToUri(java.lang.String prefix, java.lang.Object context)
- Specified by:
translateNamespacePrefixToUri
in interfaceorg.jaxen.Navigator
- Overrides:
translateNamespacePrefixToUri
in classorg.jaxen.DefaultNavigator
-
getNodeType
public short getNodeType(java.lang.Object node)
- Specified by:
getNodeType
in interfaceorg.jaxen.Navigator
- Overrides:
getNodeType
in classorg.jaxen.DefaultNavigator
-
getDocument
public java.lang.Object getDocument(java.lang.String uri) throws org.jaxen.FunctionCallException
- Specified by:
getDocument
in interfaceorg.jaxen.Navigator
- Overrides:
getDocument
in classorg.jaxen.DefaultNavigator
- Throws:
org.jaxen.FunctionCallException
-
getProcessingInstructionTarget
public java.lang.String getProcessingInstructionTarget(java.lang.Object obj)
- Specified by:
getProcessingInstructionTarget
in interfaceorg.jaxen.Navigator
- Overrides:
getProcessingInstructionTarget
in classorg.jaxen.DefaultNavigator
-
getProcessingInstructionData
public java.lang.String getProcessingInstructionData(java.lang.Object obj)
- Specified by:
getProcessingInstructionData
in interfaceorg.jaxen.Navigator
- Overrides:
getProcessingInstructionData
in classorg.jaxen.DefaultNavigator
-
getSAXReader
public SAXReader getSAXReader()
-
setSAXReader
public void setSAXReader(SAXReader reader)
-
-