com.jaxfront.core.xpath
Class DocumentNavigator

java.lang.Object
  extended by org.jaxen.DefaultNavigator
      extended by com.jaxfront.core.xpath.DocumentNavigator
All Implemented Interfaces:
java.io.Serializable, org.jaxen.Navigator

public class DocumentNavigator
extends org.jaxen.DefaultNavigator

Interface for navigating around the W3C DOM Level 2 object model.

This class is not intended for direct usage, but is used by the Jaxen engine during evaluation.

This class implements the org.jaxen.DefaultNavigator interface for the Jaxen XPath library, version 1.0beta3 (it is not guaranteed to work with subsequent releases). This adapter allows the Jaxen library to be used to execute XPath queries against any object tree that implements the DOM level 2 interfaces.

Note: DOM level 2 does not include a node representing an XML Namespace declaration. This navigator will return Namespace decls as instantiations of the custom NamespaceNodeclass, and users will have to check result sets to locate and isolate these.

Author:
David Megginson, James Strachan
See Also:
XPath, NamespaceNode, Serialized Form

Constructor Summary
DocumentNavigator()
           
 
Method Summary
 java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)
           
 java.lang.String getAttributeName(java.lang.Object attr)
           
 java.lang.String getAttributeNamespaceUri(java.lang.Object attr)
           
 java.lang.String getAttributeQName(java.lang.Object attr)
           
 java.lang.String getAttributeStringValue(java.lang.Object attr)
           
 java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)
           
 java.lang.String getCommentStringValue(java.lang.Object comment)
           
 java.lang.Object getDocumentNode(java.lang.Object contextNode)
           
 java.lang.String getElementName(java.lang.Object element)
           
 java.lang.String getElementNamespaceUri(java.lang.Object element)
           
 java.lang.String getElementNamespaceUri(java.lang.Object element, boolean defaultStepIsPrefixed)
           
 java.lang.String getElementQName(java.lang.Object element)
           
 java.lang.String getElementStringValue(java.lang.Object element)
           
static org.jaxen.Navigator getInstance()
           
 java.lang.String getNamespacePrefix(java.lang.Object ns)
           
 java.lang.String getNamespaceStringValue(java.lang.Object ns)
           
 java.util.Iterator getParentAxisIterator(java.lang.Object contextNode)
           
 java.util.Iterator getSelfAxisIterator(java.lang.Object contextNode)
           
 java.lang.String getTextStringValue(java.lang.Object txt)
           
 boolean isAttribute(java.lang.Object object)
           
 boolean isComment(java.lang.Object object)
           
 boolean isDocument(java.lang.Object object)
           
 boolean isElement(java.lang.Object object)
           
 boolean isNamespace(java.lang.Object object)
           
 boolean isProcessingInstruction(java.lang.Object object)
           
 boolean isText(java.lang.Object object)
           
 org.jaxen.XPath parseXPath(java.lang.String xpath)
           
 void reset()
           
 void setChoosenOnly(boolean choosenOnly)
           
 void setEditingTypeIncluded(boolean included)
           
 void setEditingTypeTraversalOnly(boolean only)
           
 void setIDOnly(boolean idOnly)
           
 void setListTypeIncluded(boolean included)
           
 void setOnlySerializable(boolean onlySerializable)
           
 
Methods inherited from class org.jaxen.DefaultNavigator
getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getAttributeNamespaceUri, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getDocument, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getNamespaceAxisIterator, getNodeType, getParentNode, getPrecedingAxisIterator, getPrecedingSiblingAxisIterator, getProcessingInstructionData, getProcessingInstructionTarget, translateNamespacePrefixToUri
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentNavigator

public DocumentNavigator()
Method Detail

getInstance

public static org.jaxen.Navigator getInstance()

getDocumentNode

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

reset

public void reset()

getParentAxisIterator

public java.util.Iterator getParentAxisIterator(java.lang.Object contextNode)
                                         throws org.jaxen.UnsupportedAxisException
Specified by:
getParentAxisIterator in interface org.jaxen.Navigator
Overrides:
getParentAxisIterator in class org.jaxen.DefaultNavigator
Throws:
org.jaxen.UnsupportedAxisException

getAttributeAxisIterator

public java.util.Iterator getAttributeAxisIterator(java.lang.Object contextNode)
                                            throws org.jaxen.UnsupportedAxisException
Specified by:
getAttributeAxisIterator in interface org.jaxen.Navigator
Overrides:
getAttributeAxisIterator in class org.jaxen.DefaultNavigator
Throws:
org.jaxen.UnsupportedAxisException

getChildAxisIterator

public java.util.Iterator getChildAxisIterator(java.lang.Object contextNode)
                                        throws org.jaxen.UnsupportedAxisException
Specified by:
getChildAxisIterator in interface org.jaxen.Navigator
Overrides:
getChildAxisIterator in class org.jaxen.DefaultNavigator
Throws:
org.jaxen.UnsupportedAxisException

getElementNamespaceUri

public java.lang.String getElementNamespaceUri(java.lang.Object element,
                                               boolean defaultStepIsPrefixed)
Specified by:
getElementNamespaceUri in interface org.jaxen.Navigator
Overrides:
getElementNamespaceUri in class org.jaxen.DefaultNavigator

getElementName

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

getElementQName

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

getAttributeNamespaceUri

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

getAttributeName

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

getAttributeQName

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

isDocument

public boolean isDocument(java.lang.Object object)

isElement

public boolean isElement(java.lang.Object object)

isAttribute

public boolean isAttribute(java.lang.Object object)

isNamespace

public boolean isNamespace(java.lang.Object object)

isComment

public boolean isComment(java.lang.Object object)

isText

public boolean isText(java.lang.Object object)

isProcessingInstruction

public boolean isProcessingInstruction(java.lang.Object object)

getCommentStringValue

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

getElementStringValue

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

getAttributeStringValue

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

getNamespaceStringValue

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

getTextStringValue

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

getNamespacePrefix

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

setListTypeIncluded

public void setListTypeIncluded(boolean included)

setIDOnly

public void setIDOnly(boolean idOnly)

setEditingTypeIncluded

public void setEditingTypeIncluded(boolean included)

setOnlySerializable

public void setOnlySerializable(boolean onlySerializable)

setEditingTypeTraversalOnly

public void setEditingTypeTraversalOnly(boolean only)

parseXPath

public org.jaxen.XPath parseXPath(java.lang.String xpath)
                           throws org.jaxen.saxpath.SAXPathException
Throws:
org.jaxen.saxpath.SAXPathException

getSelfAxisIterator

public java.util.Iterator getSelfAxisIterator(java.lang.Object contextNode)
                                       throws org.jaxen.UnsupportedAxisException
Specified by:
getSelfAxisIterator in interface org.jaxen.Navigator
Overrides:
getSelfAxisIterator in class org.jaxen.DefaultNavigator
Throws:
org.jaxen.UnsupportedAxisException

setChoosenOnly

public void setChoosenOnly(boolean choosenOnly)

getElementNamespaceUri

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