Package org.apache.lucene.document

Class XYShapeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.document.SpatialQuery

org.apache.lucene.document.XYShapeQuery

final class XYShapeQuery
extends SpatialQuery

Finds all previously indexed cartesian shapes that comply the given ShapeField.QueryRelation with the specified array of XYGeometry.

The field must be indexed using XYShape.createIndexableFields(java.lang.String, org.apache.lucene.geo.XYPolygon) added per document.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.document.SpatialQuery

SpatialQuery.SpatialVisitor

Field Summary

Fields

Modifier and Type	Field	Description
private Component2D	component2D
(package private) XYGeometry[]	geometries

Fields inherited from class org.apache.lucene.document.SpatialQuery

field, queryRelation

Constructor Summary

Constructors

Constructor	Description
XYShapeQuery(java.lang.String field, ShapeField.QueryRelation queryRelation, XYGeometry... geometries)	Creates a query that matches all indexed shapes to the provided polygons

Method Summary

Modifier and Type	Method	Description
protected boolean	equalsTo(java.lang.Object o)	class specific equals check
protected SpatialQuery.SpatialVisitor	getSpatialVisitor()	returns the spatial visitor to be used for this query.
int	hashCode()	Override and implement query hash code properly in a subclass.
java.lang.String	toString(java.lang.String field)	Prints a query to a string, with field assumed to be the default field and omitted.

Methods inherited from class org.apache.lucene.document.SpatialQuery

createWeight, equals, getField, getQueryRelation, transposeRelation, visit

Methods inherited from class org.apache.lucene.search.Query

classHash, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

geometries

final XYGeometry[] geometries

component2D

private final Component2D component2D

Constructor Detail

XYShapeQuery

XYShapeQuery(java.lang.String field,
             ShapeField.QueryRelation queryRelation,
             XYGeometry... geometries)

Creates a query that matches all indexed shapes to the provided polygons

Method Detail

getSpatialVisitor

protected SpatialQuery.SpatialVisitor getSpatialVisitor()

Description copied from class: SpatialQuery

returns the spatial visitor to be used for this query. Called before generating the query Weight

Specified by:

getSpatialVisitor in class SpatialQuery

toString

public java.lang.String toString(java.lang.String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

equalsTo

protected boolean equalsTo(java.lang.Object o)

Description copied from class: SpatialQuery

class specific equals check

Overrides:

equalsTo in class SpatialQuery

hashCode

public int hashCode()

Description copied from class: Query

Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.

Overrides:

hashCode in class SpatialQuery

See Also:

Query.equals(Object)