org.basex.index

Class IndexIterator

java.lang.Object

org.basex.index.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

Fields

Modifier and Type	Field and Description
static IndexIterator	EMPTY Empty iterator.

Constructor Summary

Constructors

Constructor and Description
IndexIterator()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	more() Returns true if more results are found.
abstract int	next() Returns the next result.
abstract double	score() Returns the score value.
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

score

public abstract double score()

Returns the score value. -1 is returned if no scoring is available.

Returns:

score value

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