Package org.jaxen.jdom
Class DocumentNavigator
- java.lang.Object
-
- org.jaxen.DefaultNavigator
-
- org.jaxen.jdom.DocumentNavigator
-
- All Implemented Interfaces:
java.io.Serializable
,NamedAccessNavigator
,Navigator
public class DocumentNavigator extends DefaultNavigator implements NamedAccessNavigator
Interface for navigating around the JDOM 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)
Retrieve anIterator
matching theattribute
XPath axis.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)
Retrieve the local name of the given attribute node.java.lang.String
getAttributeNamespaceUri(java.lang.Object obj)
Retrieve the namespace URI of the given attribute node.java.lang.String
getAttributeQName(java.lang.Object obj)
Retrieve the qualified name of the given attribute node.java.lang.String
getAttributeStringValue(java.lang.Object obj)
Retrieve the string-value of an attribute node.java.util.Iterator
getChildAxisIterator(java.lang.Object contextNode)
ThrowsUnsupportedAxisException
.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 local name and namespace URI.java.lang.String
getCommentStringValue(java.lang.Object obj)
Retrieve the string-value of a comment node.java.lang.Object
getDocument(java.lang.String url)
Default implementation that always returns null.java.lang.Object
getDocumentNode(java.lang.Object contextNode)
Returns null.java.lang.String
getElementName(java.lang.Object obj)
Retrieve the local name of the given element node.java.lang.String
getElementNamespaceUri(java.lang.Object obj)
Retrieve the namespace URI of the given element node.java.lang.String
getElementQName(java.lang.Object obj)
Retrieve the qualified name of the given element node.java.lang.String
getElementStringValue(java.lang.Object obj)
Retrieve the string-value of an element node.static Navigator
getInstance()
java.util.Iterator
getNamespaceAxisIterator(java.lang.Object contextNode)
ThrowsUnsupportedAxisException
.java.lang.String
getNamespacePrefix(java.lang.Object obj)
Retrieve the namespace prefix of a namespace node.java.lang.String
getNamespaceStringValue(java.lang.Object obj)
Retrieve the string-value of a namespace node.java.util.Iterator
getParentAxisIterator(java.lang.Object contextNode)
ThrowsUnsupportedAxisException
.java.lang.String
getProcessingInstructionData(java.lang.Object obj)
Returns null.java.lang.String
getProcessingInstructionTarget(java.lang.Object obj)
Returns null.java.lang.String
getTextStringValue(java.lang.Object obj)
Retrieve the string-value of a text node.boolean
isAttribute(java.lang.Object obj)
Returns whether the given object is an attribute node.boolean
isComment(java.lang.Object obj)
Returns whether the given object is a comment node.boolean
isDocument(java.lang.Object obj)
Returns whether the given object is a document node.boolean
isElement(java.lang.Object obj)
Returns whether the given object is an element node.boolean
isNamespace(java.lang.Object obj)
Returns whether the given object is a namespace node.boolean
isProcessingInstruction(java.lang.Object obj)
Returns whether the given object is a processing-instruction node.boolean
isText(java.lang.Object obj)
Returns whether the given object is a text node.XPath
parseXPath(java.lang.String xpath)
Returns a parsed form of the given XPath string, which will be suitable for queries on JDOM documents.java.lang.String
translateNamespacePrefixToUri(java.lang.String prefix, java.lang.Object context)
Returns null.-
Methods inherited from class org.jaxen.DefaultNavigator
getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getNodeType, getParentNode, 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, getNodeType, getParentNode, getPrecedingAxisIterator, getPrecedingSiblingAxisIterator, getSelfAxisIterator
-
-
-
-
Method Detail
-
getInstance
public static Navigator getInstance()
-
isElement
public boolean isElement(java.lang.Object obj)
Description copied from interface:Navigator
Returns whether the given object is an element node.
-
isComment
public boolean isComment(java.lang.Object obj)
Description copied from interface:Navigator
Returns whether the given object is a comment node.
-
isText
public boolean isText(java.lang.Object obj)
Description copied from interface:Navigator
Returns whether the given object is a text node.
-
isAttribute
public boolean isAttribute(java.lang.Object obj)
Description copied from interface:Navigator
Returns whether the given object is an attribute node.- Specified by:
isAttribute
in interfaceNavigator
- Parameters:
obj
- the object to test- Returns:
true
if the object is an attribute node, elsefalse
-
isProcessingInstruction
public boolean isProcessingInstruction(java.lang.Object obj)
Description copied from interface:Navigator
Returns whether the given object is a processing-instruction node.- Specified by:
isProcessingInstruction
in interfaceNavigator
- Parameters:
obj
- the object to test- Returns:
true
if the object is a processing-instruction node, elsefalse
-
isDocument
public boolean isDocument(java.lang.Object obj)
Description copied from interface:Navigator
Returns whether the given object is a document node. A document node is the node that is selected by the XPath expression/
.- Specified by:
isDocument
in interfaceNavigator
- Parameters:
obj
- the object to test- Returns:
true
if the object is a document node, elsefalse
-
isNamespace
public boolean isNamespace(java.lang.Object obj)
Description copied from interface:Navigator
Returns whether the given object is a namespace node.- Specified by:
isNamespace
in interfaceNavigator
- Parameters:
obj
- the object to test- Returns:
true
if the object is a namespace node, elsefalse
-
getElementName
public java.lang.String getElementName(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the local name of the given element node.- Specified by:
getElementName
in interfaceNavigator
- Parameters:
obj
- the context element node- Returns:
- the local name of the element node
-
getElementNamespaceUri
public java.lang.String getElementNamespaceUri(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the namespace URI of the given element node.- Specified by:
getElementNamespaceUri
in interfaceNavigator
- Parameters:
obj
- the context element node- Returns:
- the namespace URI of the element node
-
getAttributeName
public java.lang.String getAttributeName(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the local name of the given attribute node.- Specified by:
getAttributeName
in interfaceNavigator
- Parameters:
obj
- the context attribute node- Returns:
- the local name of the attribute node
-
getAttributeNamespaceUri
public java.lang.String getAttributeNamespaceUri(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the namespace URI of the given attribute node.- Specified by:
getAttributeNamespaceUri
in interfaceNavigator
- Parameters:
obj
- the context attribute node- Returns:
- the namespace URI of the attribute node
-
getChildAxisIterator
public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)
Description copied from class:DefaultNavigator
ThrowsUnsupportedAxisException
. Subclasses should override this method.- Specified by:
getChildAxisIterator
in interfaceNavigator
- Overrides:
getChildAxisIterator
in classDefaultNavigator
- Parameters:
contextNode
- the node to start from- Returns:
- never returns
-
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 local name and namespace URI.- Specified by:
getChildAxisIterator
in interfaceNamedAccessNavigator
- Parameters:
contextNode
- the origin context nodelocalName
- the local name of the children to return, always presentnamespacePrefix
- ignored; prefixes are not used when matching in XPathnamespaceURI
- the URI of the namespace of the children to return- Returns:
- an Iterator that traverses the named children, or null if none
-
getNamespaceAxisIterator
public java.util.Iterator getNamespaceAxisIterator(java.lang.Object contextNode)
Description copied from class:DefaultNavigator
ThrowsUnsupportedAxisException
. Subclasses that support the namespace axis must override this method.- Specified by:
getNamespaceAxisIterator
in interfaceNavigator
- Overrides:
getNamespaceAxisIterator
in classDefaultNavigator
- Parameters:
contextNode
- the node to start from- Returns:
- never returns
-
getParentAxisIterator
public java.util.Iterator getParentAxisIterator(java.lang.Object contextNode)
Description copied from class:DefaultNavigator
ThrowsUnsupportedAxisException
. Subclasses should override this method.- Specified by:
getParentAxisIterator
in interfaceNavigator
- Overrides:
getParentAxisIterator
in classDefaultNavigator
- Parameters:
contextNode
- the node to start from- Returns:
- never returns
-
getAttributeAxisIterator
public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)
Description copied from class:DefaultNavigator
Retrieve anIterator
matching theattribute
XPath axis.- Specified by:
getAttributeAxisIterator
in interfaceNavigator
- Overrides:
getAttributeAxisIterator
in classDefaultNavigator
- Parameters:
contextNode
- the original context node- Returns:
- an Iterator capable of traversing the axis, not null
-
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 interfaceNamedAccessNavigator
- 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
-
parseXPath
public XPath parseXPath(java.lang.String xpath) throws SAXPathException
Returns a parsed form of the given XPath string, which will be suitable for queries on JDOM documents.- Specified by:
parseXPath
in interfaceNavigator
- Parameters:
xpath
- the XPath expression- Returns:
- a new XPath expression object
- Throws:
SAXPathException
- if the string is not a syntactically correct XPath expression- See Also:
XPath
-
getDocumentNode
public java.lang.Object getDocumentNode(java.lang.Object contextNode)
Description copied from class:DefaultNavigator
Returns null.- Specified by:
getDocumentNode
in interfaceNavigator
- Overrides:
getDocumentNode
in classDefaultNavigator
- Parameters:
contextNode
- the node to start from- Returns:
- null
- See Also:
Navigator.isDocument(Object)
-
getElementQName
public java.lang.String getElementQName(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the qualified name of the given element node.- Specified by:
getElementQName
in interfaceNavigator
- Parameters:
obj
- the context element node- Returns:
- the qualified name of the element node
-
getAttributeQName
public java.lang.String getAttributeQName(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the qualified name of the given attribute node.- Specified by:
getAttributeQName
in interfaceNavigator
- Parameters:
obj
- the context attribute node- Returns:
- the qualified name of the attribute node
-
getNamespaceStringValue
public java.lang.String getNamespaceStringValue(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the string-value of a namespace node. This is generally the namespace URI. This may be the empty string but must not be null.- Specified by:
getNamespaceStringValue
in interfaceNavigator
- Parameters:
obj
- the namespace node- Returns:
- the string-value of the node
-
getNamespacePrefix
public java.lang.String getNamespacePrefix(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the namespace prefix of a namespace node.- Specified by:
getNamespacePrefix
in interfaceNavigator
- Parameters:
obj
- the namespace node- Returns:
- the prefix associated with the node
-
getTextStringValue
public java.lang.String getTextStringValue(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the string-value of a text node. This must not be null and should not be the empty string. The XPath data model does not allow empty text nodes.- Specified by:
getTextStringValue
in interfaceNavigator
- Parameters:
obj
- the text node- Returns:
- the string-value of the node
-
getAttributeStringValue
public java.lang.String getAttributeStringValue(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the string-value of an attribute node. This should be the XML 1.0 normalized attribute value. This may be the empty string but must not be null.- Specified by:
getAttributeStringValue
in interfaceNavigator
- Parameters:
obj
- the attribute node- Returns:
- the string-value of the node
-
getElementStringValue
public java.lang.String getElementStringValue(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the string-value of an element node. This may be the empty string if the element is empty, but must not be null.- Specified by:
getElementStringValue
in interfaceNavigator
- Parameters:
obj
- the comment node.- Returns:
- the string-value of the node.
-
getProcessingInstructionTarget
public java.lang.String getProcessingInstructionTarget(java.lang.Object obj)
Description copied from class:DefaultNavigator
Returns null.- Specified by:
getProcessingInstructionTarget
in interfaceNavigator
- Overrides:
getProcessingInstructionTarget
in classDefaultNavigator
- Parameters:
obj
- the node to start from- Returns:
- null
-
getProcessingInstructionData
public java.lang.String getProcessingInstructionData(java.lang.Object obj)
Description copied from class:DefaultNavigator
Returns null.- Specified by:
getProcessingInstructionData
in interfaceNavigator
- Overrides:
getProcessingInstructionData
in classDefaultNavigator
- Parameters:
obj
- the node to start from- Returns:
- null
-
getCommentStringValue
public java.lang.String getCommentStringValue(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the string-value of a comment node. This may be the empty string if the comment is empty, but must not be null.- Specified by:
getCommentStringValue
in interfaceNavigator
- Parameters:
obj
- the comment node- Returns:
- the string-value of the node
-
translateNamespacePrefixToUri
public java.lang.String translateNamespacePrefixToUri(java.lang.String prefix, java.lang.Object context)
Description copied from class:DefaultNavigator
Returns null.- Specified by:
translateNamespacePrefixToUri
in interfaceNavigator
- Overrides:
translateNamespacePrefixToUri
in classDefaultNavigator
- Parameters:
prefix
- the prefix to translatecontext
- the node to start from- Returns:
- null
- See Also:
NamespaceContext
-
getDocument
public java.lang.Object getDocument(java.lang.String url) throws FunctionCallException
Description copied from class:DefaultNavigator
Default implementation that always returns null. Override in subclass if the subclass can load documents.- Specified by:
getDocument
in interfaceNavigator
- Overrides:
getDocument
in classDefaultNavigator
- Parameters:
url
- the URL of the document to load- Returns:
- null
- Throws:
FunctionCallException
- if an error occurs while loading the URL; e.g. an I/O error or the document is malformed
-
-