Package org.apache.lucene.index
Class SortedSetDocValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.DocValuesIterator
-
- org.apache.lucene.index.SortedSetDocValues
-
- Direct Known Subclasses:
FilterSortedSetDocValues
,LegacySortedSetDocValuesWrapper
,Lucene70DocValuesProducer.BaseSortedSetDocValues
,Lucene80DocValuesProducer.BaseSortedSetDocValues
,MultiDocValues.MultiSortedSetDocValues
,SingletonSortedSetDocValues
,SortedSetDocValuesWriter.BufferedSortedSetDocValues
,SortedSetDocValuesWriter.SortingSortedSetDocValues
public abstract class SortedSetDocValues extends DocValuesIterator
A multi-valued version ofSortedDocValues
.Per-Document values in a SortedSetDocValues 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
When returned bynextOrd()
it means there are no more ordinals for the document.-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SortedSetDocValues()
Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract long
getValueCount()
Returns the number of unique values.TermsEnum
intersect(CompiledAutomaton automaton)
Returns aTermsEnum
over the values, filtered by aCompiledAutomaton
The enum supportsTermsEnum.ord()
.abstract BytesRef
lookupOrd(long ord)
Retrieves the value for the specified ordinal.long
lookupTerm(BytesRef key)
Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.abstract long
nextOrd()
Returns the next ordinal for the current document.TermsEnum
termsEnum()
Returns aTermsEnum
over the values.-
Methods inherited from class org.apache.lucene.index.DocValuesIterator
advanceExact
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
advance, all, cost, docID, empty, nextDoc, range, slowAdvance
-
-
-
-
Field Detail
-
NO_MORE_ORDS
public static final long NO_MORE_ORDS
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() throws java.io.IOException
Returns the next ordinal for the current document. It is illegal to call this method afterDocValuesIterator.advanceExact(int)
returnedfalse
.- 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. - Throws:
java.io.IOException
-
lookupOrd
public abstract BytesRef lookupOrd(long ord) throws java.io.IOException
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- Throws:
java.io.IOException
- See Also:
nextOrd()
-
getValueCount
public abstract long getValueCount()
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) throws java.io.IOException
Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.- Parameters:
key
- Key to look up- Throws:
java.io.IOException
-
termsEnum
public TermsEnum termsEnum() throws java.io.IOException
Returns aTermsEnum
over the values. The enum supportsTermsEnum.ord()
andTermsEnum.seekExact(long)
.- Throws:
java.io.IOException
-
intersect
public TermsEnum intersect(CompiledAutomaton automaton) throws java.io.IOException
Returns aTermsEnum
over the values, filtered by aCompiledAutomaton
The enum supportsTermsEnum.ord()
.- Throws:
java.io.IOException
-
-