Class DocumentNavigator

java.lang.Object
org.jaxen.DefaultNavigator
org.jaxen.dom4j.DocumentNavigator
All Implemented Interfaces:
Serializable, org.jaxen.NamedAccessNavigator, org.jaxen.Navigator

public class DocumentNavigator extends org.jaxen.DefaultNavigator implements org.jaxen.NamedAccessNavigator
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:
  • Constructor Details

    • DocumentNavigator

      public DocumentNavigator()
  • Method Details

    • getInstance

      public static org.jaxen.Navigator getInstance()
      Retrieve the singleton instance of this DocumentNavigator.
    • isElement

      public boolean isElement(Object obj)
      Specified by:
      isElement in interface org.jaxen.Navigator
    • isComment

      public boolean isComment(Object obj)
      Specified by:
      isComment in interface org.jaxen.Navigator
    • isText

      public boolean isText(Object obj)
      Specified by:
      isText in interface org.jaxen.Navigator
    • isAttribute

      public boolean isAttribute(Object obj)
      Specified by:
      isAttribute in interface org.jaxen.Navigator
    • isProcessingInstruction

      public boolean isProcessingInstruction(Object obj)
      Specified by:
      isProcessingInstruction in interface org.jaxen.Navigator
    • isDocument

      public boolean isDocument(Object obj)
      Specified by:
      isDocument in interface org.jaxen.Navigator
    • isNamespace

      public boolean isNamespace(Object obj)
      Specified by:
      isNamespace in interface org.jaxen.Navigator
    • getElementName

      public String getElementName(Object obj)
      Specified by:
      getElementName in interface org.jaxen.Navigator
    • getElementNamespaceUri

      public String getElementNamespaceUri(Object obj)
      Specified by:
      getElementNamespaceUri in interface org.jaxen.Navigator
    • getElementQName

      public String getElementQName(Object obj)
      Specified by:
      getElementQName in interface org.jaxen.Navigator
    • getAttributeName

      public String getAttributeName(Object obj)
      Specified by:
      getAttributeName in interface org.jaxen.Navigator
    • getAttributeNamespaceUri

      public String getAttributeNamespaceUri(Object obj)
      Specified by:
      getAttributeNamespaceUri in interface org.jaxen.Navigator
    • getAttributeQName

      public String getAttributeQName(Object obj)
      Specified by:
      getAttributeQName in interface org.jaxen.Navigator
    • getChildAxisIterator

      public Iterator getChildAxisIterator(Object contextNode)
      Specified by:
      getChildAxisIterator in interface org.jaxen.Navigator
      Overrides:
      getChildAxisIterator in class org.jaxen.DefaultNavigator
    • getChildAxisIterator

      public Iterator getChildAxisIterator(Object contextNode, String localName, String namespacePrefix, String namespaceURI)
      Retrieves an Iterator over the child elements that match the supplied name.
      Specified by:
      getChildAxisIterator in interface org.jaxen.NamedAccessNavigator
      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 Iterator getParentAxisIterator(Object contextNode)
      Specified by:
      getParentAxisIterator in interface org.jaxen.Navigator
      Overrides:
      getParentAxisIterator in class org.jaxen.DefaultNavigator
    • getAttributeAxisIterator

      public Iterator getAttributeAxisIterator(Object contextNode)
      Specified by:
      getAttributeAxisIterator in interface org.jaxen.Navigator
      Overrides:
      getAttributeAxisIterator in class org.jaxen.DefaultNavigator
    • getAttributeAxisIterator

      public Iterator getAttributeAxisIterator(Object contextNode, String localName, String namespacePrefix, String namespaceURI)
      Retrieves an Iterator over the attribute elements that match the supplied name.
      Specified by:
      getAttributeAxisIterator in interface org.jaxen.NamedAccessNavigator
      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 Iterator getNamespaceAxisIterator(Object contextNode)
      Specified by:
      getNamespaceAxisIterator in interface org.jaxen.Navigator
      Overrides:
      getNamespaceAxisIterator in class org.jaxen.DefaultNavigator
    • getDocumentNode

      public Object getDocumentNode(Object contextNode)
      Specified by:
      getDocumentNode in interface org.jaxen.Navigator
      Overrides:
      getDocumentNode in class org.jaxen.DefaultNavigator
    • parseXPath

      public org.jaxen.XPath parseXPath(String xpath) throws org.jaxen.saxpath.SAXPathException
      Returns a parsed form of the given XPath string, which will be suitable for queries on DOM4J documents.
      Specified by:
      parseXPath in interface org.jaxen.Navigator
      Throws:
      org.jaxen.saxpath.SAXPathException
    • getParentNode

      public Object getParentNode(Object contextNode)
      Specified by:
      getParentNode in interface org.jaxen.Navigator
      Overrides:
      getParentNode in class org.jaxen.DefaultNavigator
    • getTextStringValue

      public String getTextStringValue(Object obj)
      Specified by:
      getTextStringValue in interface org.jaxen.Navigator
    • getElementStringValue

      public String getElementStringValue(Object obj)
      Specified by:
      getElementStringValue in interface org.jaxen.Navigator
    • getAttributeStringValue

      public String getAttributeStringValue(Object obj)
      Specified by:
      getAttributeStringValue in interface org.jaxen.Navigator
    • getNamespaceStringValue

      public String getNamespaceStringValue(Object obj)
      Specified by:
      getNamespaceStringValue in interface org.jaxen.Navigator
    • getNamespacePrefix

      public String getNamespacePrefix(Object obj)
      Specified by:
      getNamespacePrefix in interface org.jaxen.Navigator
    • getCommentStringValue

      public String getCommentStringValue(Object obj)
      Specified by:
      getCommentStringValue in interface org.jaxen.Navigator
    • translateNamespacePrefixToUri

      public String translateNamespacePrefixToUri(String prefix, Object context)
      Specified by:
      translateNamespacePrefixToUri in interface org.jaxen.Navigator
      Overrides:
      translateNamespacePrefixToUri in class org.jaxen.DefaultNavigator
    • getNodeType

      public short getNodeType(Object node)
      Specified by:
      getNodeType in interface org.jaxen.Navigator
      Overrides:
      getNodeType in class org.jaxen.DefaultNavigator
    • getDocument

      public Object getDocument(String uri) throws org.jaxen.FunctionCallException
      Specified by:
      getDocument in interface org.jaxen.Navigator
      Overrides:
      getDocument in class org.jaxen.DefaultNavigator
      Throws:
      org.jaxen.FunctionCallException
    • getProcessingInstructionTarget

      public String getProcessingInstructionTarget(Object obj)
      Specified by:
      getProcessingInstructionTarget in interface org.jaxen.Navigator
      Overrides:
      getProcessingInstructionTarget in class org.jaxen.DefaultNavigator
    • getProcessingInstructionData

      public String getProcessingInstructionData(Object obj)
      Specified by:
      getProcessingInstructionData in interface org.jaxen.Navigator
      Overrides:
      getProcessingInstructionData in class org.jaxen.DefaultNavigator
    • getSAXReader

      public SAXReader getSAXReader()
    • setSAXReader

      public void setSAXReader(SAXReader reader)