org.apache.lucene.search

Interface MatchesIterator

public interface MatchesIterator

An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, call next() until it returns false, retrieving positions and/or offsets after each call. You should not call the position or offset methods before next() has been called, or after next() has returned false. Matches are ordered by start position, and then by end position. Match intervals may overlap.

See Also:

Weight.matches(LeafReaderContext, int)

WARNING: This API is experimental and might change in incompatible ways in the next release.

Method Summary

Modifier and Type	Method and Description
int	endOffset() The ending offset of the current match, or -1 if offsets are not available Should only be called after next() has returned true
int	endPosition() The end position of the current match Should only be called after next() has returned true
boolean	next() Advance the iterator to the next match position
int	startOffset() The starting offset of the current match, or -1 if offsets are not available Should only be called after next() has returned true
int	startPosition() The start position of the current match Should only be called after next() has returned true

Method Detail

next

boolean next()
      throws IOException

Advance the iterator to the next match position

Returns:

true if matches have not been exhausted

Throws:

IOException

startPosition

int startPosition()

The start position of the current match Should only be called after next() has returned true

endPosition

int endPosition()

The end position of the current match Should only be called after next() has returned true

startOffset

int startOffset()
         throws IOException

The starting offset of the current match, or -1 if offsets are not available Should only be called after next() has returned true

Throws:

IOException

endOffset

int endOffset()
       throws IOException

The ending offset of the current match, or -1 if offsets are not available Should only be called after next() has returned true

Throws:

IOException