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

Class LongMultiValuesToSingleValuesSource

java.lang.Object

org.apache.lucene.search.LongValuesSource

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

All Implemented Interfaces:

org.apache.lucene.search.SegmentCacheable

public abstract class LongMultiValuesToSingleValuesSource
extends org.apache.lucene.search.LongValuesSource

An implementation of LongValuesSource for docvalues with multiple values per document, where multiple values are "aggregated" into a single value according to a given MultiValueMode.

Some of this code was copied and adapted from org.elasticsearch.search.MultiValueMode from the Elasticsearch project.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.LongValuesSource

org.apache.lucene.search.LongValuesSource.ConstantLongValuesSource

Field Summary

Fields

Modifier and Type	Field	Description
protected final MultiValueMode	mode
protected final NestedDocsProvider	nestedDocsProvider

Constructor Summary

Constructors

Constructor	Description
LongMultiValuesToSingleValuesSource(MultiValueMode mode, NestedDocsProvider nestedDocsProvider)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static LongMultiValuesToSingleValuesSource	fromIntField(String field, MultiValueMode mode, NestedDocsProvider nested)	Creates a LongMultiValuesToSingleValuesSource that wraps an int-valued field
static LongMultiValuesToSingleValuesSource	fromLongField(String field, MultiValueMode mode, NestedDocsProvider nested)	Creates a LongMultiValuesToSingleValuesSource that wraps a long-valued field
org.apache.lucene.index.NumericDocValues	getRawNumericDocValues(org.apache.lucene.index.LeafReaderContext ctx, org.apache.lucene.search.DoubleValues scores)	Returns a NumericDocValues instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.
protected abstract org.apache.lucene.index.SortedNumericDocValues	getSortedNumericDocValues(org.apache.lucene.index.LeafReaderContext ctx)
org.apache.lucene.search.LongValues	getValues(org.apache.lucene.index.LeafReaderContext ctx, org.apache.lucene.search.DoubleValues scores)
int	hashCode()
protected org.apache.lucene.search.LongValues	select(org.apache.lucene.index.SortedNumericDocValues values)
protected org.apache.lucene.search.LongValues	select(org.apache.lucene.index.SortedNumericDocValues values, ChildDocIds childDocsWithValues)

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

constant, fromIntField, fromLongField, getSortField, needsScores, rewrite, toDoubleValuesSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.lucene.search.SegmentCacheable

isCacheable

Field Details

mode

protected final MultiValueMode mode

nestedDocsProvider

protected final NestedDocsProvider nestedDocsProvider

Constructor Details

LongMultiValuesToSingleValuesSource

public LongMultiValuesToSingleValuesSource(MultiValueMode mode,
 NestedDocsProvider nestedDocsProvider)

Method Details

fromLongField

public static LongMultiValuesToSingleValuesSource fromLongField(String field,
 MultiValueMode mode,
 NestedDocsProvider nested)

Creates a LongMultiValuesToSingleValuesSource that wraps a long-valued field

Parameters:

field - the field

mode - the mode

nested - the nested provider

Returns:

A LongMultiValuesToSingleValuesSource

fromIntField

public static LongMultiValuesToSingleValuesSource fromIntField(String field,
 MultiValueMode mode,
 NestedDocsProvider nested)

Creates a LongMultiValuesToSingleValuesSource that wraps an int-valued field

Parameters:

field - the field

mode - the mode

nested - the nested provider

Returns:

A LongMultiValuesToSingleValuesSource

equals

public boolean equals(Object o)

Specified by:

equals in class org.apache.lucene.search.LongValuesSource

hashCode

public int hashCode()

Specified by:

hashCode in class org.apache.lucene.search.LongValuesSource

getValues

public org.apache.lucene.search.LongValues getValues(org.apache.lucene.index.LeafReaderContext ctx,
 org.apache.lucene.search.DoubleValues scores)
                                              throws IOException

Specified by:

getValues in class org.apache.lucene.search.LongValuesSource

Throws:

IOException

getRawNumericDocValues

public org.apache.lucene.index.NumericDocValues getRawNumericDocValues(org.apache.lucene.index.LeafReaderContext ctx,
 org.apache.lucene.search.DoubleValues scores)
                                                                throws IOException

Returns a NumericDocValues instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.

Parameters:

ctx - the ctx

scores - the scores

Returns:

NumericDocValues

Throws:

IOException

getSortedNumericDocValues

protected abstract org.apache.lucene.index.SortedNumericDocValues getSortedNumericDocValues(org.apache.lucene.index.LeafReaderContext ctx)
                                                                                     throws IOException

Throws:

IOException

select

protected org.apache.lucene.search.LongValues select(org.apache.lucene.index.SortedNumericDocValues values)

select

protected org.apache.lucene.search.LongValues select(org.apache.lucene.index.SortedNumericDocValues values,
 ChildDocIds childDocsWithValues)