Package org.apache.lucene.document
Class XYShape
- java.lang.Object
-
- org.apache.lucene.document.XYShape
-
public class XYShape extends java.lang.Object
A cartesian shape utility class for indexing and searching geometries whose vertices are unitless x, y values.This class defines six static factory methods for common indexing and search operations:
createIndexableFields(String, XYPolygon)
for indexing a cartesian polygon.createIndexableFields(String, XYLine)
for indexing a cartesian linestring.createIndexableFields(String, float, float)
for indexing a x, y cartesian point.newBoxQuery()
for matching cartesian shapes that have someShapeField.QueryRelation
with a bounding box.newLineQuery()
for matching cartesian shapes that have someShapeField.QueryRelation
with a linestring.newPolygonQuery()
for matching cartesian shapes that have someShapeField.QueryRelation
with a polygon.
LatLonPoint
, vertex values are indexed with some loss of precision from the originaldouble
values.- See Also:
PointValues
,LatLonDocValuesField
-
-
Constructor Summary
Constructors Modifier Constructor Description private
XYShape()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Field[]
createIndexableFields(java.lang.String fieldName, float x, float y)
create indexable fields for cartesian point geometrystatic Field[]
createIndexableFields(java.lang.String fieldName, XYLine line)
create indexable fields for cartesian line geometrystatic Field[]
createIndexableFields(java.lang.String fieldName, XYPolygon polygon)
create indexable fields for cartesian polygon geometrystatic Query
newBoxQuery(java.lang.String field, ShapeField.QueryRelation queryRelation, float minX, float maxX, float minY, float maxY)
create a query to find all cartesian shapes that intersect a defined bounding boxstatic Query
newLineQuery(java.lang.String field, ShapeField.QueryRelation queryRelation, XYLine... lines)
create a query to find all cartesian shapes that intersect a provided linestring (or array of linestrings)static Query
newPolygonQuery(java.lang.String field, ShapeField.QueryRelation queryRelation, XYPolygon... polygons)
create a query to find all cartesian shapes that intersect a provided polygon (or array of polygons)
-
-
-
Method Detail
-
createIndexableFields
public static Field[] createIndexableFields(java.lang.String fieldName, XYPolygon polygon)
create indexable fields for cartesian polygon geometry
-
createIndexableFields
public static Field[] createIndexableFields(java.lang.String fieldName, XYLine line)
create indexable fields for cartesian line geometry
-
createIndexableFields
public static Field[] createIndexableFields(java.lang.String fieldName, float x, float y)
create indexable fields for cartesian point geometry
-
newBoxQuery
public static Query newBoxQuery(java.lang.String field, ShapeField.QueryRelation queryRelation, float minX, float maxX, float minY, float maxY)
create a query to find all cartesian shapes that intersect a defined bounding box
-
newLineQuery
public static Query newLineQuery(java.lang.String field, ShapeField.QueryRelation queryRelation, XYLine... lines)
create a query to find all cartesian shapes that intersect a provided linestring (or array of linestrings)
-
newPolygonQuery
public static Query newPolygonQuery(java.lang.String field, ShapeField.QueryRelation queryRelation, XYPolygon... polygons)
create a query to find all cartesian shapes that intersect a provided polygon (or array of polygons)
-
-