Module org.apache.lucene.queries

Package org.apache.lucene.queries.intervals

Class BlockIntervalsSource.BlockIntervalIterator

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.queries.intervals.IntervalIterator

org.apache.lucene.queries.intervals.ConjunctionIntervalIterator

org.apache.lucene.queries.intervals.BlockIntervalsSource.BlockIntervalIterator

Enclosing class:

BlockIntervalsSource

private static class BlockIntervalsSource.BlockIntervalIterator
extends ConjunctionIntervalIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	end
(package private) int	start

Fields inherited from class org.apache.lucene.queries.intervals.ConjunctionIntervalIterator

approximation, cost, subIterators

Fields inherited from class org.apache.lucene.queries.intervals.IntervalIterator

NO_MORE_INTERVALS

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
BlockIntervalIterator(List<IntervalIterator> subIterators)

Method Summary

Modifier and Type	Method	Description
int	end()	The end of the current interval
int	gaps()	The number of gaps within the current interval
int	nextInterval()	Advance the iterator to the next interval
protected void	reset()
int	start()	The start of the current interval

Methods inherited from class org.apache.lucene.queries.intervals.ConjunctionIntervalIterator

advance, cost, docID, matchCost, nextDoc

Methods inherited from class org.apache.lucene.queries.intervals.IntervalIterator

toString, width

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

all, empty, range, slowAdvance

Methods inherited from class java.lang.Object

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

Field Details

start

int start

end

int end

Constructor Details

BlockIntervalIterator

BlockIntervalIterator(List<IntervalIterator> subIterators)

Method Details

start

public int start()

Description copied from class: IntervalIterator

The start of the current interval

Returns -1 if IntervalIterator.nextInterval() has not yet been called and IntervalIterator.NO_MORE_INTERVALS once the iterator is exhausted.

Specified by:

start in class IntervalIterator

end

public int end()

Description copied from class: IntervalIterator

The end of the current interval

Returns -1 if IntervalIterator.nextInterval() has not yet been called and IntervalIterator.NO_MORE_INTERVALS once the iterator is exhausted.

Specified by:

end in class IntervalIterator

gaps

public int gaps()

Description copied from class: IntervalIterator

The number of gaps within the current interval

Note that this returns the number of gaps between the immediate sub-intervals of this interval, and does not include the gaps inside those sub-intervals.

Should not be called before IntervalIterator.nextInterval(), or after it has returned IntervalIterator.NO_MORE_INTERVALS

Specified by:

gaps in class IntervalIterator

nextInterval

public int nextInterval()
                 throws IOException

Description copied from class: IntervalIterator

Advance the iterator to the next interval

Should not be called after DocIdSetIterator.NO_MORE_DOCS is returned by DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int). If that's the case in some existing code, please consider opening an issue. However, after IntervalIterator.NO_MORE_INTERVALS is returned by this method, it might be called again.

Specified by:

nextInterval in class IntervalIterator

Returns:

the start of the next interval, or IntervalIterator.NO_MORE_INTERVALS if there are no more intervals on the current document

Throws:

IOException

reset

protected void reset()

Specified by:

reset in class ConjunctionIntervalIterator