XYShape

object XYShape

A cartesian shape utility class for indexing and searching geometries whose vertices are unitless x, y values.

Functions

Link copied to clipboard

create a XYShapeDocValuesField from a precomputed tessellation

create doc value field for x, y line geometry without creating indexable fields.

create doc value field for X,Y polygon geometry without creating indexable fields

create a XYShapeDocValuesField from an existing encoded representation

create a XYShapeDocValuesField for cartesian points without creating indexable fields.

fun createDocValueField(fieldName: String, polygon: XYPolygon, checkSelfIntersections: Boolean): XYShapeDocValuesField

create doc value field for lat lon polygon geometry without creating indexable fields.

Link copied to clipboard
fun createIndexableFields(fieldName: String, line: XYLine): Array<Field>

create indexable fields for cartesian line geometry

fun createIndexableFields(fieldName: String, polygon: XYPolygon): Array<Field>

create indexable fields for cartesian polygon geometry

create indexable fields for cartesian point geometry

fun createIndexableFields(fieldName: String, polygon: XYPolygon, checkSelfIntersections: Boolean): Array<Field>

create indexable fields for cartesian polygon geometry. If checkSelfIntersections is set to true, the validity of the provided polygon is checked with a small performance penalty.

Link copied to clipboard

Factory method for creating the XYShapeDocValues

Link copied to clipboard
fun newBoxQuery(field: String, queryRelation: ShapeField.QueryRelation, minX: Float, maxX: Float, minY: Float, maxY: Float): Query

create a query to find all cartesian shapes that intersect a defined bounding box

Link copied to clipboard
fun newDistanceQuery(field: String, queryRelation: ShapeField.QueryRelation, vararg circle: XYCircle): Query

create a query to find all cartesian shapes that intersect a provided circle (or arrays of circles)

Link copied to clipboard
fun newGeometryQuery(field: String, queryRelation: ShapeField.QueryRelation, vararg xyGeometries: XYGeometry): Query

create a query to find all indexed geo shapes that intersect a provided geometry collection note: Components do not support dateline crossing

Link copied to clipboard
fun newLineQuery(field: String, queryRelation: ShapeField.QueryRelation, vararg lines: XYLine): Query

create a query to find all cartesian shapes that intersect a provided linestring (or array of linestrings)

Link copied to clipboard
fun newPointQuery(field: String, queryRelation: ShapeField.QueryRelation, vararg points: FloatArray): Query

create a query to find all indexed shapes that comply the QueryRelation with the provided point

Link copied to clipboard
fun newPolygonQuery(field: String, queryRelation: ShapeField.QueryRelation, vararg polygons: XYPolygon): Query

create a query to find all cartesian shapes that intersect a provided polygon (or array of polygons)

Link copied to clipboard
fun newSlowDocValuesBoxQuery(field: String, queryRelation: ShapeField.QueryRelation, minX: Float, maxX: Float, minY: Float, maxY: Float): Query

create a docvalue query to find all cartesian shapes that intersect a defined bounding box