Package org.apache.lucene.document

Class XYShapeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.document.ShapeQuery

org.apache.lucene.document.XYShapeQuery

final class XYShapeQuery
extends ShapeQuery

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.

Field Summary

Fields

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

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

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
int	hashCode()	Override and implement query hash code properly in a subclass.
protected boolean	queryContains(byte[] t, ShapeField.DecodedTriangle scratchTriangle)	returns true if the provided triangle is within the query
protected boolean	queryIntersects(byte[] t, ShapeField.DecodedTriangle scratchTriangle)	returns true if the provided triangle intersects the query
protected Component2D.WithinRelation	queryWithin(byte[] t, ShapeField.DecodedTriangle scratchTriangle)	Return the within relationship between the query and the indexed shape.
protected PointValues.Relation	relateRangeBBoxToQuery(int minXOffset, int minYOffset, byte[] minTriangle, int maxXOffset, int maxYOffset, byte[] maxTriangle)	relates an internal node (bounding box of a range of triangles) to the target query Note: logic is specific to query type see ShapeQuery.relateRangeToQuery(byte[], byte[], org.apache.lucene.document.ShapeField.QueryRelation) and ShapeQuery.relateRangeToQuery(byte[], byte[], org.apache.lucene.document.ShapeField.QueryRelation)
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.ShapeQuery

createWeight, equals, getField, getQueryRelation, queryMatches, relateRangeToQuery, 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

relateRangeBBoxToQuery

protected PointValues.Relation relateRangeBBoxToQuery(int minXOffset,
                                                      int minYOffset,
                                                      byte[] minTriangle,
                                                      int maxXOffset,
                                                      int maxYOffset,
                                                      byte[] maxTriangle)

Description copied from class: ShapeQuery

relates an internal node (bounding box of a range of triangles) to the target query Note: logic is specific to query type see ShapeQuery.relateRangeToQuery(byte[], byte[], org.apache.lucene.document.ShapeField.QueryRelation) and ShapeQuery.relateRangeToQuery(byte[], byte[], org.apache.lucene.document.ShapeField.QueryRelation)

Specified by:

relateRangeBBoxToQuery in class ShapeQuery

queryIntersects

protected boolean queryIntersects(byte[] t,
                                  ShapeField.DecodedTriangle scratchTriangle)

Description copied from class: ShapeQuery

returns true if the provided triangle intersects the query

Specified by:

queryIntersects in class ShapeQuery

queryContains

protected boolean queryContains(byte[] t,
                                ShapeField.DecodedTriangle scratchTriangle)

Description copied from class: ShapeQuery

returns true if the provided triangle is within the query

Specified by:

queryContains in class ShapeQuery

queryWithin

protected Component2D.WithinRelation queryWithin(byte[] t,
                                                 ShapeField.DecodedTriangle scratchTriangle)

Description copied from class: ShapeQuery

Return the within relationship between the query and the indexed shape.

Specified by:

queryWithin in class ShapeQuery

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: ShapeQuery

class specific equals check

Overrides:

equalsTo in class ShapeQuery

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 ShapeQuery

See Also:

Query.equals(Object)