org.apache.lucene.index

Class SingletonSortedSetDocValues

java.lang.Object

org.apache.lucene.index.SortedSetDocValues

org.apache.lucene.index.RandomAccessOrds

org.apache.lucene.index.SingletonSortedSetDocValues

final class SingletonSortedSetDocValues
extends RandomAccessOrds

Exposes multi-valued view over a single-valued instance.

This can be used if you want to have one multi-valued implementation that works for single or multi-valued types.

Field Summary

Fields

Modifier and Type	Field and Description
private long	currentOrd
private SortedDocValues	in
private long	ord

Fields inherited from class org.apache.lucene.index.SortedSetDocValues

NO_MORE_ORDS

Constructor Summary

Constructors

Constructor and Description
SingletonSortedSetDocValues(SortedDocValues in) Creates a multi-valued view over the provided SortedDocValues

Method Summary

Modifier and Type	Method and Description
int	cardinality() Returns the cardinality for the current document (previously set by SortedSetDocValues.setDocument(int).
SortedDocValues	getSortedDocValues() Return the wrapped SortedDocValues
long	getValueCount() Returns the number of unique values.
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.
long	nextOrd() Returns the next ordinal for the current document (previously set by SortedSetDocValues.setDocument(int).
long	ordAt(int index) Retrieve the ordinal for the current document (previously set by SortedSetDocValues.setDocument(int) at the specified index.
void	setDocument(int docID) Sets iteration to the specified docID
TermsEnum	termsEnum() Returns a TermsEnum over the values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

in

private final SortedDocValues in

currentOrd

private long currentOrd

ord

private long ord

Constructor Detail

SingletonSortedSetDocValues

public SingletonSortedSetDocValues(SortedDocValues in)

Creates a multi-valued view over the provided SortedDocValues

Method Detail

getSortedDocValues

public SortedDocValues getSortedDocValues()

Return the wrapped SortedDocValues

nextOrd

public long nextOrd()

Description copied from class: SortedSetDocValues

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

Specified by:

nextOrd in class SortedSetDocValues

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 class SortedSetDocValues

Parameters:

docID - document ID

lookupOrd

public BytesRef lookupOrd(long ord)

Description copied from class: SortedSetDocValues

Retrieves the value for the specified ordinal. The returned BytesRef may be re-used across calls to lookupOrd so make sure to copy it if you want to keep it around.

Specified by:

lookupOrd in class SortedSetDocValues

Parameters:

ord - ordinal to lookup

See Also:

SortedSetDocValues.nextOrd()

getValueCount

public long getValueCount()

Description copied from class: SortedSetDocValues

Returns the number of unique values.

Specified by:

getValueCount in class SortedSetDocValues

Returns:

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

lookupTerm

public long lookupTerm(BytesRef key)

Description copied from class: SortedSetDocValues

If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.

Overrides:

lookupTerm in class SortedSetDocValues

Parameters:

key - Key to look up

ordAt

public long ordAt(int index)

Description copied from class: RandomAccessOrds

Retrieve the ordinal for the current document (previously set by SortedSetDocValues.setDocument(int) at the specified index.

An index ranges from 0 to cardinality()-1. The first ordinal value is at index 0, the next at index 1, and so on, as for array indexing.

Specified by:

ordAt in class RandomAccessOrds

Parameters:

index - index of the ordinal for the document.

Returns:

ordinal for the document at the specified index.

cardinality

public int cardinality()

Description copied from class: RandomAccessOrds

Returns the cardinality for the current document (previously set by SortedSetDocValues.setDocument(int).

Specified by:

cardinality in class RandomAccessOrds

termsEnum

public TermsEnum termsEnum()

Description copied from class: SortedSetDocValues

Returns a TermsEnum over the values. The enum supports TermsEnum.ord() and TermsEnum.seekExact(long).

Overrides:

termsEnum in class SortedSetDocValues