Class IterableAxis

java.lang.Object
org.jaxen.expr.iter.IterableAxis
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
IterableAncestorAxis, IterableAncestorOrSelfAxis, IterableAttributeAxis, IterableChildAxis, IterableDescendantAxis, IterableDescendantOrSelfAxis, IterableFollowingAxis, IterableFollowingSiblingAxis, IterableNamespaceAxis, IterableParentAxis, IterablePrecedingAxis, IterablePrecedingSiblingAxis, IterableSelfAxis

public abstract class IterableAxis extends Object implements Serializable
Provide access to the XPath axes.
Author:
Bob McWhirter, James Strachan, Stephen Colebourne
See Also:
  • Constructor Details

    • IterableAxis

      public IterableAxis(int axisValue)
      Constructor.
      Parameters:
      axisValue -
  • Method Details

    • value

      public int value()
      Gets the numeric constant for the axis.
      Returns:
      the axis value
    • 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 - if the axis is not iterable
    • 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
      Throws:
      UnsupportedAxisException - always until overridden
    • 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.