Package org.apache.lucene.index
Class LegacySortedSetDocValues
- java.lang.Object
-
- org.apache.lucene.index.LegacySortedSetDocValues
-
@Deprecated public abstract class LegacySortedSetDocValues extends Object
Deprecated.UseSortedSetDocValues
instead.A per-document set of presorted byte[] 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.
-
-
Field Summary
Fields Modifier and Type Field Description static long
NO_MORE_ORDS
Deprecated.When returned bynextOrd()
it means there are no more ordinals for the document.
-
Constructor Summary
Constructors Modifier Constructor Description protected
LegacySortedSetDocValues()
Deprecated.Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract long
getValueCount()
Deprecated.Returns the number of unique values.abstract BytesRef
lookupOrd(long ord)
Deprecated.Retrieves the value for the specified ordinal.long
lookupTerm(BytesRef key)
Deprecated.Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.abstract long
nextOrd()
Deprecated.Returns the next ordinal for the current document (previously set bysetDocument(int)
.abstract void
setDocument(int docID)
Deprecated.Sets iteration to the specified docIDTermsEnum
termsEnum()
Deprecated.Returns aTermsEnum
over the values.
-
-
-
Field Detail
-
NO_MORE_ORDS
public static final long NO_MORE_ORDS
Deprecated.When returned bynextOrd()
it means there are no more ordinals for the document.- See Also:
- Constant Field Values
-
-
Method Detail
-
nextOrd
public abstract long nextOrd()
Deprecated.Returns the next ordinal for the current document (previously set bysetDocument(int)
.- Returns:
- next ordinal for the document, or
NO_MORE_ORDS
. ordinals are dense, start at 0, then increment by 1 for the next value in sorted order.
-
setDocument
public abstract void setDocument(int docID)
Deprecated.Sets iteration to the specified docID- Parameters:
docID
- document ID
-
lookupOrd
public abstract BytesRef lookupOrd(long ord)
Deprecated.Retrieves the value for the specified ordinal. The returnedBytesRef
may be re-used across calls to lookupOrd so make sure tocopy it
if you want to keep it around.- Parameters:
ord
- ordinal to lookup- See Also:
nextOrd()
-
getValueCount
public abstract long 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.
-
lookupTerm
public long 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() throws IOException
Deprecated.Returns aTermsEnum
over the values. The enum supportsTermsEnum.ord()
andTermsEnum.seekExact(long)
.- Throws:
IOException
-
-