Package org.apache.lucene.search
Class PrefixQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.MultiTermQuery
org.apache.lucene.search.PrefixQuery
- All Implemented Interfaces:
Cloneable
A Query that matches documents containing terms with a specified prefix. A PrefixQuery
is built by QueryParser for input like
app*
.
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the prefix of this query.protected TermsEnum
getTermsEnum
(Terms terms, AttributeSource atts) Construct the enumeration to be used, expanding the pattern term.int
hashCode()
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
-
Constructor Details
-
PrefixQuery
Constructs a query for terms starting withprefix
.
-
-
Method Details
-
getPrefix
Returns the prefix of this query. -
getTermsEnum
Description copied from class:MultiTermQuery
Construct the enumeration to be used, expanding the pattern term. This method should only be called if the field exists (ie, implementations can assume the field does exist). This method should not return null (should instead returnTermsEnum.EMPTY
if no terms match). The TermsEnum must already be positioned to the first matching term. The givenAttributeSource
is passed by theMultiTermQuery.RewriteMethod
to provide attributes, the rewrite method uses to inform about e.g. maximum competitive boosts. This is currently only used byTopTermsRewrite
- Specified by:
getTermsEnum
in classMultiTermQuery
- Throws:
IOException
-
toString
Prints a user-readable version of this query. -
hashCode
public int hashCode()- Overrides:
hashCode
in classMultiTermQuery
-
equals
- Overrides:
equals
in classMultiTermQuery
-