Package org.apache.lucene.queries.intervals

Class OrderedIntervalsSource.OrderedIntervalIterator

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.OrderedIntervalsSource.OrderedIntervalIterator

Enclosing class:

OrderedIntervalsSource

private static class OrderedIntervalsSource.OrderedIntervalIterator
extends ConjunctionIntervalIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	end
(package private) int	i
(package private) int	slop
(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

Modifier	Constructor	Description
private	OrderedIntervalIterator(java.util.List<IntervalIterator> subIntervals)

Method Summary

Modifier and Type	Method	Description
int	end()	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.
int	gaps()	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.
int	nextInterval()	Advance the iterator to the next interval
protected void	reset()
int	start()	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.

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 Detail

start

int start

end

int end

i

int i

slop

int slop

Constructor Detail

OrderedIntervalIterator

private OrderedIntervalIterator(java.util.List<IntervalIterator> subIntervals)

Method Detail

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

nextInterval

public int nextInterval()
                 throws java.io.IOException

Description copied from class: IntervalIterator

Advance the iterator to the next interval

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:

java.io.IOException

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

reset

protected void reset()
              throws java.io.IOException

Specified by:

reset in class ConjunctionIntervalIterator

Throws:

java.io.IOException