Module org.apache.lucene.core

Package org.apache.lucene.document

Class SpatialQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.document.SpatialQuery

Direct Known Subclasses:

BaseShapeDocValuesQuery, LatLonPointQuery, LatLonShapeBoundingBoxQuery, LatLonShapeQuery, XYShapeQuery

abstract class SpatialQuery
extends Query

Base query class for all spatial geometries: LatLonShape, LatLonPoint and XYShape. In order to create a query, use the factory methods on those classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpatialQuery.EncodedRectangle	Holds spatial logic for a bounding box that works in the encoded space
private static class	SpatialQuery.RelationScorerSupplier	utility class for implementing constant score logic specific to INTERSECT, WITHIN, and DISJOINT
protected static class	SpatialQuery.SpatialVisitor	Visitor used for walking the BKD tree.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final String	field	field name
(package private) final Geometry[]	geometries
(package private) final Component2D	queryComponent2D
(package private) final ShapeField.QueryRelation	queryRelation	query relation disjoint: ShapeField.QueryRelation.DISJOINT, intersects: ShapeField.QueryRelation.INTERSECTS, within: ShapeField.QueryRelation.DISJOINT, contains: ShapeField.QueryRelation.CONTAINS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SpatialQuery(String field, ShapeField.QueryRelation queryRelation, Geometry... geometries)

Method Summary

Modifier and Type	Method	Description
protected abstract Component2D	createComponent2D(Geometry... geometries)
final Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)	Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object o)	Override and implement query instance equivalence properly in a subclass.
protected boolean	equalsTo(Object o)	class specific equals check
private static PointValues.IntersectVisitor	getContainsDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation, FixedBitSet result, FixedBitSet excluded, long[] cost)	create a visitor that adds documents that match the query using a dense bitset; used with CONTAINS
private static PointValues.IntersectVisitor	getDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation, FixedBitSet result, FixedBitSet excluded, long[] cost)	create a visitor that adds documents that match the query using a dense bitset; used with WITHIN invalid input: '&' DISJOINT
private static PointValues.IntersectVisitor	getEstimateVisitor(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation)	create a visitor for calculating point count estimates for the provided relation
String	getField()	returns the field name
private static PointValues.IntersectVisitor	getIntersectsDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation, FixedBitSet result, long[] cost)	Scorer used for INTERSECTS when the number of points > 4 * number of docs
private static PointValues.IntersectVisitor	getInverseDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation, FixedBitSet result, long[] cost)	create a visitor that clears documents that do not match the polygon query using a dense bitset; used with WITHIN invalid input: '&' DISJOINT
ShapeField.QueryRelation	getQueryRelation()	returns the query relation
protected ScorerSupplier	getScorerSupplier(LeafReader reader, SpatialQuery.SpatialVisitor spatialVisitor, ScoreMode scoreMode, ConstantScoreWeight weight, float boost, float score)
private static PointValues.IntersectVisitor	getShallowInverseDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation, FixedBitSet result)	create a visitor that clears documents that do not match the polygon query using a dense bitset; used with WITHIN invalid input: '&' DISJOINT.
private static PointValues.IntersectVisitor	getSparseVisitor(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation, DocIdSetBuilder result)	create a visitor that adds documents that match the query using a sparse bitset.
protected abstract SpatialQuery.SpatialVisitor	getSpatialVisitor()	returns the spatial visitor to be used for this query.
private static boolean	hasAnyHits(SpatialQuery.SpatialVisitor spatialVisitor, ShapeField.QueryRelation queryRelation, PointValues values)	Return true if the query matches at least one document.
int	hashCode()	Override and implement query hash code properly in a subclass.
protected boolean	queryIsCacheable(LeafReaderContext ctx)
String	toString(String field)	Prints a query to a string, with field assumed to be the default field and omitted.
protected static PointValues.Relation	transposeRelation(PointValues.Relation r)	transpose the relation; INSIDE becomes OUTSIDE, OUTSIDE becomes INSIDE, CROSSES remains unchanged
void	visit(QueryVisitor visitor)	Recurse through the query tree, visiting any child queries.

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

classHash, rewrite, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Field Details

field

