Module org.apache.lucene.core

Package org.apache.lucene.document

Class FloatRangeDocValuesField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.document.BinaryDocValuesField

org.apache.lucene.document.BinaryRangeDocValuesField

org.apache.lucene.document.FloatRangeDocValuesField

All Implemented Interfaces:

IndexableField

public class FloatRangeDocValuesField
extends BinaryRangeDocValuesField

DocValues field for FloatRange. This is a single valued field per document due to being an extension of BinaryDocValuesField.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.document.Field

Field.Store

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final String	field
(package private) final float[]	max
(package private) final float[]	min

Fields inherited from class org.apache.lucene.document.BinaryRangeDocValuesField

numBytesPerDimension, numDims, packedValue

Fields inherited from class org.apache.lucene.document.BinaryDocValuesField

TYPE

Fields inherited from class org.apache.lucene.document.Field

fieldsData, name, tokenStream, type

Constructor Summary

Constructors

Constructor	Description
FloatRangeDocValuesField(String field, float[] min, float[] max)	Sole constructor.

Method Summary

Modifier and Type	Method	Description
private static void	checkArgs(float[] min, float[] max)	validate the arguments
float	getMax(int dimension)	Get the maximum value for the given dimension.
float	getMin(int dimension)	Get the minimum value for the given dimension.
static Query	newSlowIntersectsQuery(String field, float[] min, float[] max)	Create a new range query that finds all ranges that intersect using doc values.
private static Query	newSlowRangeQuery(String field, float[] min, float[] max, RangeFieldQuery.QueryType queryType)

Methods inherited from class org.apache.lucene.document.Field

binaryValue, fieldType, getCharSequenceValue, invertableType, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, storedValue, stringValue, tokenStream, tokenStreamValue, toString

Methods inherited from class java.lang.Object

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

Field Details

field

final String field

min

final float[] min

max

final float[] max

Constructor Details

FloatRangeDocValuesField

public FloatRangeDocValuesField(String field,
 float[] min,
 float[] max)

Sole constructor.

Method Details

getMin

public float getMin(int dimension)

Get the minimum value for the given dimension.

getMax

public float getMax(int dimension)

Get the maximum value for the given dimension.

newSlowRangeQuery

private static Query newSlowRangeQuery(String field,
 float[] min,
 float[] max,
 RangeFieldQuery.QueryType queryType)

newSlowIntersectsQuery

public static Query newSlowIntersectsQuery(String field,
 float[] min,
 float[] max)

Create a new range query that finds all ranges that intersect using doc values. NOTE: This doesn't leverage indexing and may be slow.

See Also:

• FloatRange.newIntersectsQuery(java.lang.String, float[], float[])

checkArgs

private static void checkArgs(float[] min,
 float[] max)

validate the arguments