Package org.apache.lucene.document
Class FloatRange
- java.lang.Object
-
- org.apache.lucene.document.Field
-
- org.apache.lucene.document.FloatRange
-
- All Implemented Interfaces:
IndexableField
public class FloatRange extends Field
An indexed Float Range field.This field indexes dimensional ranges defined as min/max pairs. It supports up to a maximum of 4 dimensions (indexed as 8 numeric values). With 1 dimension representing a single float range, 2 dimensions representing a bounding box, 3 dimensions a bounding cube, and 4 dimensions a tesseract.
Multiple values for the same field in one document is supported, and open ended ranges can be defined using
Float.NEGATIVE_INFINITYandFloat.POSITIVE_INFINITY.This field defines the following static factory methods for common search operations over float ranges:
newIntersectsQuery()matches ranges that intersect the defined search range.newWithinQuery()matches ranges that are within the defined search range.newContainsQuery()matches ranges that contain the defined search range.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
-
Field Summary
Fields Modifier and Type Field Description static intBYTESstores float values so number of bytes is 4-
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
-
Constructor Summary
Constructors Constructor Description FloatRange(String name, float[] min, float[] max)Create a new FloatRange type, from min/max parallel arrays
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description floatgetMax(int dimension)Get the max value for the given dimensionfloatgetMin(int dimension)Get the min value for the given dimensionstatic QuerynewContainsQuery(String field, float[] min, float[] max)Create a query for matching indexed float ranges that contain the defined range.static QuerynewCrossesQuery(String field, float[] min, float[] max)Create a query for matching indexed ranges that cross the defined range.static QuerynewIntersectsQuery(String field, float[] min, float[] max)Create a query for matching indexed ranges that intersect the defined range.static QuerynewWithinQuery(String field, float[] min, float[] max)Create a query for matching indexed ranges that are within the defined range.voidsetRangeValues(float[] min, float[] max)Changes the values of the field.StringtoString()Prints a Field for human consumption.-
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
-
-
-
-
Field Detail
-
BYTES
public static final int BYTES
stores float values so number of bytes is 4- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FloatRange
public FloatRange(String name, float[] min, float[] max)
Create a new FloatRange type, from min/max parallel arrays- Parameters:
name- field name. must not be null.min- range min values; each entry is the min value for the dimensionmax- range max values; each entry is the max value for the dimension
-
-
Method Detail
-
setRangeValues
public void setRangeValues(float[] min, float[] max)Changes the values of the field.- Parameters:
min- array of min values. (acceptsFloat.NEGATIVE_INFINITY)max- array of max values. (acceptsFloat.POSITIVE_INFINITY)- Throws:
IllegalArgumentException- ifminormaxis invalid
-
getMin
public float getMin(int dimension)
Get the min value for the given dimension- Parameters:
dimension- the dimension, always positive- Returns:
- the decoded min value
-
getMax
public float getMax(int dimension)
Get the max value for the given dimension- Parameters:
dimension- the dimension, always positive- Returns:
- the decoded max value
-
newIntersectsQuery
public static Query newIntersectsQuery(String field, float[] min, float[] max)
Create a query for matching indexed ranges that intersect the defined range.- Parameters:
field- field name. must not be null.min- array of min values. (acceptsFloat.NEGATIVE_INFINITY)max- array of max values. (acceptsFloat.MAX_VALUE)- Returns:
- query for matching intersecting ranges (overlap, within, or contains)
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
newContainsQuery
public static Query newContainsQuery(String field, float[] min, float[] max)
Create a query for matching indexed float ranges that contain the defined range.- Parameters:
field- field name. must not be null.min- array of min values. (acceptsFloat.NEGATIVE_INFINITY)max- array of max values. (acceptsFloat.POSITIVE_INFINITY)- Returns:
- query for matching ranges that contain the defined range
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
newWithinQuery
public static Query newWithinQuery(String field, float[] min, float[] max)
Create a query for matching indexed ranges that are within the defined range.- Parameters:
field- field name. must not be null.min- array of min values. (acceptsFloat.NEGATIVE_INFINITY)max- array of max values. (acceptsFloat.POSITIVE_INFINITY)- Returns:
- query for matching ranges within the defined range
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
newCrossesQuery
public static Query newCrossesQuery(String field, float[] min, float[] max)
Create a query for matching indexed ranges that cross the defined range. A CROSSES is defined as any set of ranges that are not disjoint and not wholly contained by the query. Effectively, its the complement of union(WITHIN, DISJOINT).- Parameters:
field- field name. must not be null.min- array of min values. (acceptsFloat.NEGATIVE_INFINITY)max- array of max values. (acceptsFloat.POSITIVE_INFINITY)- Returns:
- query for matching ranges within the defined range
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
-