org.apache.lucene.document

Class LatLonPointBoxQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.document.LatLonPointBoxQuery

abstract class LatLonPointBoxQuery
extends Query

Fast version of PointRangeQuery. It is fast for actual range queries!

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	bytesPerDim
(package private) java.lang.String	field
(package private) byte[]	lowerPoint
(package private) int	numDims
(package private) byte[]	upperPoint

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LatLonPointBoxQuery(java.lang.String field, byte[] lowerPoint, byte[] upperPoint, int numDims) Expert: create a multidimensional range query for point values.

Method Summary

Modifier and Type	Method and Description
static void	checkArgs(java.lang.String field, java.lang.Object lowerPoint, java.lang.Object upperPoint) Check preconditions for all factory methods
Weight	createWeight(IndexSearcher searcher, boolean needsScores) Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(java.lang.Object other) Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(LatLonPointBoxQuery other)
int	hashCode() Override and implement query hash code properly in a subclass.
protected abstract java.lang.String	toString(int dimension, byte[] value) Returns a string of a single value in a human-readable format for debugging.
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.search.Query

classHash, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Field Detail

field

final java.lang.String field

numDims

final int numDims

bytesPerDim

final int bytesPerDim

lowerPoint

final byte[] lowerPoint

upperPoint

final byte[] upperPoint

Constructor Detail

LatLonPointBoxQuery

protected LatLonPointBoxQuery(java.lang.String field,
                              byte[] lowerPoint,
                              byte[] upperPoint,
                              int numDims)

Expert: create a multidimensional range query for point values.

Parameters:

field - field name. must not be null.

lowerPoint - lower portion of the range (inclusive).

upperPoint - upper portion of the range (inclusive).

numDims - number of dimensions.

Throws:

java.lang.IllegalArgumentException - if field is null, or if lowerValue.length != upperValue.length

Method Detail

checkArgs

public static void checkArgs(java.lang.String field,
                             java.lang.Object lowerPoint,
                             java.lang.Object upperPoint)

Check preconditions for all factory methods

Throws:

java.lang.IllegalArgumentException - if field, lowerPoint or upperPoint are null.

createWeight

public final Weight createWeight(IndexSearcher searcher,
                                 boolean needsScores)
                          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

needsScores - True if document scores (Scorer.score()) or match frequencies (Scorer.freq()) are needed.

Throws:

java.io.IOException

hashCode

public final 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 final boolean equals(java.lang.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 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

private boolean equalsTo(LatLonPointBoxQuery other)

toString

public final 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

toString

protected abstract java.lang.String toString(int dimension,
                                             byte[] value)

Returns a string of a single value in a human-readable format for debugging. This is used by Query.toString().

Parameters:

dimension - dimension of the particular value

value - single value, never null

Returns:

human readable value for debugging