org.apache.lucene.spatial.prefix

Class ContainsPrefixTreeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.spatial.prefix.AbstractPrefixTreeQuery

org.apache.lucene.spatial.prefix.ContainsPrefixTreeQuery

public class ContainsPrefixTreeQuery
extends AbstractPrefixTreeQuery

Finds docs where its indexed shape CONTAINS the query shape. For use on RecursivePrefixTreeStrategy.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.spatial.prefix.AbstractPrefixTreeQuery

AbstractPrefixTreeQuery.BaseTermsEnumTraverser

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	multiOverlappingIndexedShapes If the spatial data for a document is comprised of multiple overlapping or adjacent parts, it might fail to match a query shape when doing the CONTAINS predicate when the sum of those shapes contain the query shape but none do individually.

Fields inherited from class org.apache.lucene.spatial.prefix.AbstractPrefixTreeQuery

detailLevel, fieldName, grid, queryShape

Constructor Summary

Constructors

Constructor and Description
ContainsPrefixTreeQuery(org.locationtech.spatial4j.shape.Shape queryShape, java.lang.String fieldName, SpatialPrefixTree grid, int detailLevel, boolean multiOverlappingIndexedShapes)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Override and implement query instance equivalence properly in a subclass.
protected DocIdSet	getDocIdSet(LeafReaderContext context)
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.spatial.prefix.AbstractPrefixTreeQuery

createWeight

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

multiOverlappingIndexedShapes

protected final boolean multiOverlappingIndexedShapes

If the spatial data for a document is comprised of multiple overlapping or adjacent parts, it might fail to match a query shape when doing the CONTAINS predicate when the sum of those shapes contain the query shape but none do individually. Set this to false to increase performance if you don't care about that circumstance (such as if your indexed data doesn't even have such conditions). See LUCENE-5062.

Constructor Detail

ContainsPrefixTreeQuery

public ContainsPrefixTreeQuery(org.locationtech.spatial4j.shape.Shape queryShape,
                               java.lang.String fieldName,
                               SpatialPrefixTree grid,
                               int detailLevel,
                               boolean multiOverlappingIndexedShapes)

Method Detail

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.

Overrides:

equals in class AbstractPrefixTreeQuery

See Also:

Query.sameClassAs(Object), Query.classHash()

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 AbstractPrefixTreeQuery

See Also:

Query.equals(Object)

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

getDocIdSet

protected DocIdSet getDocIdSet(LeafReaderContext context)
                        throws java.io.IOException

Specified by:

getDocIdSet in class AbstractPrefixTreeQuery

Throws:

java.io.IOException