Package org.apache.lucene.index
Class LegacySortedDocValuesWrapper
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.BinaryDocValues
-
- org.apache.lucene.index.SortedDocValues
-
- org.apache.lucene.index.LegacySortedDocValuesWrapper
-
@Deprecated public final class LegacySortedDocValuesWrapper extends SortedDocValues
Deprecated.ImplementSortedDocValues
directly.Wraps aLegacySortedDocValues
into aSortedDocValues
.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description LegacySortedDocValuesWrapper(LegacySortedDocValues values, int maxDoc)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods 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 exactlytarget
and return whethertarget
has a value.long
cost()
Deprecated.Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Deprecated.Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.int
getValueCount()
Deprecated.Returns the number of unique values.BytesRef
lookupOrd(int ord)
Deprecated.Retrieves the value for the specified ordinal.int
nextDoc()
Deprecated.Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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
ordValue()
Deprecated.Returns the ordinal for the current docID.-
Methods inherited from class org.apache.lucene.index.SortedDocValues
binaryValue, intersect, lookupTerm, termsEnum
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Constructor Detail
-
LegacySortedDocValuesWrapper
public LegacySortedDocValuesWrapper(LegacySortedDocValues values, int maxDoc)
Deprecated.
-
-
Method Detail
-
docID
public int docID()
Deprecated.Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.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 classDocIdSetIterator
-
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, orDocIdSetIterator.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 classDocIdSetIterator
-
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 returnsDocIdSetIterator.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 classDocIdSetIterator
-
advanceExact
public boolean advanceExact(int target) throws IOException
Deprecated.Advance the iterator to exactlytarget
and return whethertarget
has a value.target
must be greater than or equal to the currentdoc ID
and must be a valid doc ID, ie. ≥ 0 and <maxDoc
. After this method returns,DocIdSetIterator.docID()
retunstarget
.- Throws:
IOException
-
cost
public long cost()
Deprecated.Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.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 classDocIdSetIterator
-
ordValue
public int ordValue()
Deprecated.Description copied from class:SortedDocValues
Returns the ordinal for the current docID. It is illegal to call this method afteradvanceExact(int)
returnedfalse
.- Specified by:
ordValue
in classSortedDocValues
- Returns:
- ordinal for the document: this is dense, starts at 0, then increments by 1 for the next value in sorted order.
-
lookupOrd
public BytesRef lookupOrd(int ord)
Deprecated.Description copied from class:SortedDocValues
Retrieves the value for the specified ordinal. The returnedBytesRef
may be re-used across calls toSortedDocValues.lookupOrd(int)
so make sure tocopy it
if you want to keep it around.- Specified by:
lookupOrd
in classSortedDocValues
- Parameters:
ord
- ordinal to lookup (must be >= 0 and <SortedDocValues.getValueCount()
)- See Also:
SortedDocValues.ordValue()
-
getValueCount
public int getValueCount()
Deprecated.Description copied from class:SortedDocValues
Returns the number of unique values.- Specified by:
getValueCount
in classSortedDocValues
- Returns:
- number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.
-
-