org.apache.lucene.search

Class PointInSetQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.PointInSetQuery

public abstract class PointInSetQuery
extends Query

Abstract query class to find all documents whose single or multi-dimensional point values, previously indexed with e.g. IntPoint, is contained in the specified set.

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.newSetQuery() for fields indexed with IntPoint.

See Also:

PointValues

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PointInSetQuery.Stream Iterator of encoded point values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PointInSetQuery(String field, int numDims, int bytesPerDim, PointInSetQuery.Stream packedPoints) The packedPoints iterator must be in sorted order.

Method Summary

Modifier and Type	Method and Description
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(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

PointInSetQuery

protected PointInSetQuery(String field,
                          int numDims,
                          int bytesPerDim,
                          PointInSetQuery.Stream packedPoints)

The packedPoints iterator must be in sorted order.

Method Detail

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(byte[] value)

Returns a string of a single value in a human-readable format for debugging. This is used by Query.toString(). The default implementation encodes the individual byte values.

Parameters:

value - single value, never null

Returns:

human readable value for debugging