org.apache.lucene.search
Class WildcardQuery

java.lang.Object
  org.apache.lucene.search.Query
      org.apache.lucene.search.MultiTermQuery
          org.apache.lucene.search.WildcardQuery

All Implemented Interfaces:

Serializable, Cloneable

public class WildcardQuery
extends MultiTermQuery

Implements the wildcard search query. Supported wildcards are *, which matches any character sequence (including the empty one), and ?, which matches any single character. Note this query can be slow, as it needs to iterate over many terms. In order to prevent extremely slow WildcardQueries, a Wildcard term should not start with one of the wildcards * or ?.

This query uses the MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT rewrite method.

See Also:

WildcardTermEnum, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.MultiTermQuery

MultiTermQuery.ConstantScoreAutoRewrite, MultiTermQuery.RewriteMethod, MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite, MultiTermQuery.TopTermsScoringBooleanQueryRewrite

Field Summary

protected Term

term

Fields inherited from class org.apache.lucene.search.MultiTermQuery

CONSTANT_SCORE_AUTO_REWRITE_DEFAULT, CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE, CONSTANT_SCORE_FILTER_REWRITE, rewriteMethod, SCORING_BOOLEAN_QUERY_REWRITE

Constructor Summary

WildcardQuery(Term term)

Method Summary

boolean	equals(Object obj)
protected FilteredTermEnum	getEnum(IndexReader reader) Construct the enumeration to be used, expanding the pattern term.
Term	getTerm() Returns the pattern term.
int	hashCode()
String	toString(String field) Prints a user-readable version of this query.

Methods inherited from class org.apache.lucene.search.MultiTermQuery

clearTotalNumberOfTerms, getRewriteMethod, getTotalNumberOfTerms, incTotalNumberOfTerms, rewrite, setRewriteMethod

Methods inherited from class org.apache.lucene.search.Query

clone, combine, createWeight, extractTerms, getBoost, getSimilarity, mergeBooleanQueries, setBoost, toString, weight

Methods inherited from class java.lang.Object

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

Field Detail

term

protected Term term

Constructor Detail

WildcardQuery

public WildcardQuery(Term term)

Method Detail

getEnum

protected FilteredTermEnum getEnum(IndexReader reader)
                            throws IOException

Description copied from class: MultiTermQuery

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

Specified by:

getEnum in class MultiTermQuery

Throws:

IOException

getTerm

public Term getTerm()

Returns the pattern term.

toString

public String toString(String field)

Prints a user-readable version of this query.

Specified by:

toString in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class MultiTermQuery

equals

public boolean equals(Object obj)

Overrides:

equals in class MultiTermQuery