public class

TermRangeQuery

extends MultiTermQuery
java.lang.Object
   ↳ org.apache.lucene.search.Query
     ↳ org.apache.lucene.search.MultiTermQuery
       ↳ org.apache.lucene.search.TermRangeQuery

Class Overview

A Query that matches documents within an range of terms.

This query matches the documents looking for terms that fall into the supplied range according to compareTo(String), unless a Collator is provided. It is not intended for numerical ranges; use NumericRangeQuery instead.

This query uses the CONSTANT_SCORE_AUTO_REWRITE_DEFAULT rewrite method.

Summary

[Expand]
Inherited Fields
From class org.apache.lucene.search.MultiTermQuery
Public Constructors
TermRangeQuery(String field, String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper)
Constructs a query selecting all terms greater/equal than lowerTerm but less/equal than upperTerm.
TermRangeQuery(String field, String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper, Collator collator)
Constructs a query selecting all terms greater/equal than lowerTerm but less/equal than upperTerm.
Public Methods
boolean equals(Object obj)
Collator getCollator()
Returns the collator used to determine range inclusion, if any.
String getField()
Returns the field name for this query
String getLowerTerm()
Returns the lower value of this range query
String getUpperTerm()
Returns the upper value of this range query
int hashCode()
boolean includesLower()
Returns true if the lower endpoint is inclusive
boolean includesUpper()
Returns true if the upper endpoint is inclusive
String toString(String field)
Prints a user-readable version of this query.
Protected Methods
FilteredTermEnum getEnum(IndexReader reader)
Construct the enumeration to be used, expanding the pattern term.
[Expand]
Inherited Methods
From class org.apache.lucene.search.MultiTermQuery
From class org.apache.lucene.search.Query
From class java.lang.Object

Public Constructors

public TermRangeQuery (String field, String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper)

Constructs a query selecting all terms greater/equal than lowerTerm but less/equal than upperTerm.

If an endpoint is null, it is said to be "open". Either or both endpoints may be open. Open endpoints may not be exclusive (you can't select all but the first or last term without explicitly specifying the term to exclude.)

Parameters
field The field that holds both lower and upper terms.
lowerTerm The term text at the lower end of the range
upperTerm The term text at the upper end of the range
includeLower If true, the lowerTerm is included in the range.
includeUpper If true, the upperTerm is included in the range.

public TermRangeQuery (String field, String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper, Collator collator)

Constructs a query selecting all terms greater/equal than lowerTerm but less/equal than upperTerm.

If an endpoint is null, it is said to be "open". Either or both endpoints may be open. Open endpoints may not be exclusive (you can't select all but the first or last term without explicitly specifying the term to exclude.)

If collator is not null, it will be used to decide whether index terms are within the given range, rather than using the Unicode code point order in which index terms are stored.

WARNING: Using this constructor and supplying a non-null value in the collator parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined. Depending on the number of index Terms in this Field, the operation could be very slow.

Parameters
lowerTerm The Term text at the lower end of the range
upperTerm The Term text at the upper end of the range
includeLower If true, the lowerTerm is included in the range.
includeUpper If true, the upperTerm is included in the range.
collator The collator to use to collate index Terms, to determine their membership in the range bounded by lowerTerm and upperTerm.

Public Methods

public boolean equals (Object obj)

public Collator getCollator ()

Returns the collator used to determine range inclusion, if any.

public String getField ()

Returns the field name for this query

public String getLowerTerm ()

Returns the lower value of this range query

public String getUpperTerm ()

Returns the upper value of this range query

public int hashCode ()

public boolean includesLower ()

Returns true if the lower endpoint is inclusive

public boolean includesUpper ()

Returns true if the upper endpoint is inclusive

public String toString (String field)

Prints a user-readable version of this query.

Protected Methods

protected FilteredTermEnum getEnum (IndexReader reader)

Construct the enumeration to be used, expanding the pattern term.

Throws
IOException