org.sindice.siren.index

Interface PositionsIterator

All Known Implementing Classes:

ConstrainedNodesEnum, DocsNodesAndPositionsEnum, IntervalConstrainedNodesEnum, LevelConstrainedNodesEnum, MappingMultiDocsNodesAndPositionsEnum, MultiDocsNodesAndPositionsEnum, SingleIntervalConstrainedNodesEnum

public interface PositionsIterator

This interface defines methods to iterate over a set of increasing positions.

This class iterates on positions. The sentinel value NO_MORE_POS (which is set to 2147483647) is used to indicate the end of the position stream.

To be used in conjunction with DocsAndNodesIterator.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_MORE_POS When returned by pos() it means there are no more positions in the iterator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	nextPosition() Move to the next position in the current node matching the query.
int	pos() Returns the following: -1 or NO_MORE_POS if nextPosition() were not called yet.

Field Detail

NO_MORE_POS

static final int NO_MORE_POS

When returned by pos() it means there are no more positions in the iterator.

See Also:

Constant Field Values

Method Detail

nextPosition

boolean nextPosition()
                     throws IOException

Move to the next position in the current node matching the query.

Should not be called until DocsAndNodesIterator.nextNode() or DocsAndNodesIterator#skipTo(int, int) are called for the first time.

Returns:

false if there is no more position for the current node or if DocsAndNodesIterator.nextNode() or DocsAndNodesIterator#skipTo(int, int) were not called yet.

Throws:

IOException

pos

int pos()

Returns the following:

• -1 or NO_MORE_POS if nextPosition() were not called yet.
• NO_MORE_POS if the iterator has exhausted.
• Otherwise it should return the position it is currently on.