org.apache.axis2.om.xpath
Class DocumentNavigator

java.lang.Object
  extended byDefaultNavigator
      extended byorg.apache.axis2.om.xpath.DocumentNavigator

public class DocumentNavigator
extends DefaultNavigator

See Also:
Serialized Form

Constructor Summary
DocumentNavigator()
           
 
Method Summary
 java.util.Iterator getAncestorAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the ancestor XPath axis.
 java.util.Iterator getAncestorOrSelfAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the ancestor-or-self XPath axis.
 java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the attribute XPath axis.
 java.lang.String getAttributeName(java.lang.Object object)
          Retrieve the name of the given attribute node.
 java.lang.String getAttributeNamespaceUri(java.lang.Object object)
          Retrieve the namespace URI of the given attribute node.
 java.lang.String getAttributeQName(java.lang.Object object)
          Retrieve the QName of the given attribute node.
 java.lang.String getAttributeStringValue(java.lang.Object object)
          Retrieve the string-value of an attribute node.
 java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the child XPath axis.
 java.lang.String getCommentStringValue(java.lang.Object object)
          Retrieve the string-value of a comment node.
 java.util.Iterator getDescendantAxisIterator(java.lang.Object object)
           
 java.util.Iterator getDescendantOrSelfAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the descendant-or-self XPath axis.
 java.lang.Object getDocument(java.lang.String uri)
          Loads a document from the given URI
 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)
          Returns the element whose ID is given by elementId.
 java.lang.String getElementName(java.lang.Object object)
          Retrieve the name of the given element node.
 java.lang.String getElementNamespaceUri(java.lang.Object object)
          Retrieve the namespace URI of the given element node.
 java.lang.String getElementQName(java.lang.Object object)
          Retrieve the QName of the given element node.
 java.lang.String getElementStringValue(java.lang.Object object)
          Retrieve the string-value of an element node.
 java.util.Iterator getFollowingAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the following XPath axis.
 java.util.Iterator getFollowingSiblingAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the following-sibling XPath axis.
 java.util.Iterator getNamespaceAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the namespace XPath axis.
 java.lang.String getNamespacePrefix(java.lang.Object object)
          Retrieve the namespace prefix of a namespace node.
 java.lang.String getNamespaceStringValue(java.lang.Object object)
          Retrieve the string-value of a namespace node.
 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)
          Retrieve an Iterator matching the parent XPath axis.
 java.lang.Object getParentNode(java.lang.Object contextNode)
          Returns the parent of the given context node.
 java.util.Iterator getPrecedingAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the preceding XPath axis.
 java.util.Iterator getPrecedingSiblingAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the preceding-sibling XPath axis.
 java.lang.String getProcessingInstructionData(java.lang.Object object)
          Retrieve the data of a processing-instruction.
 java.lang.String getProcessingInstructionTarget(java.lang.Object object)
          Retrieve the target of a processing-instruction.
 java.util.Iterator getSelfAxisIterator(java.lang.Object contextNode)
          Retrieve an Iterator matching the self xpath axis.
 java.lang.String getTextStringValue(java.lang.Object object)
          Retrieve the string-value of a text node.
 boolean isAttribute(java.lang.Object object)
          Returns whether the given object is an attribute node.
 boolean isComment(java.lang.Object object)
          Returns whether the given object is a comment node.
 boolean isDocument(java.lang.Object object)
          Returns whether the given object is a document node.
 boolean isElement(java.lang.Object object)
          Returns whether the given object is an element node.
 boolean isNamespace(java.lang.Object object)
          Returns whether the given object is a namespace node.
 boolean isProcessingInstruction(java.lang.Object object)
          Returns whether the given object is a processing-instruction node.
 boolean isText(java.lang.Object object)
          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 documents that use the same navigator as this one.
 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
 

Constructor Detail

DocumentNavigator

public DocumentNavigator()
Method Detail

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 documents that use the same navigator as this one.

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

getElementNamespaceUri

public java.lang.String getElementNamespaceUri(java.lang.Object object)
Retrieve the namespace URI of the given element node.

Parameters:
object - the context element node
Returns:
the namespace URI of the element node

getElementName

public java.lang.String getElementName(java.lang.Object object)
Retrieve the name of the given element node.

Parameters:
object - the context element node
Returns:
the name of the element node

getElementQName

public java.lang.String getElementQName(java.lang.Object object)
Retrieve the QName of the given element node.

Parameters:
object - the context element node
Returns:
the QName of the element node

getAttributeNamespaceUri

public java.lang.String getAttributeNamespaceUri(java.lang.Object object)
Retrieve the namespace URI of the given attribute node.

Parameters:
object - the context attribute node
Returns:
the namespace URI of the attribute node

getAttributeName

public java.lang.String getAttributeName(java.lang.Object object)
Retrieve the name of the given attribute node.

Parameters:
object - the context attribute node
Returns:
the name of the attribute node

getAttributeQName

public java.lang.String getAttributeQName(java.lang.Object object)
Retrieve the QName of the given attribute node.

Parameters:
object - the context attribute node
Returns:
the qualified name of the attribute node

isDocument

public boolean isDocument(java.lang.Object object)
Returns whether the given object is a document node. A document node is the node that is selected by the xpath expression /.

Parameters:
object - the object to test
Returns:
true if the object is a document node, else false

isElement

public boolean isElement(java.lang.Object object)
Returns whether the given object is an element node.

Parameters:
object - the object to test
Returns:
true if the object is an element node, else false

isAttribute

public boolean isAttribute(java.lang.Object object)
Returns whether the given object is an attribute node.

Parameters:
object - the object to test
Returns:
true if the object is an attribute node, else false

isNamespace

public boolean isNamespace(java.lang.Object object)
Returns whether the given object is a namespace node.

