org.apache.lucene.search
Class MultiTermQuery

java.lang.Object
  extended by org.apache.lucene.search.Query
      extended by org.apache.lucene.search.MultiTermQuery
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
FuzzyQuery, WildcardQuery

public abstract class MultiTermQuery
extends Query

A Query that matches documents containing a subset of terms provided by a FilteredTermEnum enumeration.

MultiTermQuery is not designed to be used by itself.
The reason being that it is not intialized with a FilteredTermEnum enumeration. A FilteredTermEnum enumeration needs to be provided.

For example, WildcardQuery and FuzzyQuery extend MultiTermQuery to provide WildcardTermEnum and FuzzyTermEnum, respectively.

See Also:
Serialized Form

Constructor Summary
MultiTermQuery(Term term)
          Constructs a query for terms matching term.
 
Method Summary
 Query combine(Query[] queries)
          Expert: called when re-writing queries under MultiSearcher.
protected abstract  FilteredTermEnum getEnum(IndexReader reader)
          Construct the enumeration to be used, expanding the pattern term.
 Term getTerm()
          Returns the pattern term.
 Query rewrite(IndexReader reader)
          Expert: called to re-write queries into primitive queries.
 java.lang.String toString(java.lang.String field)
          Prints a user-readable version of this query.
 
Methods inherited from class org.apache.lucene.search.Query
clone, createWeight, getBoost, getSimilarity, mergeBooleanQueries, setBoost, toString, weight
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MultiTermQuery

public MultiTermQuery(Term term)
Constructs a query for terms matching term.

Method Detail

getTerm

public Term getTerm()
Returns the pattern term.


getEnum

protected abstract FilteredTermEnum getEnum(IndexReader reader)
                                     throws java.io.IOException
Construct the enumeration to be used, expanding the pattern term.

Throws:
java.io.IOException

rewrite

public Query rewrite(IndexReader reader)
              throws java.io.IOException
Description copied from class: Query
Expert: called to re-write queries into primitive queries.

Overrides:
rewrite in class Query
Throws:
java.io.IOException

combine

public Query combine(Query[] queries)
Description copied from class: Query
Expert: called when re-writing queries under MultiSearcher.

Only implemented by derived queries, with no Query.createWeight(Searcher) implementatation.

Overrides:
combine in class Query

toString

public java.lang.String toString(java.lang.String field)
Prints a user-readable version of this query.

Specified by:
toString in class Query


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.