org.apache.lucene.document

Class XYShapeBoundingBoxQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.document.XYShapeBoundingBoxQuery

public class XYShapeBoundingBoxQuery
extends Query

Finds all previously indexed cartesian shapes that intersect the specified bounding box.

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

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
XYShapeBoundingBoxQuery(String field, ShapeField.QueryRelation queryRelation, double minX, double maxX, double minY, double maxY)

Method Summary

Modifier and Type	Method and Description
Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
boolean	equals(Object o)
protected boolean	equalsTo(Object o)
String	getField() returns the field name
ShapeField.QueryRelation	getQueryRelation() returns the query relation
int	hashCode()
protected boolean	queryMatches(byte[] t, ShapeField.DecodedTriangle scratchTriangle, ShapeField.QueryRelation queryRelation) returns true if the query matches the encoded triangle
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)
protected PointValues.Relation	relateRangeToQuery(byte[] minTriangle, byte[] maxTriangle, ShapeField.QueryRelation queryRelation) relates a range of triangles (internal node) to the query
String	toString(String field)
void	visit(QueryVisitor visitor)

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

Constructor Detail

XYShapeBoundingBoxQuery

public XYShapeBoundingBoxQuery(String field,
                               ShapeField.QueryRelation queryRelation,
                               double minX,
                               double maxX,
                               double minY,
                               double maxY)

Method Detail

relateRangeBBoxToQuery

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)

queryMatches

protected boolean queryMatches(byte[] t,
                               ShapeField.DecodedTriangle scratchTriangle,
                               ShapeField.QueryRelation queryRelation)

returns true if the query matches the encoded triangle

queryWithin

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

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

equals

public boolean equals(Object o)

equalsTo

protected boolean equalsTo(Object o)

hashCode

public int hashCode()

toString

public String toString(String field)

Specified by:

toString in class Query

relateRangeToQuery

protected PointValues.Relation relateRangeToQuery(byte[] minTriangle,
                                                  byte[] maxTriangle,
                                                  ShapeField.QueryRelation queryRelation)

relates a range of triangles (internal node) to the query

visit

public void visit(QueryVisitor visitor)

Overrides:

visit in class Query

createWeight

public final Weight createWeight(IndexSearcher searcher,
                                 ScoreMode scoreMode,
                                 float boost)

Overrides:

createWeight in class Query

getField

public String getField()

returns the field name

getQueryRelation

public ShapeField.QueryRelation getQueryRelation()

returns the query relation