com.jaxfront.core.xpath
Class DocumentNavigator

java.lang.Object
  org.jaxen.DefaultNavigator
      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.

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	isHideUnnamed()
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	setHideUnnamed(boolean hide)
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

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

getAttributeName

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

getAttributeNamespaceUri

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

getAttributeQName

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

getAttributeStringValue

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

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

getCommentStringValue

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

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

getElementName

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

getElementNamespaceUri

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

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

getElementQName

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

getElementStringValue

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

getInstance

public static org.jaxen.Navigator getInstance()

getNamespacePrefix

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

getNamespaceStringValue

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

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

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

getTextStringValue

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

isAttribute

public boolean isAttribute(java.lang.Object object)

isComment

public boolean isComment(java.lang.Object object)

isDocument

public boolean isDocument(java.lang.Object object)

isElement

public boolean isElement(java.lang.Object object)

isHideUnnamed

public boolean isHideUnnamed()

isNamespace

public boolean isNamespace(java.lang.Object object)

isProcessingInstruction

public boolean isProcessingInstruction(java.lang.Object object)

isText

public boolean isText(java.lang.Object object)

parseXPath

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

Throws:

org.jaxen.saxpath.SAXPathException

reset

public void reset()

setChoosenOnly

public void setChoosenOnly(boolean choosenOnly)

setEditingTypeIncluded

public void setEditingTypeIncluded(boolean included)

setEditingTypeTraversalOnly

public void setEditingTypeTraversalOnly(boolean only)

setHideUnnamed

public void setHideUnnamed(boolean hide)

setIDOnly

public void setIDOnly(boolean idOnly)

setListTypeIncluded

public void setListTypeIncluded(boolean included)

setOnlySerializable

public void setOnlySerializable(boolean onlySerializable)