org.jaxen.dom4j
Class DocumentNavigator

java.lang.Object
  extended by DefaultNavigator
      extended by org.jaxen.dom4j.DocumentNavigator

public class DocumentNavigator
extends DefaultNavigator

Interface for navigating around the DOM4J 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

Constructor Summary
DocumentNavigator()
           
 
Method Summary
 java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)
           
 java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode, java.lang.String localName, java.lang.String namespacePrefix, java.lang.String namespaceURI)
          Retrieves an Iterator over the attribute elements that match the supplied name.
 java.lang.String getAttributeName(java.lang.Object obj)
           
 java.lang.String getAttributeNamespaceUri(java.lang.Object obj)
           
 java.lang.String getAttributeQName(java.lang.Object obj)
           
 java.lang.String getAttributeStringValue(java.lang.Object obj)
           
 java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)
           
 java.util.Iterator getChildAxisIterator(java.lang.Object contextNode, java.lang.String localName, java.lang.String namespacePrefix, java.lang.String namespaceURI)
          Retrieves an Iterator over the child elements that match the supplied name.
 java.lang.String getCommentStringValue(java.lang.Object obj)
           
 java.lang.Object getDocument(java.lang.String uri)
           
 java.lang.Object getDocumentNode(java.lang.Object contextNode)
           
 java.lang.String getElementName(java.lang.Object obj)
           
 java.lang.String getElementNamespaceUri(java.lang.Object obj)
           
 java.lang.String getElementQName(java.lang.Object obj)
           
 java.lang.String getElementStringValue(java.lang.Object obj)
           
static Navigator getInstance()
          Retrieve the singleton instance of this DocumentNavigator.
 java.util.Iterator getNamespaceAxisIterator(java.lang.Object contextNode)
           
 java.lang.String getNamespacePrefix(java.lang.Object obj)
           
 java.lang.String getNamespaceStringValue(java.lang.Object obj)
           
 short getNodeType(java.lang.Object node)
           
 java.util.Iterator getParentAxisIterator(java.lang.Object contextNode)
           
 java.lang.Object getParentNode(java.lang.Object contextNode)
           
 java.lang.String getProcessingInstructionData(java.lang.Object obj)
           
 java.lang.String getProcessingInstructionTarget(java.lang.Object obj)
           
 SAXReader getSAXReader()
           
 java.lang.String getTextStringValue(java.lang.Object obj)
           
 boolean isAttribute(java.lang.Object obj)
           
 boolean isComment(java.lang.Object obj)
           
 boolean isDocument(java.lang.Object obj)
           
 boolean isElement(java.lang.Object obj)
           
 boolean isNamespace(java.lang.Object obj)
           
 boolean isProcessingInstruction(java.lang.Object obj)
           
 boolean isText(java.lang.Object obj)
           
 XPath parseXPath(java.lang.String xpath)
          Returns a parsed form of the given XPath string, which will be suitable for queries on DOM4J documents.
 void setSAXReader(SAXReader reader)
           
 java.lang.String translateNamespacePrefixToUri(java.lang.String prefix, java.lang.Object context)
           
 
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

getInstance

public static Navigator getInstance()
Retrieve the singleton instance of this DocumentNavigator.


isElement

public boolean isElement(java.lang.Object obj)

isComment

public boolean isComment(java.lang.Object obj)

isText

public boolean isText(java.lang.Object obj)

isAttribute

public boolean isAttribute(java.lang.Object obj)

isProcessingInstruction

public boolean isProcessingInstruction(java.lang.Object obj)

isDocument

public boolean isDocument(java.lang.Object obj)

isNamespace

public boolean isNamespace(java.lang.Object obj)

getElementName

public java.lang.String getElementName(java.lang.Object obj)

getElementNamespaceUri

public java.lang.String getElementNamespaceUri(java.lang.Object obj)

getElementQName

public java.lang.String getElementQName(java.lang.Object obj)

getAttributeName

public java.lang.String getAttributeName(java.lang.Object obj)

getAttributeNamespaceUri

public java.lang.String getAttributeNamespaceUri(java.lang.Object obj)

getAttributeQName

public java.lang.String getAttributeQName(java.lang.Object obj)

getChildAxisIterator

public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)

getChildAxisIterator

public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode,
                                               java.lang.String localName,
                                               java.lang.String namespacePrefix,
                                               java.lang.String namespaceURI)
Retrieves an Iterator over the child elements that match the supplied name.

Parameters:
contextNode - the origin context node
localName - the local name of the children to return, always present
namespacePrefix - the prefix of the namespace of the children to return
namespaceURI - the uri of the namespace of the children to return
Returns:
an Iterator that traverses the named children, or null if none

getParentAxisIterator

public java.util.Iterator getParentAxisIterator(java.lang.Object contextNode)

getAttributeAxisIterator

public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)

getAttributeAxisIterator

public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode,
                                                   java.lang.String localName,
                                                   java.lang.String namespacePrefix,
                                                   java.lang.String namespaceURI)
Retrieves an Iterator over the attribute elements that match the supplied name.

Parameters:
contextNode - the origin context node
localName - the local name of the attributes to return, always present
namespacePrefix - the prefix of the namespace of the attributes to return
namespaceURI - the URI of the namespace of the attributes to return
Returns:
an Iterator that traverses the named attributes, not null

getNamespaceAxisIterator

public java.util.Iterator getNamespaceAxisIterator(java.lang.Object contextNode)

getDocumentNode

public java.lang.Object getDocumentNode(java.lang.Object contextNode)

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 DOM4J documents.

Throws:
SAXPathException

getParentNode

public java.lang.Object getParentNode(java.lang.Object contextNode)

getTextStringValue

public java.lang.String getTextStringValue(java.lang.Object obj)

getElementStringValue

public java.lang.String getElementStringValue(java.lang.Object obj)

getAttributeStringValue

public java.lang.String getAttributeStringValue(java.lang.Object obj)

getNamespaceStringValue

public java.lang.String getNamespaceStringValue(java.lang.Object obj)

getNamespacePrefix

public java.lang.String getNamespacePrefix(java.lang.Object obj)

getCommentStringValue

public java.lang.String getCommentStringValue(java.lang.Object obj)

translateNamespacePrefixToUri

public java.lang.String translateNamespacePrefixToUri(java.lang.String prefix,
                                                      java.lang.Object context)

getNodeType

public short getNodeType(java.lang.Object node)

getDocument

public java.lang.Object getDocument(java.lang.String uri)
                             throws FunctionCallException
Throws:
FunctionCallException

getProcessingInstructionTarget

public java.lang.String getProcessingInstructionTarget(java.lang.Object obj)

getProcessingInstructionData

public java.lang.String getProcessingInstructionData(java.lang.Object obj)

getSAXReader

public SAXReader getSAXReader()

setSAXReader

public void setSAXReader(SAXReader reader)


Copyright ? 2005 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge Logo