Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.jxpath.ri.axes
Class NodeSetContext

    java.lang.Object
      org.apache.commons.jxpath.ri.EvalContext
          org.apache.commons.jxpath.ri.axes.NodeSetContext

All Implemented Interfaces:
  Iterator, ExpressionContext

Direct Known Subclasses:
  UnionContext

    public class NodeSetContext

extends EvalContext

A simple context that is based on a `NodeSet`.

Version:
  $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
Author:
  Dmitri Plotnikov

Field Summary

Fields inherited from class org.apache.commons.jxpath.ri.EvalContext
`parentContext, position, rootContext`

Constructor Summary
`NodeSetContext(EvalContext parentContext, NodeSet nodeSet)` Create a new NodeSetContext.

Method Summary
`NodePointer` | `getCurrentNodePointer()` Returns the current context node.
`NodeSet` | `getNodeSet()` Returns the list of all Pointers in this context for all positions of the parent contexts.
`boolean` | `nextNode()` Returns true if there is another object in the current set.
`boolean` | `nextSet()` Returns true if there is another sets of objects to interate over.
`boolean` | `setPosition(int position)` Moves the current position to the specified index.

Methods inherited from class org.apache.commons.jxpath.ri.EvalContext
`getContextNodeList, getContextNodePointer, getCurrentPosition, getDocumentOrder, getJXPathContext, getPosition, getRootContext, getSingleNodePointer, getValue, hasNext, isChildOrderingRequired, next, remove, reset, sortPointers, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### NodeSetContext

    public NodeSetContext(EvalContext parentContext,
                          NodeSet nodeSet)

  Create a new NodeSetContext.

  Parameters:
    `parentContext` - parent context
    `nodeSet` - associated NodeSet

Method Detail

### getNodeSet

    public NodeSet getNodeSet()

  Description copied from class: `EvalContext`
  Returns the list of all Pointers in this context for all positions of the parent contexts. If there was an ongoing iteration over this context, the method should not be called.

  Overrides:
    `getNodeSet` in class `EvalContext`
  Returns:
    NodeSet

### getCurrentNodePointer

    public NodePointer getCurrentNodePointer()

  Description copied from class: `EvalContext`
  Returns the current context node. Undefined before the beginning of the iteration.

  Specified by:
    `getCurrentNodePointer` in class `EvalContext`
  Returns:
    NodePoiner

### setPosition

    public boolean setPosition(int position)

  Description copied from class: `EvalContext`
  Moves the current position to the specified index. Used with integer predicates to quickly get to the n'th element of the node set. Returns false if the position is out of the node set range. You can call it with 0 as the position argument to restart the iteration.

  Overrides:
    `setPosition` in class `EvalContext`
  Parameters:
    `position` - to set
  Returns:
    boolean

### nextSet

    public boolean nextSet()

  Description copied from class: `EvalContext`
  Returns true if there is another sets of objects to interate over. Resets the current position and node.

  Overrides:
    `nextSet` in class `EvalContext`
  Returns:
    boolean

### nextNode

    public boolean nextNode()

  Description copied from class: `EvalContext`
  Returns true if there is another object in the current set. Switches the current position and node to the next object.

  Specified by:
    `nextNode` in class `EvalContext`
  Returns:
    boolean

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2008 The Apache Software Foundation. All Rights Reserved.