Module org.apache.lucene.queries

Package org.apache.lucene.queries.intervals

Class RepeatingIntervalsSource.DuplicateIntervalIterator

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.queries.intervals.IntervalIterator

org.apache.lucene.queries.intervals.RepeatingIntervalsSource.DuplicateIntervalIterator

Enclosing class:

RepeatingIntervalsSource

private static class RepeatingIntervalsSource.DuplicateIntervalIterator
extends IntervalIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int[]	cache
(package private) int	cacheBase
(package private) final int	cacheLength
(package private) boolean	exhausted
private final IntervalIterator	in
(package private) boolean	started

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	DuplicateIntervalIterator(IntervalIterator primary, int copies)

Method Summary

Modifier and Type	Method	Description
int	advance(int target)	Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
private int	cacheNextInterval(int linePos)
long	cost()	Returns the estimated cost of this DocIdSetIterator.
int	docID()	Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
int	end()	The end of the current interval
int	gaps()	The number of gaps within the current interval
float	matchCost()	An indication of the average cost of iterating over all intervals in a document
int	nextDoc()	Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set. NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
int	nextInterval()	Advance the iterator to the next interval
int	start()	The start of the current interval
int	width()	The width of the current interval

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

toString

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

in

private final IntervalIterator in

cache

final int[] cache

cacheLength

final int cacheLength

cacheBase

int cacheBase

started

boolean started

exhausted

boolean exhausted

Constructor Details

DuplicateIntervalIterator

private DuplicateIntervalIterator(IntervalIterator primary,
 int copies)

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

width

public int width()

Description copied from class: IntervalIterator

The width of the current interval

Overrides:

width 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

cacheNextInterval

private int cacheNextInterval(int linePos)
                       throws IOException

Throws:

IOException

matchCost

public float matchCost()

Description copied from class: IntervalIterator

An indication of the average cost of iterating over all intervals in a document

Specified by:

matchCost in class IntervalIterator

See Also:

• TwoPhaseIterator.matchCost()

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
• DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
• Otherwise it should return the doc ID it is currently on.

Specified by:

docID in class DocIdSetIterator

nextDoc

public int nextDoc()
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Specified by:

nextDoc in class DocIdSetIterator

Throws:

IOException

advance

public int advance(int target)
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

The behavior of this method is undefined when called with target ≤ current , or after the iterator has exhausted. Both cases may result in unpredicted behavior.

When target > current it behaves as if written:

 int advance(int target) {
   int doc;
   while ((doc = nextDoc()) < target) {
   }
   return doc;
 }
 

Some implementations are considerably more efficient than that.

NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

Specified by:

advance in class DocIdSetIterator

Throws:

IOException

cost

public long cost()

Description copied from class: DocIdSetIterator

Returns the estimated cost of this DocIdSetIterator.

This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

Specified by:

cost in class DocIdSetIterator