org.apache.lucene.queries.function.valuesource

Class StrDocValuesFieldSource

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.lucene.queries.function.valuesource.DocValuesFieldSource

org.apache.lucene.queries.function.valuesource.StrDocValuesFieldSource

public class StrDocValuesFieldSource
extends DocValuesFieldSource

A ValueSource for binary DocValues that represent an UTF-8 encoded String using:

• DocValues.Type.BYTES_FIXED_DEREF,
• DocValues.Type.BYTES_FIXED_STRAIGHT,
• DocValues.Type.BYTES_VAR_DEREF,
• DocValues.Type.BYTES_VAR_STRAIGHT,
• DocValues.Type.BYTES_FIXED_SORTED,
• DocValues.Type.BYTES_VAR_SORTED.

If the segment has no DocValues, the default DocValues.Source of type DocValues.Type.BYTES_VAR_SORTED will be used.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields inherited from class org.apache.lucene.queries.function.valuesource.DocValuesFieldSource

direct, fieldName

Constructor Summary

Constructors

Constructor and Description
StrDocValuesFieldSource(String fieldName, boolean direct)

Method Summary

Methods

Modifier and Type	Method and Description
FunctionValues	getValues(Map context, AtomicReaderContext readerContext) Gets the values for this reader and the context that was previously passed to createWeight()

Methods inherited from class org.apache.lucene.queries.function.valuesource.DocValuesFieldSource

description, equals, getFieldName, getSource, hashCode, isDirect

Methods inherited from class org.apache.lucene.queries.function.ValueSource

createWeight, getSortField, newContext, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StrDocValuesFieldSource

public StrDocValuesFieldSource(String fieldName,
                       boolean direct)

Parameters:

fieldName - the name of the DocValues field

direct - whether or not to use a direct DocValues.Source

Method Detail

getValues

public FunctionValues getValues(Map context,
                       AtomicReaderContext readerContext)
                         throws IOException

Description copied from class: ValueSource

Gets the values for this reader and the context that was previously passed to createWeight()

Specified by:

getValues in class ValueSource

Throws:

IOException