Class SortedSetDocValues

A per-document set of presorted byte[] 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
SortedSetDocValues
MultiDocValues.MultiSortedSetDocValues
RandomAccessOrds
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class SortedSetDocValues

Constructors

SortedSetDocValues()

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

Declaration
protected SortedSetDocValues()

Fields

NO_MORE_ORDS

When returned by NextOrd() it means there are no more ordinals for the document.

Declaration
public static readonly long NO_MORE_ORDS
Field Value
Type Description
long

Properties

ValueCount

Returns the number of unique values.

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

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

Methods

GetTermsEnum()

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

Declaration
public virtual TermsEnum GetTermsEnum()
Returns
Type Description
TermsEnum

LookupOrd(long, BytesRef)

Retrieves the value for the specified ordinal.

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

ordinal to lookup
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 long LookupTerm(BytesRef key)
Parameters
Type Name Description
BytesRef key

Key to look up
Returns
Type Description
long

NextOrd()

Returns the next ordinal for the current document (previously set by SetDocument(int).

Declaration
public abstract long NextOrd()
Returns
Type Description
long

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.

SetDocument(int)

Sets iteration to the specified docID

Declaration
public abstract void SetDocument(int docID)
Parameters
Type Name Description
int docID

document ID