Package org.apache.lucene.index
Class LegacySortedDocValues
- java.lang.Object
-
- org.apache.lucene.index.LegacyBinaryDocValues
-
- org.apache.lucene.index.LegacySortedDocValues
-
@Deprecated public abstract class LegacySortedDocValues extends LegacyBinaryDocValues
Deprecated.UseSortedDocValues
instead.A per-document byte[] with presorted values.Per-Document values in a SortedDocValues are deduplicated, dereferenced, and sorted into a dictionary of unique values. A pointer to the dictionary value (ordinal) can be retrieved for each document. Ordinals are dense and in increasing sorted order.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
LegacySortedDocValues()
Deprecated.Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BytesRef
get(int docID)
Deprecated.Lookup the value for document.abstract int
getOrd(int docID)
Deprecated.Returns the ordinal for the specified docID.abstract int
getValueCount()
Deprecated.Returns the number of unique values.abstract BytesRef
lookupOrd(int ord)
Deprecated.Retrieves the value for the specified ordinal.int
lookupTerm(BytesRef key)
Deprecated.Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.TermsEnum
termsEnum()
Deprecated.Returns aTermsEnum
over the values.
-
-
-
Method Detail
-
getOrd
public abstract int getOrd(int docID)
Deprecated.Returns the ordinal for the specified docID.- Parameters:
docID
- document ID to lookup- Returns:
- ordinal for the document: this is dense, starts at 0, then increments by 1 for the next value in sorted order. Note that missing values are indicated by -1.
-
lookupOrd
public abstract BytesRef lookupOrd(int ord)
Deprecated.Retrieves the value for the specified ordinal. The returnedBytesRef
may be re-used across calls tolookupOrd(int)
so make sure tocopy it
if you want to keep it around.- Parameters:
ord
- ordinal to lookup (must be >= 0 and <getValueCount()
)- See Also:
getOrd(int)
-
getValueCount
public abstract int getValueCount()
Deprecated.Returns the number of unique values.- Returns:
- number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.
-
get
public BytesRef get(int docID)
Deprecated.Description copied from class:LegacyBinaryDocValues
Lookup the value for document. The returnedBytesRef
may be re-used across calls toLegacyBinaryDocValues.get(int)
so make sure tocopy it
if you want to keep it around.- Specified by:
get
in classLegacyBinaryDocValues
-
lookupTerm
public int lookupTerm(BytesRef key)
Deprecated.Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.- Parameters:
key
- Key to look up
-
termsEnum
public TermsEnum termsEnum()
Deprecated.Returns aTermsEnum
over the values. The enum supportsTermsEnum.ord()
andTermsEnum.seekExact(long)
.
-
-