Class LatLonDocValuesField
- All Implemented Interfaces:
IndexableField
Sorting by distance is efficient. Multiple values for the same field in one document is allowed.
This field defines static factory methods for common operations:
newDistanceSort()
for ordering documents by distance from a specified location.
If you also need query operations, you should add a separate LatLonPoint
instance. If
you also need to store the value, you should add a separate StoredField
instance.
WARNING: Values are indexed with some loss of precision from the original
double
values (4.190951585769653E-8 for the latitude component and 8.381903171539307E-8 for
longitude).
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
Field Summary
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorDescriptionLatLonDocValuesField
(String name, double latitude, double longitude) Creates a new LatLonDocValuesField with the specified latitude and longitude -
Method Summary
Modifier and TypeMethodDescriptionstatic SortField
newDistanceSort
(String field, double latitude, double longitude) Creates a SortField for sorting by distance from a location.static Query
newSlowBoxQuery
(String field, double minLatitude, double maxLatitude, double minLongitude, double maxLongitude) Create a query for matching a bounding box using doc values.static Query
newSlowDistanceQuery
(String field, double latitude, double longitude, double radiusMeters) Create a query for matching points within the specified distance of the supplied location.static Query
newSlowGeometryQuery
(String field, ShapeField.QueryRelation queryRelation, LatLonGeometry... latLonGeometries) Create a query for matching one or more geometries against the providedShapeField.QueryRelation
.static Query
newSlowPolygonQuery
(String field, Polygon... polygons) Create a query for matching points within the supplied polygons.void
setLocationValue
(double latitude, double longitude) Change the values of this fieldtoString()
Prints a Field for human consumption.Methods inherited from class org.apache.lucene.document.Field
binaryValue, fieldType, getCharSequenceValue, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue
-
Field Details
-
TYPE
Type for a LatLonDocValuesFieldEach value stores a 64-bit long where the upper 32 bits are the encoded latitude, and the lower 32 bits are the encoded longitude.
-
-
Constructor Details
-
LatLonDocValuesField
Creates a new LatLonDocValuesField with the specified latitude and longitude- Parameters:
name
- field namelatitude
- latitude value: must be within standard +/-90 coordinate bounds.longitude
- longitude value: must be within standard +/-180 coordinate bounds.- Throws:
IllegalArgumentException
- if the field name is null or latitude or longitude are out of bounds
-
-
Method Details
-
setLocationValue
public void setLocationValue(double latitude, double longitude) Change the values of this field- Parameters:
latitude
- latitude value: must be within standard +/-90 coordinate bounds.longitude
- longitude value: must be within standard +/-180 coordinate bounds.- Throws:
IllegalArgumentException
- if latitude or longitude are out of bounds
-
toString
Description copied from class:Field
Prints a Field for human consumption. -
newDistanceSort
Creates a SortField for sorting by distance from a location.This sort orders documents by ascending distance from the location. The value returned in
FieldDoc
for the hits contains a Double instance with the distance in meters.If a document is missing the field, then by default it is treated as having
Double.POSITIVE_INFINITY
distance (missing values sort last).If a document contains multiple values for the field, the closest distance to the location is used.
- Parameters:
field
- field name. must not be null.latitude
- latitude at the center: must be within standard +/-90 coordinate bounds.longitude
- longitude at the center: must be within standard +/-180 coordinate bounds.- Returns:
- SortField ordering documents by distance
- Throws:
IllegalArgumentException
- iffield
is null or location has invalid coordinates.
-
newSlowBoxQuery
public static Query newSlowBoxQuery(String field, double minLatitude, double maxLatitude, double minLongitude, double maxLongitude) Create a query for matching a bounding box using doc values. This query is usually slow as it does not use an index structure and needs to verify documents one-by-one in order to know whether they match. It is best used wrapped in anIndexOrDocValuesQuery
alongside aLatLonPoint.newBoxQuery(java.lang.String, double, double, double, double)
. -
newSlowDistanceQuery
public static Query newSlowDistanceQuery(String field, double latitude, double longitude, double radiusMeters) Create a query for matching points within the specified distance of the supplied location. This query is usually slow as it does not use an index structure and needs to verify documents one-by-one in order to know whether they match. It is best used wrapped in anIndexOrDocValuesQuery
alongside aLatLonPoint.newDistanceQuery(java.lang.String, double, double, double)
.- Parameters:
field
- field name. must not be null.latitude
- latitude at the center: must be within standard +/-90 coordinate bounds.longitude
- longitude at the center: must be within standard +/-180 coordinate bounds.radiusMeters
- maximum distance from the center in meters: must be non-negative and finite.- Returns:
- query matching points within this distance
- Throws:
IllegalArgumentException
- iffield
is null, location has invalid coordinates, or radius is invalid.
-
newSlowPolygonQuery
Create a query for matching points within the supplied polygons. This query is usually slow as it does not use an index structure and needs to verify documents one-by-one in order to know whether they match. It is best used wrapped in anIndexOrDocValuesQuery
alongside aLatLonPoint.newPolygonQuery(String, Polygon...)
.- Parameters:
field
- field name. must not be null.polygons
- array of polygons. must not be null or empty.- Returns:
- query matching points within the given polygons.
- Throws:
IllegalArgumentException
- iffield
is null or polygons is empty or contain a null polygon.
-
newSlowGeometryQuery
public static Query newSlowGeometryQuery(String field, ShapeField.QueryRelation queryRelation, LatLonGeometry... latLonGeometries) Create a query for matching one or more geometries against the providedShapeField.QueryRelation
. Line geometries are not supported for WITHIN relationship. This query is usually slow as it does not use an index structure and needs to verify documents one-by-one in order to know whether they match. It is best used wrapped in anIndexOrDocValuesQuery
alongside aLatLonPoint.newGeometryQuery(String, ShapeField.QueryRelation, LatLonGeometry...)
.- Parameters:
field
- field name. must not be null.queryRelation
- The relation the points needs to satisfy with the provided geometries, must not be null.latLonGeometries
- array of LatLonGeometries. must not be null or empty.- Returns:
- query matching points within the given polygons.
- Throws:
IllegalArgumentException
- iffield
is null,queryRelation
is null,latLonGeometries
is null, empty or contain a null or line geometry.
-