org.jaxen
public interface Navigator extends Serializable
There is a method to obtain a java.util.Iterator
,
for each axis specified by XPath. If the target object model
does not support the semantics of a particular axis, an
{@link UnsupportedAxisException} is to be thrown. If there are
no nodes on that axis, an empty iterator should be returned.
Version: $Id: Navigator.java,v 1.30 2006/06/03 20:07:19 elharo Exp $
Method Summary | |
---|---|
Iterator | getAncestorAxisIterator(Object contextNode) Retrieve an Iterator matching the ancestor
XPath axis.
|
Iterator | getAncestorOrSelfAxisIterator(Object contextNode) Retrieve an Iterator matching the
ancestor-or-self XPath axis.
|
Iterator | getAttributeAxisIterator(Object contextNode) Retrieve an Iterator matching the attribute
XPath axis.
|
String | getAttributeName(Object attr) Retrieve the local name of the given attribute node.
|
String | getAttributeNamespaceUri(Object attr) Retrieve the namespace URI of the given attribute node.
|
String | getAttributeQName(Object attr) Retrieve the qualified name of the given attribute node.
|
String | getAttributeStringValue(Object attr) Retrieve the string-value of an attribute node.
|
Iterator | getChildAxisIterator(Object contextNode) Retrieve an Iterator matching the child
XPath axis.
|
String | getCommentStringValue(Object comment) Retrieve the string-value of a comment node.
|
Iterator | getDescendantAxisIterator(Object contextNode) Retrieve an Iterator matching the descendant
XPath axis.
|
Iterator | getDescendantOrSelfAxisIterator(Object contextNode) Retrieve an Iterator matching the
descendant-or-self XPath axis.
|
Object | getDocument(String uri) Loads a document from the given URI
|
Object | getDocumentNode(Object contextNode) Returns the document node that contains the given context node.
|
Object | getElementById(Object contextNode, String elementId)
Returns the element whose ID is given by elementId.
|
String | getElementName(Object element) Retrieve the local name of the given element node.
|
String | getElementNamespaceUri(Object element) Retrieve the namespace URI of the given element node.
|
String | getElementQName(Object element) Retrieve the qualified name of the given element node.
|
String | getElementStringValue(Object element) Retrieve the string-value of an element node.
|
Iterator | getFollowingAxisIterator(Object contextNode) Retrieve an Iterator matching the following
XPath axis.
|
Iterator | getFollowingSiblingAxisIterator(Object contextNode) Retrieve an Iterator matching the
following-sibling XPath axis.
|
Iterator | getNamespaceAxisIterator(Object contextNode) Retrieve an Iterator matching the namespace
XPath axis.
|
String | getNamespacePrefix(Object ns) Retrieve the namespace prefix of a namespace node.
|
String | getNamespaceStringValue(Object ns) Retrieve the string-value of a namespace node.
|
short | getNodeType(Object node) Returns a number that identifies the type of node that the given
object represents in this navigator.
|
Iterator | getParentAxisIterator(Object contextNode) Retrieve an Iterator matching the parent XPath axis.
|
Object | getParentNode(Object contextNode) Returns the parent of the given context node.
|
Iterator | getPrecedingAxisIterator(Object contextNode) Retrieve an Iterator matching the preceding XPath axis.
|
Iterator | getPrecedingSiblingAxisIterator(Object contextNode) Retrieve an Iterator matching the
preceding-sibling XPath axis.
|
String | getProcessingInstructionData(Object pi) Retrieve the data of a processing-instruction.
|
String | getProcessingInstructionTarget(Object pi) Retrieve the target of a processing-instruction.
|
Iterator | getSelfAxisIterator(Object contextNode) Retrieve an Iterator matching the self XPath
axis.
|
String | getTextStringValue(Object text) Retrieve the string-value of a text node.
|
boolean | isAttribute(Object object) Returns whether the given object is an attribute node.
|
boolean | isComment(Object object) Returns whether the given object is a comment node.
|
boolean | isDocument(Object object) Returns whether the given object is a document node. |
boolean | isElement(Object object) Returns whether the given object is an element node.
|
boolean | isNamespace(Object object) Returns whether the given object is a namespace node.
|
boolean | isProcessingInstruction(Object object) Returns whether the given object is a processing-instruction node.
|
boolean | isText(Object object) Returns whether the given object is a text node.
|
XPath | parseXPath(String xpath) 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.
|
String | translateNamespacePrefixToUri(String prefix, Object element) Translate a namespace prefix to a namespace URI, possibly
considering a particular element node.
|
Iterator
matching the ancestor
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the ancestor axis are not supported by this object model
Iterator
matching the
ancestor-or-self
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the ancestor-or-self axis are not supported by this object model
Iterator
matching the attribute
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the attribute axis are not supported by this object model
Parameters: attr the context attribute node
Returns: the local name of the attribute node
Parameters: attr the context attribute node
Returns: the namespace URI of the attribute node
Parameters: attr the context attribute node
Returns: the qualified name of the attribute node
Parameters: attr the attribute node
Returns: the string-value of the node
Iterator
matching the child
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the child axis are not supported by this object model
Parameters: comment the comment node
Returns: the string-value of the node
Iterator
matching the descendant
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the desscendant axis are not supported by this object model
Iterator
matching the
descendant-or-self
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the descendant-or-self axis are not supported by this object model
Parameters: uri the URI of the document to load
Returns: the document
Throws: FunctionCallException if the document could not be loaded
Parameters: contextNode the context node
Returns: the document of the context node
Parameters: contextNode a node from the document in which to look for the id elementId id to look for
Returns: element whose ID is given by elementId, or null if no such element exists in the document or if the implementation does not know about attribute types
Parameters: element the context element node
Returns: the local name of the element node
Parameters: element the context element node
Returns: the namespace URI of the element node
Parameters: element the context element node
Returns: the qualified name of the element node
Parameters: element the comment node.
Returns: the string-value of the node.
Iterator
matching the following
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the following axis are not supported by this object model
Iterator
matching the
following-sibling
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the following-sibling axis are not supported by this object model
Iterator
matching the namespace
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the namespace axis are not supported by this object model
Parameters: ns the namespace node
Returns: the prefix associated with the node
Parameters: ns the namespace node
Returns: the string-value of the node
Parameters: node ????
Returns: ????
See Also: Pattern
Iterator
matching the parent
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the parent axis are not supported by this object model
The parent of any node must either be a document node or an element node.
Parameters: contextNode the context node
Returns: the parent of the context node, or null if this is a document node.
Throws: UnsupportedAxisException if the parent axis is not supported by the model
Iterator
matching the preceding
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the preceding axis are not supported by this object model
Iterator
matching the
preceding-sibling
XPath axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the preceding-sibling axis are not supported by this object model
Parameters: pi the context processing-instruction node
Returns: the data of the processing-instruction node
Parameters: pi the context processing-instruction node
Returns: the target of the processing-instruction node
Iterator
matching the self
XPath
axis.
Parameters: contextNode the original context node
Returns: an Iterator capable of traversing the axis, not null
Throws: UnsupportedAxisException if the semantics of the self axis are not supported by this object model
Parameters: text the text node
Returns: the string-value of the node
Parameters: object the object to test
Returns: true
if the object is an attribute node,
else false
Parameters: object the object to test
Returns: true
if the object is a comment node,
else false
/
.
Parameters: object the object to test
Returns: true
if the object is a document node,
else false
Parameters: object the object to test
Returns: true
if the object is an element node,
else false
Parameters: object the object to test
Returns: true
if the object is a namespace node,
else false
Parameters: object the object to test
Returns: true
if the object is a processing-instruction node,
else false
Parameters: object the object to test
Returns: true
if the object is a text node,
else false
Parameters: xpath the XPath expression
Returns: a new XPath expression object
Throws: SAXPathException if the string is not a syntactically correct XPath expression
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.
Parameters: prefix the prefix to translate element the element to consider during translation
Returns: the namespace URI associated with the prefix