org.apache.lucene.search

Class DocValuesRangeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.DocValuesRangeQuery

public final class DocValuesRangeQuery
extends Query

A range query that works on top of the doc values APIs. Such queries are usually slow since they do not use an inverted index. However, in the dense case where most documents match this query, it might be as fast or faster than a regular PointRangeQuery.

NOTE: be very careful using this query: it is typically much slower than using TermsQuery, but in certain specialized cases may be faster.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	field
private boolean	includeLower
private boolean	includeUpper
private java.lang.Object	lowerVal
private java.lang.Object	upperVal

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DocValuesRangeQuery(java.lang.String field, java.lang.Object lowerVal, java.lang.Object upperVal, boolean includeLower, boolean includeUpper)

Method Summary

Modifier and Type	Method and Description
Weight	createWeight(IndexSearcher searcher, boolean needsScores) Expert: Constructs an appropriate Weight implementation for this query.
private static BytesRef	deepCopyOf(BytesRef b)
boolean	equals(java.lang.Object other) Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(DocValuesRangeQuery other)
java.lang.String	getField()
java.lang.Object	getLowerVal()
java.lang.Object	getUpperVal()
int	hashCode() Override and implement query hash code properly in a subclass.
boolean	isIncludeLower()
boolean	isIncludeUpper()
static Query	newBytesRefRange(java.lang.String field, BytesRef lowerVal, BytesRef upperVal, boolean includeLower, boolean includeUpper) Create a new numeric range query on a numeric doc-values field.
static Query	newLongRange(java.lang.String field, java.lang.Long lowerVal, java.lang.Long upperVal, boolean includeLower, boolean includeUpper) Create a new numeric range query on a numeric doc-values field.
Query	rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.
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, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Field Detail

field

private final java.lang.String field

lowerVal

private final java.lang.Object lowerVal

upperVal

private final java.lang.Object upperVal

includeLower

private final boolean includeLower

includeUpper

private final boolean includeUpper

Constructor Detail

DocValuesRangeQuery

private DocValuesRangeQuery(java.lang.String field,
                            java.lang.Object lowerVal,
                            java.lang.Object upperVal,
                            boolean includeLower,
                            boolean includeUpper)

Method Detail

newLongRange

public static Query newLongRange(java.lang.String field,
                                 java.lang.Long lowerVal,
                                 java.lang.Long upperVal,
                                 boolean includeLower,
                                 boolean includeUpper)

Create a new numeric range query on a numeric doc-values field. The field must has been indexed with either DocValuesType.NUMERIC or DocValuesType.SORTED_NUMERIC doc values.

newBytesRefRange

public static Query newBytesRefRange(java.lang.String field,
                                     BytesRef lowerVal,
                                     BytesRef upperVal,
                                     boolean includeLower,
                                     boolean includeUpper)

Create a new numeric range query on a numeric doc-values field. The field must has been indexed with DocValuesType.SORTED or DocValuesType.SORTED_SET doc values.

deepCopyOf

private static BytesRef deepCopyOf(BytesRef b)

equals

public 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(DocValuesRangeQuery 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)

getField

public java.lang.String getField()

getLowerVal

public java.lang.Object getLowerVal()

getUpperVal

public java.lang.Object getUpperVal()

isIncludeLower

public boolean isIncludeLower()

isIncludeUpper

public boolean isIncludeUpper()

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

rewrite

public Query rewrite(IndexReader reader)
              throws java.io.IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Overrides:

rewrite in class Query

Throws:

java.io.IOException

createWeight

public 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