Module org.apache.lucene.spatial3d

Package org.apache.lucene.spatial3d

Class PointInGeo3DShapeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.spatial3d.PointInGeo3DShapeQuery

All Implemented Interfaces:

Accountable

final class PointInGeo3DShapeQuery
extends Query
implements Accountable

Finds all previously indexed points that fall within the specified polygon.

The field must be indexed using Geo3DPoint.

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	BASE_RAM_BYTES
(package private) final String	field
(package private) final GeoShape	shape
(package private) final XYZBounds	shapeBounds

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
PointInGeo3DShapeQuery(String field, GeoShape shape)	The lats/lons must be clockwise or counter-clockwise.

Method Summary

Modifier and Type	Method	Description
Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)	Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object other)	Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(PointInGeo3DShapeQuery other)
String	getField()
GeoShape	getShape()
int	hashCode()	Override and implement query hash code properly in a subclass.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
String	toString(String field)	Prints a query to a string, with field assumed to be the default field and omitted.
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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Details

BASE_RAM_BYTES

private static final long BASE_RAM_BYTES

field

final String field

shape

final GeoShape shape

shapeBounds

final XYZBounds shapeBounds

Constructor Details

PointInGeo3DShapeQuery

public PointInGeo3DShapeQuery(String field,
 GeoShape shape)

The lats/lons must be clockwise or counter-clockwise.

Method Details

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

createWeight

public Weight createWeight(IndexSearcher searcher,
 ScoreMode scoreMode,
 float boost)
                    throws 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

Parameters:

scoreMode - How the produced scorers will be consumed.

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

Throws:

IOException

getField

public String getField()

getShape

public GeoShape getShape()

equals

public boolean equals(Object other)

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

private boolean equalsTo(PointInGeo3DShapeQuery other)

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)

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

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable