Package org.apache.lucene.codecs.memory

Class LegacySortedNumericDocValuesWrapper

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.DocValuesIterator

org.apache.lucene.index.SortedNumericDocValues

org.apache.lucene.codecs.memory.LegacySortedNumericDocValuesWrapper

@Deprecated
final class LegacySortedNumericDocValuesWrapper
extends SortedNumericDocValues

Deprecated.

Implement SortedNumericDocValues directly.

Wraps a LegacySortedNumericDocValues into a SortedNumericDocValues.

Field Summary

Fields

Modifier and Type	Field	Description
private int	docID	Deprecated.
private int	maxDoc	Deprecated.
private int	upto	Deprecated.
private LegacySortedNumericDocValues	values	Deprecated.

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
LegacySortedNumericDocValuesWrapper(LegacySortedNumericDocValues values, int maxDoc)	Deprecated.

Method Summary

Modifier and Type	Method	Description
int	advance(int target)	Deprecated. Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
boolean	advanceExact(int target)	Deprecated. Advance the iterator to exactly target and return whether target has a value.
long	cost()	Deprecated. Returns the estimated cost of this DocIdSetIterator.
int	docID()	Deprecated. Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
int	docValueCount()	Deprecated. Retrieves the number of values for the current document.
int	nextDoc()	Deprecated. 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.
long	nextValue()	Deprecated. Iterates to the next value in the current document.

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, toString, wait, wait, wait

Field Detail

values

private final LegacySortedNumericDocValues values

Deprecated.

maxDoc

private final int maxDoc

Deprecated.

docID

private int docID

Deprecated.

upto

private int upto

Deprecated.

Constructor Detail

LegacySortedNumericDocValuesWrapper

public LegacySortedNumericDocValuesWrapper(LegacySortedNumericDocValues values,
                                           int maxDoc)

Deprecated.

Method Detail

docID

public int docID()

Deprecated.

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()

Deprecated.

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

advance

public int advance(int target)

Deprecated.

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

advanceExact

public boolean advanceExact(int target)
                     throws java.io.IOException

Deprecated.

Description copied from class: DocValuesIterator

Advance the iterator to exactly target and return whether target has a value. target must be greater than or equal to the current doc ID and must be a valid doc ID, ie. ≥ 0 and < maxDoc. After this method returns, DocIdSetIterator.docID() returns target.

Specified by:

advanceExact in class DocValuesIterator

Throws:

java.io.IOException

cost

public long cost()

Deprecated.

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

nextValue

public long nextValue()

Deprecated.

Description copied from class: SortedNumericDocValues

Iterates to the next value in the current document. Do not call this more than SortedNumericDocValues.docValueCount() times for the document.

Specified by:

nextValue in class SortedNumericDocValues

docValueCount

public int docValueCount()

Deprecated.

Description copied from class: SortedNumericDocValues

Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method after DocValuesIterator.advanceExact(int) returned false.

Specified by:

docValueCount in class SortedNumericDocValues