org.basex.index.query
Class IndexIterator

java.lang.Object
  extended by org.basex.index.query.IndexIterator
Direct Known Subclasses:
FTIndexIterator

public abstract class IndexIterator
extends java.lang.Object

This interface provides methods for returning index results.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary
static IndexIterator EMPTY
          Empty iterator.
 
Constructor Summary
IndexIterator()
           
 
Method Summary
abstract  boolean more()
          Returns true if more results are found.
abstract  int next()
          Returns the next result.
 int size()
          Returns the total number of index results.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY

public static final IndexIterator EMPTY
Empty iterator.

Constructor Detail

IndexIterator

public IndexIterator()
Method Detail

more

public abstract boolean more()
Returns true if more results are found.

Returns:
size

next

public abstract int next()
Returns the next result.

Returns:
result

size

public int size()
Returns the total number of index results. The iterator may get exhausted by calling this method.

Returns:
result number of results