Package org.hibernate.search.backend.lucene.lowlevel.docvalues.impl

Class SortedNumericDoubleDocValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.hibernate.search.backend.lucene.lowlevel.docvalues.impl.SortedNumericDoubleDocValues

Direct Known Subclasses:

GeoPointDistanceDocValues

public abstract class SortedNumericDoubleDocValues
extends org.apache.lucene.search.DocIdSetIterator

Clone of SortedNumericDocValues for double values.

Copied and adapted from org.elasticsearch.index.fielddata.SortedNumericDoubleValues class of Elasticsearch project.

Field Summary

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SortedNumericDoubleDocValues()	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.
static SortedNumericDoubleDocValues	create(org.apache.lucene.index.SortedNumericDocValues values, LongToDoubleFunction decoder)
abstract int	docValueCount()	Retrieves the number of values for the current document.
static SortedNumericDoubleDocValues	fromDoubleField(org.apache.lucene.index.SortedNumericDocValues values)
static SortedNumericDoubleDocValues	fromFloatField(org.apache.lucene.index.SortedNumericDocValues values)
abstract double	nextValue()	Iterates to the next value in the current document.
static NumericDoubleValues	unwrapSingleton(SortedNumericDoubleDocValues values)

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

advance, all, cost, docID, empty, nextDoc, range, slowAdvance

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedNumericDoubleDocValues

protected SortedNumericDoubleDocValues()

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

Method Detail

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.

Parameters:

target - the target

Returns:

the next value

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.

Returns:

next value

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.

Returns:

value count

fromDoubleField

public static SortedNumericDoubleDocValues fromDoubleField(org.apache.lucene.index.SortedNumericDocValues values)

fromFloatField

public static SortedNumericDoubleDocValues fromFloatField(org.apache.lucene.index.SortedNumericDocValues values)

unwrapSingleton

public static NumericDoubleValues unwrapSingleton(SortedNumericDoubleDocValues values)

create

public static SortedNumericDoubleDocValues create(org.apache.lucene.index.SortedNumericDocValues values,
                                                  LongToDoubleFunction decoder)