public class DoubleRange extends 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.
Field.Store
Modifier and Type | Field and Description |
---|---|
static int |
BYTES
stores double values so number of bytes is 8
|
boost, fieldsData, name, tokenStream, type
Constructor and Description |
---|
DoubleRange(String name,
double[] min,
double[] max)
Create a new DoubleRange type, from min/max parallel arrays
|
Modifier and Type | Method and Description |
---|---|
double |
getMax(int dimension)
Get the max value for the given dimension
|
double |
getMin(int dimension)
Get the min value for the given dimension
|
static Query |
newContainsQuery(String field,
double[] min,
double[] max)
Create a query for matching indexed ranges that contain the defined range.
|
static Query |
newCrossesQuery(String field,
double[] min,
double[] max)
Create a query for matching indexed ranges that cross the defined range.
|
static Query |
newIntersectsQuery(String field,
double[] min,
double[] max)
Create a query for matching indexed ranges that intersect the defined range.
|
static Query |
newWithinQuery(String field,
double[] min,
double[] max)
Create a query for matching indexed ranges that are within the defined range.
|
void |
setRangeValues(double[] min,
double[] max)
Changes the values of the field.
|
String |
toString()
Prints a Field for human consumption.
|
binaryValue, boost, fieldType, name, numericValue, readerValue, setBoost, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue
public static final int BYTES
public DoubleRange(String name, double[] min, double[] max)
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 dimensionpublic void setRangeValues(double[] min, double[] max)
min
- array of min values. (accepts Double.NEGATIVE_INFINITY
)max
- array of max values. (accepts Double.POSITIVE_INFINITY
)IllegalArgumentException
- if min
or max
is invalidpublic double getMin(int dimension)
dimension
- the dimension, always positivepublic double getMax(int dimension)
dimension
- the dimension, always positivepublic static Query newIntersectsQuery(String field, double[] min, double[] max)
field
- field name. must not be null.min
- array of min values. (accepts Double.NEGATIVE_INFINITY
)max
- array of max values. (accepts Double.POSITIVE_INFINITY
)IllegalArgumentException
- if field
is null, min
or max
is invalidpublic static Query newContainsQuery(String field, double[] min, double[] max)
field
- field name. must not be null.min
- array of min values. (accepts Double.MIN_VALUE
)max
- array of max values. (accepts Double.MAX_VALUE
)IllegalArgumentException
- if field
is null, min
or max
is invalidpublic static Query newWithinQuery(String field, double[] min, double[] max)
field
- field name. must not be null.min
- array of min values. (accepts Double.MIN_VALUE
)max
- array of max values. (accepts Double.MAX_VALUE
)IllegalArgumentException
- if field
is null, min
or max
is invalidpublic static Query newCrossesQuery(String field, double[] min, double[] max)
field
- field name. must not be null.min
- array of min values. (accepts Double.MIN_VALUE
)max
- array of max values. (accepts Double.MAX_VALUE
)IllegalArgumentException
- if field
is null, min
or max
is invalidCopyright © 2000-2017 Apache Software Foundation. All Rights Reserved.