Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jaxen.expr.iter

Class IterableAxis

Implemented Interfaces:
Serializable
Known Direct Subclasses:
IterableAncestorAxis, IterableAncestorOrSelfAxis, IterableAttributeAxis, IterableChildAxis, IterableDescendantAxis, IterableDescendantOrSelfAxis, IterableFollowingAxis, IterableFollowingSiblingAxis, IterableNamespaceAxis, IterableParentAxis, IterablePrecedingAxis, IterablePrecedingSiblingAxis, IterableSelfAxis
public abstract class IterableAxis
extends java.lang.Object
implements Serializable
Provide access to the XPath axes.
Authors:
Bob McWhirter
James Strachan
Stephen Colebourne

Field Summary

private int
value
The axis type

Constructor Summary

IterableAxis(int axisValue)
Constructor.

Method Summary

abstract Iterator
iterator(Object contextNode, ContextSupport support)
Gets the iterator for a specific XPath axis.
Iterator
namedAccessIterator(Object contextNode, ContextSupport support, String localName, String namespacePrefix, String namespaceURI)
Gets the iterator for a specific XPath axis that supports named access.
boolean
supportsNamedAccess(ContextSupport support)
Does this axis support named access?
int
value()
Gets the axis value.

Field Details

value

private int value
The axis type

Constructor Details

IterableAxis

public IterableAxis(int axisValue)
Constructor.
Parameters:
axisValue -

Method Details

iterator

public abstract Iterator iterator(Object contextNode,
                                  ContextSupport support)
            throws UnsupportedAxisException
Gets the iterator for a specific XPath axis.
Parameters:
contextNode - the current context node to work from
support - the additional context information
Returns:
an iterator for the axis
Throws:
UnsupportedAxisException -

namedAccessIterator

public Iterator namedAccessIterator(Object contextNode,
                                    ContextSupport support,
                                    String localName,
                                    String namespacePrefix,
                                    String namespaceURI)
            throws UnsupportedAxisException
Gets the iterator for a specific XPath axis that supports named access.
Parameters:
contextNode - the current context node to work from
support - the additional context information
localName - the local name of the nodes to return
namespacePrefix - the prefix of the namespace of the nodes to return
namespaceURI - the URI of the namespace of the nodes to return

supportsNamedAccess

public boolean supportsNamedAccess(ContextSupport support)
Does this axis support named access?
Parameters:
support - the additional context information
Returns:
true if named access supported. If not iterator() will be used

value

public int value()
Gets the axis value.
Returns:
the axis value

Overview Package Class Use Tree Index Deprecated About