org.apache.lucene.search
Class PrefixQuery

java.lang.Object
  org.apache.lucene.search.Query
      org.apache.lucene.search.PrefixQuery

All Implemented Interfaces:

Cloneable, Serializable

public class PrefixQuery

extends Query

A Query that matches documents containing terms with a specified prefix.

See Also:

Serialized Form

Constructor Summary

PrefixQuery(Term prefix)
Constructs a query for terms starting with prefix.

Method Summary

Query	combine(Query[] queries) Expert: called when re-writing queries under MultiSearcher.
Term	getPrefix() Returns the prefix of this query.
Query	rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.
String	toString(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

PrefixQuery

public PrefixQuery(Term prefix)

Constructs a query for terms starting with prefix.

Method Detail

getPrefix

public Term getPrefix()

Returns the prefix of this query.

rewrite

public Query rewrite(IndexReader reader)
              throws IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries.

Overrides:

rewrite in class Query

Throws:

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 String toString(String field)

Prints a user-readable version of this query.

Specified by:

toString in class Query