Parameters:
object - the object to test
Returns:
true if the object is a namespace node, else false

isComment

public boolean isComment(java.lang.Object object)
Returns whether the given object is a comment node.

Parameters:
object - the object to test
Returns:
true if the object is a comment node, else false

isText

public boolean isText(java.lang.Object object)
Returns whether the given object is a text node.

Parameters:
object - the object to test
Returns:
true if the object is a text node, else false

isProcessingInstruction

public boolean isProcessingInstruction(java.lang.Object object)
Returns whether the given object is a processing-instruction node.

Parameters:
object - the object to test
Returns:
true if the object is a processing-instruction node, else false

getCommentStringValue

public java.lang.String getCommentStringValue(java.lang.Object object)
Retrieve the string-value of a comment node. This may be the empty string if the comment is empty, but must not be null.

Parameters:
object - the comment node
Returns:
the string-value of the node

getElementStringValue

public java.lang.String getElementStringValue(java.lang.Object object)
Retrieve the string-value of an element node. This may be the empty string if the element is empty, but must not be null.

Parameters:
object - the comment node.
Returns:
the string-value of the node.

getAttributeStringValue

public java.lang.String getAttributeStringValue(java.lang.Object object)
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.

Parameters:
object - the attribute node
Returns:
the string-value of the node

getNamespaceStringValue

public java.lang.String getNamespaceStringValue(java.lang.Object object)
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.

Parameters:
object - the namespace node
Returns:
the string-value of the node

getTextStringValue

public java.lang.String getTextStringValue(java.lang.Object object)
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.

Parameters:
object - the text node
Returns:
the string-value of the node

getNamespacePrefix

public java.lang.String getNamespacePrefix(java.lang.Object object)
Retrieve the namespace prefix of a namespace node.

Parameters:
object - the namespace node
Returns:
the prefix associated with the node

getChildAxisIterator

public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)
                                        throws UnsupportedAxisException
Retrieve an 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

getDescendantAxisIterator

public java.util.Iterator getDescendantAxisIterator(java.lang.Object object)
                                             throws UnsupportedAxisException
Throws:
UnsupportedAxisException

getAttributeAxisIterator

public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)
                                            throws UnsupportedAxisException
Retrieve an 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

getNamespaceAxisIterator

public java.util.Iterator getNamespaceAxisIterator(java.lang.Object contextNode)
                                            throws UnsupportedAxisException
Retrieve an 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

getSelfAxisIterator

public java.util.Iterator getSelfAxisIterator(java.lang.Object contextNode)
                                       throws UnsupportedAxisException
Retrieve an 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

getDescendantOrSelfAxisIterator

public java.util.Iterator getDescendantOrSelfAxisIterator(java.lang.Object contextNode)
                                                   throws UnsupportedAxisException
Retrieve an 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

getAncestorOrSelfAxisIterator

public java.util.Iterator getAncestorOrSelfAxisIterator(java.lang.Object contextNode)
                                                 throws UnsupportedAxisException
Retrieve an 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

getParentAxisIterator

public java.util.Iterator getParentAxisIterator(java.lang.Object contextNode)
                                         throws UnsupportedAxisException
Retrieve an 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

getAncestorAxisIterator

public java.util.Iterator getAncestorAxisIterator(java.lang.Object contextNode)
                                           throws UnsupportedAxisException
Retrieve an 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

getFollowingSiblingAxisIterator

public java.util.Iterator getFollowingSiblingAxisIterator(java.lang.Object contextNode)
                                                   throws UnsupportedAxisException
Retrieve an 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

getPrecedingSiblingAxisIterator

public java.util.Iterator getPrecedingSiblingAxisIterator(java.lang.Object contextNode)
                                                   throws UnsupportedAxisException
Retrieve an 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

getFollowingAxisIterator

public java.util.Iterator getFollowingAxisIterator(java.lang.Object contextNode)
                                            throws UnsupportedAxisException
Retrieve an 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

getPrecedingAxisIterator

public java.util.Iterator getPrecedingAxisIterator(java.lang.Object contextNode)
                                            throws UnsupportedAxisException
Retrieve an 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

getDocument

public java.lang.Object getDocument(java.lang.String uri)
                             throws FunctionCallException
Loads a document from the given URI

Parameters:
uri - the URI of the document to load
Returns:
the document
Throws:
FunctionCallException - if the document could not be loaded

getElementById

public java.lang.Object getElementById(java.lang.Object contextNode,
                                       java.lang.String elementId)
Returns the element whose ID is given by elementId. If no such element exists, returns null. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.

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

getDocumentNode

public java.lang.Object getDocumentNode(java.lang.Object contextNode)
Returns the document node that contains the given context node.

Parameters:
contextNode - the context node
Returns:
the document of the context node
See Also:
isDocument(Object)

translateNamespacePrefixToUri

public 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.

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

getProcessingInstructionTarget

public java.lang.String getProcessingInstructionTarget(java.lang.Object object)
Retrieve the target of a processing-instruction.

Parameters:
object - the context processing-instruction node
Returns:
the target of the processing-instruction node

getProcessingInstructionData

public java.lang.String getProcessingInstructionData(java.lang.Object object)
Retrieve the data of a processing-instruction.

Parameters:
object - the context processing-instruction node
Returns:
the data of the processing-instruction node

getNodeType

public short getNodeType(java.lang.Object node)
Returns a number that identifies the type of node that the given object represents in this navigator.

Parameters:
node - ????
Returns:
????
See Also:
org.jaxen.pattern.Pattern

getParentNode

public java.lang.Object getParentNode(java.lang.Object contextNode)
                               throws UnsupportedAxisException
Returns the parent of the given context node.

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
See Also:
isDocument(java.lang.Object), isElement(java.lang.Object)