Package org.jaxen
Class DefaultNavigator
- java.lang.Object
-
- org.jaxen.DefaultNavigator
-
- All Implemented Interfaces:
java.io.Serializable
,Navigator
- Direct Known Subclasses:
DocumentNavigator
,DocumentNavigator
,DocumentNavigator
public abstract class DefaultNavigator extends java.lang.Object implements Navigator
Default implementation ofNavigator
.This implementation is an abstract class, since some required operations cannot be implemented without additional knowledge of the object model.
When possible, default method implementations build upon each other, to reduce the number of methods required to be implemented for each object model. All methods, of course, may be overridden, to provide more-efficient implementations.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultNavigator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Iterator
getAncestorAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching theancestor
XPath axis.java.util.Iterator
getAncestorOrSelfAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching theancestor-or-self
XPath axis.java.util.Iterator
getAttributeAxisIterator(java.lang.Object contextNode)
ThrowsUnsupportedAxisException
.java.util.Iterator
getChildAxisIterator(java.lang.Object contextNode)
ThrowsUnsupportedAxisException
java.util.Iterator
getDescendantAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching thedescendant
XPath axis.java.util.Iterator
getDescendantOrSelfAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching thedescendant-or-self
XPath axis.java.lang.Object
getDocument(java.lang.String url)
Default implementation that always returns null.java.lang.Object
getDocumentNode(java.lang.Object contextNode)
Returns the document node that contains the given context node.java.lang.Object
getElementById(java.lang.Object contextNode, java.lang.String elementId)
Default implementation that cannot find elements.java.util.Iterator
getFollowingAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching thefollowing
XPath axis.java.util.Iterator
getFollowingSiblingAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching thefollowing-sibling
XPath axis.java.util.Iterator
getNamespaceAxisIterator(java.lang.Object contextNode)
ThrowsUnsupportedAxisException
.short
getNodeType(java.lang.Object node)
Returns a number that identifies the type of node that the given object represents in this navigator.java.util.Iterator
getParentAxisIterator(java.lang.Object contextNode)
ThrowsUnsupportedAxisException
java.lang.Object
getParentNode(java.lang.Object contextNode)
Default inefficient implementation.java.util.Iterator
getPrecedingAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching thepreceding
XPath axis.java.util.Iterator
getPrecedingSiblingAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching thepreceding-sibling
XPath axis.java.lang.String
getProcessingInstructionData(java.lang.Object obj)
Retrieve the data of a processing-instruction.java.lang.String
getProcessingInstructionTarget(java.lang.Object obj)
Retrieve the target of a processing-instruction.java.util.Iterator
getSelfAxisIterator(java.lang.Object contextNode)
Retrieve anIterator
matching theself
XPath axis.java.lang.String
translateNamespacePrefixToUri(java.lang.String prefix, java.lang.Object element)
Translate a namespace prefix to a namespace URI, possibly considering a particular element node.-
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
getAttributeName, getAttributeNamespaceUri, getAttributeQName, getAttributeStringValue, getCommentStringValue, getElementName, getElementNamespaceUri, getElementQName, getElementStringValue, getNamespacePrefix, getNamespaceStringValue, getTextStringValue, isAttribute, isComment, isDocument, isElement, isNamespace, isProcessingInstruction, isText, parseXPath
-
-
-
-
Method Detail
-
getChildAxisIterator
public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
ThrowsUnsupportedAxisException
- Specified by:
getChildAxisIterator
in interfaceNavigator
- Parameters:
contextNode
-- Returns:
- never returns
- Throws:
UnsupportedAxisException
- always
-
getDescendantAxisIterator
public java.util.Iterator getDescendantAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching thedescendant
XPath axis.- Specified by:
getDescendantAxisIterator
in interfaceNavigator
- 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
-
getParentAxisIterator
public java.util.Iterator getParentAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
ThrowsUnsupportedAxisException
- Specified by:
getParentAxisIterator
in interfaceNavigator
- Parameters:
contextNode
-- Returns:
- never returns
- Throws:
UnsupportedAxisException
-
getAncestorAxisIterator
public java.util.Iterator getAncestorAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching theancestor
XPath axis.- Specified by:
getAncestorAxisIterator
in interfaceNavigator
- 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
-
getFollowingSiblingAxisIterator
public java.util.Iterator getFollowingSiblingAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching thefollowing-sibling
XPath axis.- Specified by:
getFollowingSiblingAxisIterator
in interfaceNavigator
- 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
-
getPrecedingSiblingAxisIterator
public java.util.Iterator getPrecedingSiblingAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching thepreceding-sibling
XPath axis.- Specified by:
getPrecedingSiblingAxisIterator
in interfaceNavigator
- 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
-
getFollowingAxisIterator
public java.util.Iterator getFollowingAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching thefollowing
XPath axis.- Specified by:
getFollowingAxisIterator
in interfaceNavigator
- 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
-
getPrecedingAxisIterator
public java.util.Iterator getPrecedingAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching thepreceding
XPath axis.- Specified by:
getPrecedingAxisIterator
in interfaceNavigator
- 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
-
getAttributeAxisIterator
public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
ThrowsUnsupportedAxisException
. Subclasses that support the attribute axis must override this method.- Specified by:
getAttributeAxisIterator
in interfaceNavigator
- Parameters:
contextNode
-- Returns:
- never returns
- Throws:
UnsupportedAxisException
-
getNamespaceAxisIterator
public java.util.Iterator getNamespaceAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
ThrowsUnsupportedAxisException
. Subclasses that support the namespace axis must override this method.- Specified by:
getNamespaceAxisIterator
in interfaceNavigator
- Parameters:
contextNode
-- Returns:
- never returns
- Throws:
UnsupportedAxisException
-
getSelfAxisIterator
public java.util.Iterator getSelfAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching theself
XPath axis.- Specified by:
getSelfAxisIterator
in interfaceNavigator
- 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
-
getDescendantOrSelfAxisIterator
public java.util.Iterator getDescendantOrSelfAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching thedescendant-or-self
XPath axis.- Specified by:
getDescendantOrSelfAxisIterator
in interfaceNavigator
- 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
-
getAncestorOrSelfAxisIterator
public java.util.Iterator getAncestorOrSelfAxisIterator(java.lang.Object contextNode) throws UnsupportedAxisException
Description copied from interface:Navigator
Retrieve anIterator
matching theancestor-or-self
XPath axis.- Specified by:
getAncestorOrSelfAxisIterator
in interfaceNavigator
- 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
-
getDocumentNode
public java.lang.Object getDocumentNode(java.lang.Object contextNode)
Description copied from interface:Navigator
Returns the document node that contains the given context node.- Specified by:
getDocumentNode
in interfaceNavigator
- Parameters:
contextNode
- the context node- Returns:
- the document of the context node
- See Also:
Navigator.isDocument(Object)
-
translateNamespacePrefixToUri
public java.lang.String translateNamespacePrefixToUri(java.lang.String prefix, java.lang.Object element)
Description copied from interface:Navigator
Translate a namespace prefix to a namespace URI, possibly considering a particular element node.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.
- Specified by:
translateNamespacePrefixToUri
in interfaceNavigator
- Parameters:
prefix
- the prefix to translateelement
- the element to consider during translation- Returns:
- the namespace URI associated with the prefix
- See Also:
NamespaceContext
-
getProcessingInstructionTarget
public java.lang.String getProcessingInstructionTarget(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the target of a processing-instruction.- Specified by:
getProcessingInstructionTarget
in interfaceNavigator
- Parameters:
obj
- the context processing-instruction node- Returns:
- the target of the processing-instruction node
-
getProcessingInstructionData
public java.lang.String getProcessingInstructionData(java.lang.Object obj)
Description copied from interface:Navigator
Retrieve the data of a processing-instruction.- Specified by:
getProcessingInstructionData
in interfaceNavigator
- Parameters:
obj
- the context processing-instruction node- Returns:
- the data of the processing-instruction node
-
getNodeType
public short getNodeType(java.lang.Object node)
Description copied from interface:Navigator
Returns a number that identifies the type of node that the given object represents in this navigator.- Specified by:
getNodeType
in interfaceNavigator
- Parameters:
node
- ????- Returns:
- ????
- See Also:
Pattern
-
getParentNode
public java.lang.Object getParentNode(java.lang.Object contextNode) throws UnsupportedAxisException
Default inefficient implementation. Subclasses should override this method.- Specified by:
getParentNode
in interfaceNavigator
- Parameters:
contextNode
- the node whose parent to return- Returns:
- the parent node
- Throws:
UnsupportedAxisException
- if the parent axis is not supported- See Also:
Navigator.isDocument(java.lang.Object)
,Navigator.isElement(java.lang.Object)
-
getDocument
public java.lang.Object getDocument(java.lang.String url) throws FunctionCallException
Default implementation that always returns null. Override in subclass if the subclass can load documents.- Specified by:
getDocument
in interfaceNavigator
- 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
-
getElementById
public java.lang.Object getElementById(java.lang.Object contextNode, java.lang.String elementId)
Default implementation that cannot find elements. Override in subclass if subclass does know about attribute types.- Specified by:
getElementById
in interfaceNavigator
- Parameters:
contextNode
- a node from the document in which to look for the idelementId
- id to look for- Returns:
- null
-
-