Module org.elasticsearch.server

Package org.elasticsearch.index.fielddata

Class SortedNumericDoubleValues

java.lang.Object

org.elasticsearch.index.fielddata.SortedNumericDoubleValues

Direct Known Subclasses:

DoubleScriptDocValues, SortingNumericDoubleValues

public abstract class SortedNumericDoubleValues
extends Object

Clone of SortedNumericDocValues for double values.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SortedNumericDoubleValues()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
abstract boolean	advanceExact(int target)	Advance the iterator to exactly target and return whether target has a value.
abstract int	docValueCount()	Retrieves the number of values for the current document.
abstract double	nextValue()	Iterates to the next value in the current document.
static SortedNumericDoubleValues	singleton(org.apache.lucene.search.DoubleValues values)	Converts a DoubleValues to a SortedNumericDoubleValues
static org.apache.lucene.search.DoubleValues	unwrapSingleton(SortedNumericDoubleValues values)	Converts a SortedNumericDoubleValues values to a singly valued DoubleValues if possible
static SortedNumericDoubleValues	wrap(org.apache.lucene.index.SortedNumericDocValues values)	Converts a SortedNumericDocValues iterator to a SortedNumericDoubleValues Note that if the wrapped iterator can be unwrapped to a singleton NumericDocValues instance, then the returned SortedNumericDoubleValues can also be unwrapped to a DoubleValues instance via unwrapSingleton(SortedNumericDoubleValues)

Methods inherited from class java.lang.Object

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

Constructor Details

SortedNumericDoubleValues

protected SortedNumericDoubleValues()

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

Method Details

advanceExact

public abstract boolean advanceExact(int target)
                              throws IOException

Advance the iterator to exactly target and return whether target has a value. target must be greater than or equal to the current doc ID and must be a valid doc ID, ie. ≥ 0 and < maxDoc.

Throws:

IOException

nextValue

public abstract double nextValue()
                          throws IOException

Iterates to the next value in the current document. Do not call this more than docValueCount() times for the document.

Throws:

IOException

docValueCount

public abstract int docValueCount()

Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method after advanceExact(int) returned false.

unwrapSingleton

public static org.apache.lucene.search.DoubleValues unwrapSingleton(SortedNumericDoubleValues values)

Converts a SortedNumericDoubleValues values to a singly valued DoubleValues if possible

singleton

public static SortedNumericDoubleValues singleton(org.apache.lucene.search.DoubleValues values)

Converts a DoubleValues to a SortedNumericDoubleValues

wrap

public static SortedNumericDoubleValues wrap(org.apache.lucene.index.SortedNumericDocValues values)

Converts a SortedNumericDocValues iterator to a SortedNumericDoubleValues Note that if the wrapped iterator can be unwrapped to a singleton NumericDocValues instance, then the returned SortedNumericDoubleValues can also be unwrapped to a DoubleValues instance via unwrapSingleton(SortedNumericDoubleValues)