The TermRangeQuery type exposes the following members.

Constructors

  NameDescription
Public methodTermRangeQuery(String, String, String, Boolean, Boolean)
Constructs a query selecting all terms greater/equal than
CopyC#
lowerTerm
but less/equal than
CopyC#
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.)

Public methodTermRangeQuery(String, String, String, Boolean, Boolean, CompareInfo)
Constructs a query selecting all terms greater/equal than
CopyC#
lowerTerm
but less/equal than
CopyC#
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

CopyC#
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

CopyC#
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.

Methods

  NameDescription
Public methodClearTotalNumberOfTerms
Expert: Resets the counting of unique terms. Do this before executing the query/filter.
(Inherited from MultiTermQuery.)
Public methodClone
Returns a clone of this query.
(Inherited from Query.)
Public methodCombine
Expert: called when re-writing queries under MultiSearcher. Create a single query suitable for use by all subsearchers (in 1-1 correspondence with queries). This is an optimization of the OR of all queries. We handle the common optimization cases of equal queries and overlapping clauses of boolean OR queries (as generated by MultiTermQuery.rewrite()). Be careful overriding this method as queries[0] determines which method will be called and is not necessarily of the same type as the other queries.
(Inherited from Query.)
Public methodCreateWeight
Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

(Inherited from Query.)
Public methodEquals (Overrides MultiTermQuery..::..Equals(Object).)
Public methodExtractTerms
Expert: adds all terms occuring in this query to the terms set. Only works if this query is in its {@link #rewrite rewritten} form.
(Inherited from Query.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBoost
Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by
CopyC#
b
. The boost is 1.0 by default.
(Inherited from Query.)
Public methodGetCollator
Returns the collator used to determine range inclusion, if any.
Public methodGetEnum (Overrides MultiTermQuery..::..GetEnum(IndexReader).)
Public methodGetField
Returns the field name for this query
Public methodGetHashCode (Overrides MultiTermQuery..::..GetHashCode()()()().)
Public methodGetLowerTerm
Returns the lower value of this range query
Public methodGetRewriteMethod (Inherited from MultiTermQuery.)
Public methodGetSimilarity
Expert: Returns the Similarity implementation to be used for this query. Subclasses may override this method to specify their own Similarity implementation, perhaps one that delegates through that of the Searcher. By default the Searcher's Similarity implementation is returned.
(Inherited from Query.)
Public methodGetTerm Obsolete.
Returns the pattern term.
(Inherited from MultiTermQuery.)
Public methodGetTotalNumberOfTerms
Expert: Return the number of unique terms visited during execution of the query. If there are many of them, you may consider using another query type or optimize your total term count in index.

This method is not thread safe, be sure to only call it when no query is running! If you re-use the same query instance for another search, be sure to first reset the term counter with {@link #clearTotalNumberOfTerms}.

On optimized indexes / no MultiReaders, you get the correct number of unique terms for the whole index. Use this number to compare different queries. For non-optimized indexes this number can also be achived in non-constant-score mode. In constant-score mode you get the total number of terms seeked for all segments / sub-readers.

(Inherited from MultiTermQuery.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpperTerm
Returns the upper value of this range query
Public methodIncludesLower
Returns
CopyC#
true
if the lower endpoint is inclusive
Public methodIncludesUpper
Returns
CopyC#
true
if the upper endpoint is inclusive
Protected methodIncTotalNumberOfTerms (Inherited from MultiTermQuery.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRewrite (Inherited from MultiTermQuery.)
Public methodSetBoost
Sets the boost for this query clause to
CopyC#
b
. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by
CopyC#
b
.
(Inherited from Query.)
Public methodSetRewriteMethod
Sets the rewrite method to be used when executing the query. You can use one of the four core methods, or implement your own subclass of {@link RewriteMethod}.
(Inherited from MultiTermQuery.)
Public methodToString()()()()
Prints a query to a string.
(Inherited from Query.)
Public methodToString(String)
Prints a user-readable version of this query.
(Overrides MultiTermQuery..::..ToString(String).)
Public methodWeight
Expert: Constructs and initializes a Weight for a top-level query.
(Inherited from Query.)

Fields

  NameDescription
Protected fieldrewriteMethod (Inherited from MultiTermQuery.)
Protected fieldterm (Inherited from MultiTermQuery.)

See Also