Package org.apache.lucene.index
Class SingletonSortedSetDocValues
java.lang.Object
org.apache.lucene.index.SortedSetDocValues
org.apache.lucene.index.SingletonSortedSetDocValues
Exposes multi-valued view over a single-valued instance.
This can be used if you want to have one multi-valued implementation against e.g. FieldCache.getDocTermOrds that also works for single-valued fields.
-
Field Summary
Fields inherited from class org.apache.lucene.index.SortedSetDocValues
EMPTY, NO_MORE_ORDS
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a multi-valued view over the provided SortedDocValues -
Method Summary
Modifier and TypeMethodDescriptionReturn the wrappedSortedDocValues
long
Returns the number of unique values.void
Retrieves the value for the specified ordinal.long
lookupTerm
(BytesRef key) Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.long
nextOrd()
Returns the next ordinal for the current document (previously set bySortedSetDocValues.setDocument(int)
.void
setDocument
(int docID) Sets iteration to the specified docIDMethods inherited from class org.apache.lucene.index.SortedSetDocValues
termsEnum
-
Constructor Details
-
SingletonSortedSetDocValues
Creates a multi-valued view over the provided SortedDocValues
-
-
Method Details
-
getSortedDocValues
Return the wrappedSortedDocValues
-
nextOrd
public long nextOrd()Description copied from class:SortedSetDocValues
Returns the next ordinal for the current document (previously set bySortedSetDocValues.setDocument(int)
.- Specified by:
nextOrd
in classSortedSetDocValues
- Returns:
- next ordinal for the document, or
SortedSetDocValues.NO_MORE_ORDS
. ordinals are dense, start at 0, then increment by 1 for the next value in sorted order.
-
setDocument
public void setDocument(int docID) Description copied from class:SortedSetDocValues
Sets iteration to the specified docID- Specified by:
setDocument
in classSortedSetDocValues
- Parameters:
docID
- document ID
-
lookupOrd
Description copied from class:SortedSetDocValues
Retrieves the value for the specified ordinal.- Specified by:
lookupOrd
in classSortedSetDocValues
- Parameters:
ord
- ordinal to lookupresult
- will be populated with the ordinal's value- See Also:
-
getValueCount
public long getValueCount()Description copied from class:SortedSetDocValues
Returns the number of unique values.- Specified by:
getValueCount
in classSortedSetDocValues
- Returns:
- number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.
-
lookupTerm
Description copied from class:SortedSetDocValues
Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.- Overrides:
lookupTerm
in classSortedSetDocValues
- Parameters:
key
- Key to look up
-