Companion

object Companion

Properties

Link copied to clipboard

Type for a XYDocValuesField

Functions

Link copied to clipboard
fun checkCompatible(fieldInfo: FieldInfo)

helper: checks a fieldinfo and throws exception if its definitely not a XYDocValuesField

Link copied to clipboard

Creates a SortField for sorting by distance from a location.

Link copied to clipboard
fun newSlowBoxQuery(field: String?, minX: Float, maxX: Float, minY: Float, maxY: Float): Query

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 an IndexOrDocValuesQuery alongside a XYPointField.newBoxQuery.

Link copied to clipboard
fun newSlowDistanceQuery(field: String?, x: Float, y: Float, radius: Float): Query

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 an [ ] alongside a XYPointField.newDistanceQuery.

Link copied to clipboard
fun newSlowGeometryQuery(field: String?, vararg geometries: XYGeometry): Query

Create a query for matching points within the supplied geometries. XYLine geometries are not supported. 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 an [ ] alongside a XYPointField.newGeometryQuery.

Link copied to clipboard
fun newSlowPolygonQuery(field: String?, vararg polygons: XYPolygon): Query

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 an IndexOrDocValuesQuery alongside a XYPointField.newPolygonQuery.