final String field

field name

queryRelation

final ShapeField.QueryRelation queryRelation

query relation disjoint: ShapeField.QueryRelation.DISJOINT, intersects: ShapeField.QueryRelation.INTERSECTS, within: ShapeField.QueryRelation.DISJOINT, contains: ShapeField.QueryRelation.CONTAINS

geometries

final Geometry[] geometries

queryComponent2D

final Component2D queryComponent2D

Constructor Details

SpatialQuery

protected SpatialQuery(String field,
 ShapeField.QueryRelation queryRelation,
 Geometry... geometries)

Method Details

createComponent2D

protected abstract Component2D createComponent2D(Geometry... geometries)

getSpatialVisitor

protected abstract SpatialQuery.SpatialVisitor getSpatialVisitor()

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

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries.

Specified by:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

queryIsCacheable

protected boolean queryIsCacheable(LeafReaderContext ctx)

getScorerSupplier

protected ScorerSupplier getScorerSupplier(LeafReader reader,
 SpatialQuery.SpatialVisitor spatialVisitor,
 ScoreMode scoreMode,
 ConstantScoreWeight weight,
 float boost,
 float score)
                                    throws IOException

Throws:

IOException

createWeight

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

Description copied from class: Query

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Overrides:

createWeight in class Query

Parameters:

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

getField

public String getField()

returns the field name

getQueryRelation

public ShapeField.QueryRelation getQueryRelation()

returns the query relation

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.

Specified by:

hashCode in class Query

See Also:

• Query.equals(Object)

equals

public boolean equals(Object o)

Description copied from class: Query

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

Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical to those of the other instance. Utility methods are provided for certain repetitive code.

Specified by:

equals in class Query

See Also:

• Query.sameClassAs(Object)
• Query.classHash()

equalsTo

protected boolean equalsTo(Object o)

class specific equals check

transposeRelation

protected static PointValues.Relation transposeRelation(PointValues.Relation r)

transpose the relation; INSIDE becomes OUTSIDE, OUTSIDE becomes INSIDE, CROSSES remains unchanged

getEstimateVisitor

private static PointValues.IntersectVisitor getEstimateVisitor(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation)

create a visitor for calculating point count estimates for the provided relation

getSparseVisitor

private static PointValues.IntersectVisitor getSparseVisitor(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation,
 DocIdSetBuilder result)

create a visitor that adds documents that match the query using a sparse bitset. (Used by INTERSECT when the number of docs invalid input: '<'= 4 * number of points )

getIntersectsDenseVisitor

private static PointValues.IntersectVisitor getIntersectsDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation,
 FixedBitSet result,
 long[] cost)

Scorer used for INTERSECTS when the number of points > 4 * number of docs

getDenseVisitor

private static PointValues.IntersectVisitor getDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation,
 FixedBitSet result,
 FixedBitSet excluded,
 long[] cost)

create a visitor that adds documents that match the query using a dense bitset; used with WITHIN invalid input: '&' DISJOINT

getContainsDenseVisitor

private static PointValues.IntersectVisitor getContainsDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation,
 FixedBitSet result,
 FixedBitSet excluded,
 long[] cost)

create a visitor that adds documents that match the query using a dense bitset; used with CONTAINS

getInverseDenseVisitor

private static PointValues.IntersectVisitor getInverseDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation,
 FixedBitSet result,
 long[] cost)

create a visitor that clears documents that do not match the polygon query using a dense bitset; used with WITHIN invalid input: '&' DISJOINT

getShallowInverseDenseVisitor

private static PointValues.IntersectVisitor getShallowInverseDenseVisitor(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation,
 FixedBitSet result)

create a visitor that clears documents that do not match the polygon query using a dense bitset; used with WITHIN invalid input: '&' DISJOINT. This visitor only takes into account inner nodes

hasAnyHits

private static boolean hasAnyHits(SpatialQuery.SpatialVisitor spatialVisitor,
 ShapeField.QueryRelation queryRelation,
 PointValues values)
                           throws IOException

Return true if the query matches at least one document. It creates a visitor that terminates as soon as one or more docs are matched.

Throws:

IOException

toString

public String toString(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