Module org.apache.lucene.queries

Package org.apache.lucene.queries.intervals

Class CachingMatchesIterator

java.lang.Object

org.apache.lucene.search.FilterMatchesIterator

org.apache.lucene.queries.intervals.CachingMatchesIterator

All Implemented Interfaces:

IntervalMatchesIterator, MatchesIterator

class CachingMatchesIterator
extends FilterMatchesIterator
implements IntervalMatchesIterator

Field Summary

Fields

Modifier and Type	Field	Description
private int	count
private Query[]	matchingQueries
private int[]	posAndOffsets

Fields inherited from class org.apache.lucene.search.FilterMatchesIterator

in

Constructor Summary

Constructors

Constructor	Description
CachingMatchesIterator(IntervalMatchesIterator in)

Method Summary

Modifier and Type	Method	Description
(package private) void	cache()
int	endOffset()	The ending offset of the current match, or -1 if offsets are not available
int	gaps()	The number of top-level gaps inside the current match
Query	getQuery()	Returns the Query causing the current match
MatchesIterator	getSubMatches()	Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match
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
int	width()	The width of the current match

Methods inherited from class org.apache.lucene.search.FilterMatchesIterator

endPosition, startPosition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.search.MatchesIterator

endPosition, startPosition

Field Details

posAndOffsets

private int[] posAndOffsets

matchingQueries

private Query[] matchingQueries

count

private int count

Constructor Details

CachingMatchesIterator

CachingMatchesIterator(IntervalMatchesIterator in)

Method Details

cache

void cache()
    throws IOException

Throws:

IOException

next

public boolean next()
             throws IOException

Description copied from interface: MatchesIterator

Advance the iterator to the next match position

Specified by:

next in interface MatchesIterator

Overrides:

next in class FilterMatchesIterator

Returns:

true if matches have not been exhausted

Throws:

IOException

startOffset

public int startOffset()
                throws IOException

Description copied from interface: MatchesIterator

The starting offset of the current match, or -1 if offsets are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

startOffset in interface MatchesIterator

Overrides:

startOffset in class FilterMatchesIterator

Throws:

IOException

endOffset

public int endOffset()
              throws IOException

Description copied from interface: MatchesIterator

The ending offset of the current match, or -1 if offsets are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

endOffset in interface MatchesIterator

Overrides:

endOffset in class FilterMatchesIterator

Throws:

IOException

getSubMatches

public MatchesIterator getSubMatches()

Description copied from interface: MatchesIterator

Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match

Returns null if there are no submatches (ie the current iterator is at the leaf level)

Should only be called after MatchesIterator.next() has returned true

Specified by:

getSubMatches in interface MatchesIterator

Overrides:

getSubMatches in class FilterMatchesIterator

getQuery

public Query getQuery()

Description copied from interface: MatchesIterator

Returns the Query causing the current match

If this MatchesIterator has been returned from a MatchesIterator.getSubMatches() call, then returns a TermQuery equivalent to the current match

Should only be called after MatchesIterator.next() has returned true

Specified by:

getQuery in interface MatchesIterator

Overrides:

getQuery in class FilterMatchesIterator

gaps

public int gaps()

Description copied from interface: IntervalMatchesIterator

The number of top-level gaps inside the current match

Specified by:

gaps in interface IntervalMatchesIterator

See Also:

• IntervalIterator.gaps()

width

public int width()

Description copied from interface: IntervalMatchesIterator

The width of the current match

Specified by:

width in interface IntervalMatchesIterator

See Also:

• IntervalIterator.width()