Package org.apache.lucene.document
Class DoubleRange
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.DoubleRange
- All Implemented Interfaces:
IndexableField
An indexed Double 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 double 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 Double.NEGATIVE_INFINITY and Double.POSITIVE_INFINITY.
This field defines the following static factory methods for common search operations over double 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
FieldsModifier and TypeFieldDescriptionstatic final intstores double values so number of bytes is 8Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, type -
Constructor Summary
ConstructorsConstructorDescriptionDoubleRange(String name, double[] min, double[] max) Create a new DoubleRange type, from min/max parallel arrays -
Method Summary
Modifier and TypeMethodDescriptiondoublegetMax(int dimension) Get the max value for the given dimensiondoublegetMin(int dimension) Get the min value for the given dimensionstatic QuerynewContainsQuery(String field, double[] min, double[] max) Create a query for matching indexed ranges that contain the defined range.static QuerynewCrossesQuery(String field, double[] min, double[] max) Create a query for matching indexed ranges that cross the defined range.static QuerynewIntersectsQuery(String field, double[] min, double[] max) Create a query for matching indexed ranges that intersect the defined range.static QuerynewWithinQuery(String field, double[] min, double[] max) Create a query for matching indexed ranges that are within the defined range.voidsetRangeValues(double[] min, double[] max) Changes the values of the field.toString()Prints a Field for human consumption.static voidverifyAndEncode(double[] min, double[] max, byte[] bytes) encode the ranges into a sortable byte array (Double.NaNnot allowed)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 Details
-
BYTES
public static final int BYTESstores double values so number of bytes is 8- See Also:
-
-
Constructor Details
-
DoubleRange
Create a new DoubleRange 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 Details
-
setRangeValues
public void setRangeValues(double[] min, double[] max) Changes the values of the field.- Parameters:
min- array of min values. (acceptsDouble.NEGATIVE_INFINITY)max- array of max values. (acceptsDouble.POSITIVE_INFINITY)- Throws:
IllegalArgumentException- ifminormaxis invalid
-
verifyAndEncode
public static void verifyAndEncode(double[] min, double[] max, byte[] bytes) encode the ranges into a sortable byte array (Double.NaNnot allowed)example for 4 dimensions (8 bytes per dimension value): minD1 ... minD4 | maxD1 ... maxD4
-
getMin
public double getMin(int dimension) Get the min value for the given dimension- Parameters:
dimension- the dimension, always positive- Returns:
- the decoded min value
-
getMax
public double getMax(int dimension) Get the max value for the given dimension- Parameters:
dimension- the dimension, always positive- Returns:
- the decoded max value
-
newIntersectsQuery
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. (acceptsDouble.NEGATIVE_INFINITY)max- array of max values. (acceptsDouble.POSITIVE_INFINITY)- Returns:
- query for matching intersecting ranges (overlap, within, or contains)
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
newContainsQuery
Create a query for matching indexed ranges that contain the defined range.- Parameters:
field- field name. must not be null.min- array of min values. (acceptsDouble.MIN_VALUE)max- array of max values. (acceptsDouble.MAX_VALUE)- Returns:
- query for matching ranges that contain the defined range
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
newWithinQuery
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. (acceptsDouble.MIN_VALUE)max- array of max values. (acceptsDouble.MAX_VALUE)- Returns:
- query for matching ranges within the defined range
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
newCrossesQuery
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. (acceptsDouble.MIN_VALUE)max- array of max values. (acceptsDouble.MAX_VALUE)- Returns:
- query for matching ranges within the defined range
- Throws:
IllegalArgumentException- iffieldis null,minormaxis invalid
-
toString
Description copied from class:FieldPrints a Field for human consumption.
-