public abstract class SortedSetDocValues extends DocIdSetIterator
SortedDocValues
.
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.
Modifier and Type | Field and Description |
---|---|
static long |
NO_MORE_ORDS
When returned by
nextOrd() it means there are no more
ordinals for the document. |
NO_MORE_DOCS
Modifier | Constructor and Description |
---|---|
protected |
SortedSetDocValues()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
abstract boolean |
advanceExact(int target)
Advance the iterator to exactly
target and return whether
target has a value. |
abstract long |
getValueCount()
Returns the number of unique values.
|
TermsEnum |
intersect(CompiledAutomaton automaton)
Returns a
TermsEnum over the values, filtered by a CompiledAutomaton
The enum supports TermsEnum.ord() . |
abstract BytesRef |
lookupOrd(long ord)
Retrieves the value for the specified ordinal.
|
long |
lookupTerm(BytesRef key)
If
key exists, returns its ordinal, else
returns -insertionPoint-1 , like Arrays.binarySearch . |
abstract long |
nextOrd()
Returns the next ordinal for the current document.
|
TermsEnum |
termsEnum()
Returns a
TermsEnum over the values. |
advance, all, cost, docID, empty, nextDoc, range, slowAdvance
public static final long NO_MORE_ORDS
nextOrd()
it means there are no more
ordinals for the document.protected SortedSetDocValues()
public abstract long nextOrd() throws
advanceExact(int)
returned false
.NO_MORE_ORDS
.
ordinals are dense, start at 0, then increment by 1 for
the next value in sorted order.
public abstract BytesRef lookupOrd(long ord) throws
BytesRef
may be re-used across calls to lookupOrd so make sure to
copy it
if you want to keep it
around.ord
- ordinal to lookup
nextOrd()
public abstract long getValueCount()
public long lookupTerm(BytesRef key) throws
key
exists, returns its ordinal, else
returns -insertionPoint-1
, like Arrays.binarySearch
.key
- Key to look up
public TermsEnum termsEnum() throws
TermsEnum
over the values.
The enum supports TermsEnum.ord()
and TermsEnum.seekExact(long)
.
public TermsEnum intersect(CompiledAutomaton automaton) throws
TermsEnum
over the values, filtered by a CompiledAutomaton
The enum supports TermsEnum.ord()
.
public abstract boolean advanceExact(int target) throws
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
.
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.