public class DocumentNavigator extends DefaultNavigator
This class is not intended for direct usage, but is used by the Jaxen engine during evaluation.
XPath
,
Serialized FormConstructor and Description |
---|
DocumentNavigator() |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator |
getAttributeAxisIterator(java.lang.Object o)
Throws
UnsupportedAxisException . |
java.lang.String |
getAttributeName(java.lang.Object o)
Retrieve the local name of the given attribute node.
|
java.lang.String |
getAttributeNamespaceUri(java.lang.Object o)
Retrieve the namespace URI of the given attribute node.
|
java.lang.String |
getAttributeQName(java.lang.Object o)
Retrieve the qualified name of the given attribute node.
|
java.lang.String |
getAttributeStringValue(java.lang.Object o)
Retrieve the string-value of an attribute node.
|
java.util.Iterator |
getChildAxisIterator(java.lang.Object o)
Throws
UnsupportedAxisException |
java.lang.String |
getCommentStringValue(java.lang.Object o)
Retrieve the string-value of a comment node.
|
java.lang.Object |
getDocument(java.lang.String s)
Default implementation that always returns null.
|
java.lang.Object |
getDocumentNode(java.lang.Object o)
Returns the document node that contains the given context node.
|
java.lang.String |
getElementName(java.lang.Object o)
Retrieve the local name of the given element node.
|
java.lang.String |
getElementNamespaceUri(java.lang.Object o)
Retrieve the namespace URI of the given element node.
|
java.lang.String |
getElementQName(java.lang.Object o)
Retrieve the qualified name of the given element node.
|
java.lang.String |
getElementStringValue(java.lang.Object o)
Retrieve the string-value of an element node.
|
java.util.Iterator |
getNamespaceAxisIterator(java.lang.Object o)
Throws
UnsupportedAxisException . |
java.lang.String |
getNamespacePrefix(java.lang.Object o)
Retrieve the namespace prefix of a namespace node.
|
java.lang.String |
getNamespaceStringValue(java.lang.Object o)
Retrieve the string-value of a namespace node.
|
java.util.Iterator |
getParentAxisIterator(java.lang.Object o)
Throws
UnsupportedAxisException |
java.lang.Object |
getParentNode(java.lang.Object o)
Default inefficient implementation.
|
java.util.Iterator |
getPrecedingAxisIterator(java.lang.Object o)
Retrieve an
Iterator matching the preceding XPath axis. |
java.util.Iterator |
getPrecedingSiblingAxisIterator(java.lang.Object o)
Retrieve an
Iterator matching the
preceding-sibling XPath axis. |
java.lang.String |
getProcessingInstructionData(java.lang.Object o)
Retrieve the data of a processing-instruction.
|
java.lang.String |
getProcessingInstructionTarget(java.lang.Object o)
Retrieve the target of a processing-instruction.
|
java.lang.String |
getTextStringValue(java.lang.Object o)
Retrieve the string-value of a text node.
|
boolean |
isAttribute(java.lang.Object o)
Returns whether the given object is an attribute node.
|
boolean |
isComment(java.lang.Object o)
Returns whether the given object is a comment node.
|
boolean |
isDocument(java.lang.Object o)
Returns whether the given object is a document node.
|
boolean |
isElement(java.lang.Object o)
Returns whether the given object is an element node.
|
boolean |
isNamespace(java.lang.Object o)
Returns whether the given object is a namespace node.
|
boolean |
isProcessingInstruction(java.lang.Object o)
Returns whether the given object is a processing-instruction node.
|
boolean |
isText(java.lang.Object o)
Returns whether the given object is a text node.
|
XPath |
parseXPath(java.lang.String s)
Returns a parsed form of the given XPath string, which will be suitable
for queries on documents that use the same navigator as this one.
|
java.lang.String |
translateNamespacePrefixToUri(java.lang.String s,
java.lang.Object o)
Translate a namespace prefix to a namespace URI, possibly
considering a particular element node.
|
getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getNodeType, getSelfAxisIterator
public boolean isAttribute(java.lang.Object o)
Navigator
o
- the object to testtrue
if the object is an attribute node,
else false
public boolean isComment(java.lang.Object o)
Navigator
o
- the object to testtrue
if the object is a comment node,
else false
public boolean isDocument(java.lang.Object o)
Navigator
/
.o
- the object to testtrue
if the object is a document node,
else false
public boolean isElement(java.lang.Object o)
Navigator
o
- the object to testtrue
if the object is an element node,
else false
public boolean isNamespace(java.lang.Object o)
Navigator
o
- the object to testtrue
if the object is a namespace node,
else false
public boolean isProcessingInstruction(java.lang.Object o)
Navigator
o
- the object to testtrue
if the object is a processing-instruction node,
else false
public boolean isText(java.lang.Object o)
Navigator
o
- the object to testtrue
if the object is a text node,
else false
public java.lang.String getAttributeName(java.lang.Object o)
Navigator
o
- the context attribute nodepublic java.lang.String getAttributeNamespaceUri(java.lang.Object o)
Navigator
o
- the context attribute nodepublic java.lang.String getAttributeQName(java.lang.Object o)
Navigator
o
- the context attribute nodepublic java.lang.String getAttributeStringValue(java.lang.Object o)
Navigator
o
- the attribute nodepublic java.lang.String getCommentStringValue(java.lang.Object o)
Navigator
o
- the comment nodepublic java.lang.String getElementName(java.lang.Object o)
Navigator
o
- the context element nodepublic java.lang.String getElementNamespaceUri(java.lang.Object o)
Navigator
o
- the context element nodepublic java.lang.String getElementQName(java.lang.Object o)
Navigator
o
- the context element nodepublic java.lang.String getElementStringValue(java.lang.Object o)
Navigator
o
- the comment node.public java.lang.String getNamespacePrefix(java.lang.Object o)
Navigator
o
- the namespace nodepublic java.lang.String getNamespaceStringValue(java.lang.Object o)
Navigator
o
- the namespace nodepublic java.lang.String getTextStringValue(java.lang.Object o)
Navigator
o
- the text nodepublic java.lang.Object getDocument(java.lang.String s) throws FunctionCallException
DefaultNavigator
getDocument
in interface Navigator
getDocument
in class DefaultNavigator
s
- the URL of the document to loadFunctionCallException
- if an error occurs while loading the
URL; e.g. an I/O error or the document is malformedpublic java.lang.Object getDocumentNode(java.lang.Object o)
Navigator
getDocumentNode
in interface Navigator
getDocumentNode
in class DefaultNavigator
o
- the context nodeNavigator.isDocument(Object)
public java.util.Iterator getAttributeAxisIterator(java.lang.Object o)
DefaultNavigator
UnsupportedAxisException
. Subclasses that
support the attribute axis must override this method.getAttributeAxisIterator
in interface Navigator
getAttributeAxisIterator
in class DefaultNavigator
o
- the original context nodepublic java.util.Iterator getChildAxisIterator(java.lang.Object o)
DefaultNavigator
UnsupportedAxisException
getChildAxisIterator
in interface Navigator
getChildAxisIterator
in class DefaultNavigator
o
- the original context nodepublic java.util.Iterator getParentAxisIterator(java.lang.Object o)
DefaultNavigator
UnsupportedAxisException
getParentAxisIterator
in interface Navigator
getParentAxisIterator
in class DefaultNavigator
o
- the original context nodepublic java.lang.Object getParentNode(java.lang.Object o)
DefaultNavigator
getParentNode
in interface Navigator
getParentNode
in class DefaultNavigator
o
- the node whose parent to returnNavigator.isDocument(java.lang.Object)
,
Navigator.isElement(java.lang.Object)
public java.util.Iterator getPrecedingAxisIterator(java.lang.Object o) throws UnsupportedAxisException
Navigator
Iterator
matching the preceding
XPath axis.getPrecedingAxisIterator
in interface Navigator
getPrecedingAxisIterator
in class DefaultNavigator
o
- the original context nodeUnsupportedAxisException
- if the semantics of the preceding axis are
not supported by this object modelpublic java.util.Iterator getPrecedingSiblingAxisIterator(java.lang.Object o) throws UnsupportedAxisException
Navigator
Iterator
matching the
preceding-sibling
XPath axis.getPrecedingSiblingAxisIterator
in interface Navigator
getPrecedingSiblingAxisIterator
in class DefaultNavigator
o
- the original context nodeUnsupportedAxisException
- if the semantics of the preceding-sibling axis are
not supported by this object modelpublic java.lang.String getProcessingInstructionData(java.lang.Object o)
Navigator
getProcessingInstructionData
in interface Navigator
getProcessingInstructionData
in class DefaultNavigator
o
- the context processing-instruction nodepublic java.lang.String getProcessingInstructionTarget(java.lang.Object o)
Navigator
getProcessingInstructionTarget
in interface Navigator
getProcessingInstructionTarget
in class DefaultNavigator
o
- the context processing-instruction nodepublic java.lang.String translateNamespacePrefixToUri(java.lang.String s, java.lang.Object o)
Navigator
Strictly speaking, prefix-to-URI translation should occur irrespective of any element in the document. This method is provided to allow a non-conforming ease-of-use enhancement.
translateNamespacePrefixToUri
in interface Navigator
translateNamespacePrefixToUri
in class DefaultNavigator
s
- the prefix to translateo
- the element to consider during translationNamespaceContext
public XPath parseXPath(java.lang.String s) throws SAXPathException
Navigator
s
- the XPath expressionSAXPathException
- if the string is not a syntactically
correct XPath expressionXPath
public java.util.Iterator getNamespaceAxisIterator(java.lang.Object o)
DefaultNavigator
UnsupportedAxisException
. Subclasses that
support the namespace axis must override this method.getNamespaceAxisIterator
in interface Navigator
getNamespaceAxisIterator
in class DefaultNavigator
o
- the original context nodeCopyright © 2001–2018 Codehaus. All rights reserved.