public abstract class SortedSetDocValues extends Object
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.
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. |
Modifier | Constructor and Description |
---|---|
protected |
SortedSetDocValues()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
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 (previously
set by
setDocument(int) . |
abstract void |
setDocument(int docID)
Sets iteration to the specified docID
|
TermsEnum |
termsEnum()
Returns a
TermsEnum over the values. |
public static final long NO_MORE_ORDS
nextOrd()
it means there are no more
ordinals for the document.protected SortedSetDocValues()
public abstract long nextOrd()
setDocument(int)
.NO_MORE_ORDS
.
ordinals are dense, start at 0, then increment by 1 for
the next value in sorted order.public abstract void setDocument(int docID)
docID
- document IDpublic abstract BytesRef lookupOrd(long ord)
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 lookupnextOrd()
public abstract long getValueCount()
public long lookupTerm(BytesRef key)
key
exists, returns its ordinal, else
returns -insertionPoint-1
, like Arrays.binarySearch
.key
- Key to look uppublic TermsEnum termsEnum()
TermsEnum
over the values.
The enum supports TermsEnum.ord()
and TermsEnum.seekExact(long)
.public TermsEnum intersect(CompiledAutomaton automaton) throws IOException
TermsEnum
over the values, filtered by a CompiledAutomaton
The enum supports TermsEnum.ord()
.IOException
Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.