FileDocCategorySizeDatePackage
Spans.javaAPI DocApache Lucene 2.1.02092Wed Feb 14 10:46:38 GMT 2007org.apache.lucene.search.spans

Spans

public interface Spans
Expert: an enumeration of span matches. Used to implement span searching. Each span represents a range of term positions within a document. Matches are enumerated in order, by increasing document number, within that by increasing start position and finally by increasing end position.

Fields Summary
Constructors Summary
Methods Summary
public intdoc()
Returns the document number of the current match. Initially invalid.

public intend()
Returns the end position of the current match. Initially invalid.

public booleannext()
Move to the next match, returning true iff any such exists.

public booleanskipTo(int target)
Skips to the first match beyond the current, whose document number is greater than or equal to target.

Returns true iff there is such a match.

Behaves as if written:

boolean skipTo(int target) {
do {
if (!next())
return false;
} while (target > doc());
return true;
}
Most implementations are considerably more efficient than that.

public intstart()
Returns the start position of the current match. Initially invalid.