Class SortedDocValues

A per-document byte[] with presorted 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.
Inheritance
object
BinaryDocValues
SortedDocValues
MultiDocValues.MultiSortedDocValues
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class SortedDocValues : BinaryDocValues

Constructors

SortedDocValues()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration
protected SortedDocValues()

Properties

ValueCount

Returns the number of unique values.

Declaration
public abstract int ValueCount { get; }
Property Value
Type Description
int

Number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

Methods

Get(int, BytesRef)

Lookup the value for document.

Declaration
public override void Get(int docID, BytesRef result)
Parameters
Type Name Description
int docID
BytesRef result
Overrides

GetOrd(int)

Returns the ordinal for the specified docID.

Declaration
public abstract int GetOrd(int docID)
Parameters
Type Name Description
int docID

document ID to lookup
Returns
Type Description
int

ordinal for the document: this is dense, starts at 0, then increments by 1 for the next value in sorted order. Note that missing values are indicated by -1.

GetTermsEnum()

Returns a TermsEnum over the values. The enum supports Ord and SeekExact(long).

Declaration
public virtual TermsEnum GetTermsEnum()
Returns
Type Description
TermsEnum

LookupOrd(int, BytesRef)

Retrieves the value for the specified ordinal.

Declaration
public abstract void LookupOrd(int ord, BytesRef result)
Parameters
Type Name Description
int ord

ordinal to lookup (must be >= 0 and < ValueCount)
BytesRef result

will be populated with the ordinal's value
See Also

LookupTerm(BytesRef)

If key exists, returns its ordinal, else returns -insertionPoint-1, like BinarySearch(Array, int, int, object)

Declaration
public virtual int LookupTerm(BytesRef key)
Parameters
Type Name Description
BytesRef key

Key to look up
Returns
Type Description
int