|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.Query org.apache.lucene.search.MultiTermQuery org.apache.lucene.search.TermRangeQuery
public class TermRangeQuery
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 Byte.compareTo(Byte)
. It is not intended
for numerical ranges; use NumericRangeQuery
instead.
This query uses the MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT
rewrite method.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.search.MultiTermQuery |
---|
MultiTermQuery.ConstantScoreAutoRewrite, MultiTermQuery.RewriteMethod, MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite, MultiTermQuery.TopTermsScoringBooleanQueryRewrite |
Field Summary |
---|
Fields inherited from class org.apache.lucene.search.MultiTermQuery |
---|
CONSTANT_SCORE_AUTO_REWRITE_DEFAULT, CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE, CONSTANT_SCORE_FILTER_REWRITE, field, rewriteMethod, SCORING_BOOLEAN_QUERY_REWRITE |
Constructor Summary | |
---|---|
TermRangeQuery(String field,
BytesRef lowerTerm,
BytesRef upperTerm,
boolean includeLower,
boolean includeUpper)
Constructs a query selecting all terms greater/equal than lowerTerm
but less/equal than upperTerm . |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
BytesRef |
getLowerTerm()
Returns the lower value of this range query |
protected TermsEnum |
getTermsEnum(Terms terms,
AttributeSource atts)
Construct the enumeration to be used, expanding the pattern term. |
BytesRef |
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 |
static TermRangeQuery |
newStringRange(String field,
String lowerTerm,
String upperTerm,
boolean includeLower,
boolean includeUpper)
Factory that creates a new TermRangeQuery using Strings for term text. |
String |
toString(String field)
Prints a user-readable version of this query. |
Methods inherited from class org.apache.lucene.search.MultiTermQuery |
---|
getField, getRewriteMethod, getTermsEnum, rewrite, setRewriteMethod |
Methods inherited from class org.apache.lucene.search.Query |
---|
clone, createWeight, extractTerms, getBoost, setBoost, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TermRangeQuery(String field, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)
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.)
field
- The field that holds both lower and upper terms.lowerTerm
- The term text at the lower end of the rangeupperTerm
- The term text at the upper end of the rangeincludeLower
- If true, the lowerTerm
is
included in the range.includeUpper
- If true, the upperTerm
is
included in the range.Method Detail |
---|
public static TermRangeQuery newStringRange(String field, String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper)
public BytesRef getLowerTerm()
public BytesRef getUpperTerm()
public boolean includesLower()
true
if the lower endpoint is inclusive
public boolean includesUpper()
true
if the upper endpoint is inclusive
protected TermsEnum getTermsEnum(Terms terms, AttributeSource atts) throws IOException
MultiTermQuery
TermsEnum.EMPTY
if no
terms match). The TermsEnum must already be
positioned to the first matching term.
The given AttributeSource
is passed by the MultiTermQuery.RewriteMethod
to
provide attributes, the rewrite method uses to inform about e.g. maximum competitive boosts.
This is currently only used by TopTermsRewrite
getTermsEnum
in class MultiTermQuery
IOException
public String toString(String field)
toString
in class Query
public int hashCode()
hashCode
in class MultiTermQuery
public boolean equals(Object obj)
equals
in class MultiTermQuery
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |