org.apache.lucene.search

Class PointRangeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.PointRangeQuery

public abstract class PointRangeQuery
extends Query

Abstract class for range queries against single or multidimensional points such as IntPoint.

This is for subclasses and works on the underlying binary encoding: to create range queries for lucene's standard Point types, refer to factory methods on those classes, e.g. IntPoint.newRangeQuery() for fields indexed with IntPoint.

For a single-dimensional field this query is a simple range query; in a multi-dimensional field it's a box shape.

See Also:

PointValues

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PointRangeQuery(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(String field, Object lowerPoint, 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(Object other)
int	hashCode()
protected abstract String	toString(int dimension, byte[] value) Returns a string of a single value in a human-readable format for debugging.
String	toString(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

rewrite, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PointRangeQuery

protected PointRangeQuery(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:

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

Method Detail

checkArgs

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

Check preconditions for all factory methods

Throws:

IllegalArgumentException - if field, lowerPoint or upperPoint are null.

createWeight

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

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

Throws:

IOException

hashCode

public final int hashCode()

Overrides:

hashCode in class Query

equals

public final boolean equals(Object other)

Overrides:

equals in class Query

toString

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

toString

protected abstract 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