org.apache.lucene.document

Class LatLonShapeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.document.LatLonShapeQuery

Direct Known Subclasses:

LatLonShapeBoundingBoxQuery, LatLonShapeLineQuery, LatLonShapePolygonQuery

abstract class LatLonShapeQuery
extends Query

Base LatLonShape Query class providing common query logic for LatLonShapeBoundingBoxQuery and LatLonShapePolygonQuery Note: this class implements the majority of the INTERSECTS, WITHIN, DISJOINT relation logic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LatLonShapeQuery.RelationScorerSupplier utility class for implementing constant score logic specific to INTERSECT, WITHIN, and DISJOINT

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	field field name
(package private) LatLonShape.QueryRelation	queryRelation query relation disjoint: CELL_OUTSIDE_QUERY intersects: CELL_CROSSES_QUERY, within: CELL_WITHIN_QUERY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LatLonShapeQuery(java.lang.String field, LatLonShape.QueryRelation queryType)

Method Summary

Modifier and Type	Method and Description
Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(java.lang.Object o) Override and implement query instance equivalence properly in a subclass.
protected boolean	equalsTo(java.lang.Object o)
java.lang.String	getField() returns the field name
LatLonShape.QueryRelation	getQueryRelation() returns the query relation
int	hashCode() Override and implement query hash code properly in a subclass.
protected abstract boolean	queryMatches(byte[] triangle, int[] scratchTriangle, LatLonShape.QueryRelation queryRelation) returns true if the provided triangle matches the query
protected abstract 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 relateRangeToQuery(byte[], byte[], org.apache.lucene.document.LatLonShape.QueryRelation) and relateRangeToQuery(byte[], byte[], org.apache.lucene.document.LatLonShape.QueryRelation)
protected PointValues.Relation	relateRangeToQuery(byte[] minTriangle, byte[] maxTriangle, LatLonShape.QueryRelation queryRelation) relates a range of triangles (internal node) to the query
private 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, sameClassAs, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

field

final java.lang.String field

field name

queryRelation

final LatLonShape.QueryRelation queryRelation

query relation disjoint: CELL_OUTSIDE_QUERY intersects: CELL_CROSSES_QUERY, within: CELL_WITHIN_QUERY

Constructor Detail

LatLonShapeQuery

protected LatLonShapeQuery(java.lang.String field,
                           LatLonShape.QueryRelation queryType)

Method Detail

relateRangeBBoxToQuery

protected abstract 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 relateRangeToQuery(byte[], byte[], org.apache.lucene.document.LatLonShape.QueryRelation) and relateRangeToQuery(byte[], byte[], org.apache.lucene.document.LatLonShape.QueryRelation)

queryMatches

protected abstract boolean queryMatches(byte[] triangle,
                                        int[] scratchTriangle,
                                        LatLonShape.QueryRelation queryRelation)

returns true if the provided triangle matches the query

relateRangeToQuery

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

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

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries

Overrides:

visit in class Query

Parameters:

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

createWeight

public final Weight createWeight(IndexSearcher searcher,
                                 ScoreMode scoreMode,
                                 float boost)
                          throws java.io.IOException

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

scoreMode - How the produced scorers will be consumed.

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

Throws:

java.io.IOException

getField

public java.lang.String getField()

returns the field name

getQueryRelation

public LatLonShape.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(java.lang.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 that 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(java.lang.Object o)

transposeRelation

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

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