| java.lang.Object
 org.apache.lucene.search.Query
All known Subclasses: org.apache.lucene.search.function.CustomScoreQuery, org.apache.lucene.search.FuzzyLikeThisQuery, org.apache.lucene.search.MatchAllDocsQuery, org.apache.lucene.search.ConstantScoreQuery, org.apache.lucene.search.MultiPhraseQuery, org.apache.lucene.search.similar.MoreLikeThisQuery, org.apache.lucene.search.BooleanQuery, org.apache.lucene.search.DisjunctionMaxQuery, org.apache.lucene.search.RangeQuery, org.apache.lucene.search.TermQuery, org.apache.lucene.search.spans.SpanQuery, org.apache.lucene.search.FilteredQuery, org.apache.lucene.search.BoostingQuery, org.apache.lucene.search.ConstantScoreRangeQuery, org.apache.lucene.search.MultiTermQuery, org.apache.lucene.search.PhraseQuery, org.apache.lucene.search.function.ValueSourceQuery, org.apache.lucene.search.PrefixQuery,
| Query | | abstract public class Query implements java.io.Serializable,Cloneable(Code) | | The abstract base class for queries.
Instantiable subclasses are:
A parser for queries is contained in:
|
| Method Summary | |
| public Object | clone()
Returns a clone of this query. | | public Query | combine(Query[] queries)
Expert: called when re-writing queries under MultiSearcher.
Create a single query suitable for use by all subsearchers (in 1-1
correspondence with queries). | | protected Weight | createWeight(Searcher searcher)
Expert: Constructs an appropriate Weight implementation for this query. | | public void | extractTerms(Set terms)
Expert: adds all terms occuring in this query to the terms set. | | public float | getBoost()
Gets the boost for this clause. | | public Similarity | getSimilarity(Searcher searcher)
Expert: Returns the Similarity implementation to be used for this query. | | public static Query | mergeBooleanQueries(Query[] queries)
Expert: merges the clauses of a set of BooleanQuery's into a single
BooleanQuery. | | public Query | rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries. | | public void | setBoost(float b)
Sets the boost for this query clause to b. | | abstract public String | toString(String field)
Prints a query to a string, with field assumed to be the
default field and omitted.
The representation used is one that is supposed to be readable
by
org.apache.lucene.queryParser.QueryParser QueryParser . | | public String | toString()
Prints a query to a string. | | public Weight | weight(Searcher searcher)
Expert: Constructs and initializes a Weight for a top-level query. |
| clone | | public Object clone()(Code) | | Returns a clone of this query.
|
| combine | | public Query combine(Query[] queries)(Code) | | Expert: called when re-writing queries under MultiSearcher.
Create a single query suitable for use by all subsearchers (in 1-1
correspondence with queries). This is an optimization of the OR of
all queries. We handle the common optimization cases of equal
queries and overlapping clauses of boolean OR queries (as generated
by MultiTermQuery.rewrite() and RangeQuery.rewrite()).
Be careful overriding this method as queries[0] determines which
method will be called and is not necessarily of the same type as
the other queries.
|
| createWeight | | protected Weight createWeight(Searcher searcher) throws IOException(Code) | | Expert: Constructs an appropriate Weight implementation for this query.
Only implemented by primitive queries, which re-write to themselves.
|
| extractTerms | | public void extractTerms(Set terms)(Code) | | Expert: adds all terms occuring in this query to the terms set. Only
works if this query is in its
Query.rewrite rewritten form.
throws:
UnsupportedOperationException - if this query is not yet rewritten |
| getBoost | | public float getBoost()(Code) | | Gets the boost for this clause. Documents matching
this clause will (in addition to the normal weightings) have their score
multiplied by b. The boost is 1.0 by default.
|
| getSimilarity | | public Similarity getSimilarity(Searcher searcher)(Code) | | Expert: Returns the Similarity implementation to be used for this query.
Subclasses may override this method to specify their own Similarity
implementation, perhaps one that delegates through that of the Searcher.
By default the Searcher's Similarity implementation is returned.
|
| mergeBooleanQueries | | public static Query mergeBooleanQueries(Query[] queries)(Code) | | Expert: merges the clauses of a set of BooleanQuery's into a single
BooleanQuery.
A utility for use by
Query.combine(Query[]) implementations.
|
| rewrite | | public Query rewrite(IndexReader reader) throws IOException(Code) | | Expert: called to re-write queries into primitive queries. For example,
a PrefixQuery will be rewritten into a BooleanQuery that consists
of TermQuerys.
|
| setBoost | | public void setBoost(float b)(Code) | | Sets the boost for this query clause to b. Documents
matching this clause will (in addition to the normal weightings) have
their score multiplied by b.
|
| toString | | abstract public String toString(String field)(Code) | | Prints a query to a string, with field assumed to be the
default field and omitted.
The representation used is one that is supposed to be readable
by
org.apache.lucene.queryParser.QueryParser QueryParser . However,
there are the following limitations:
- If the query was created by the parser, the printed
representation may not be exactly what was parsed. For example,
characters that need to be escaped will be represented without
the required backslash.
- Some of the more complicated queries (e.g. span queries)
don't have a representation that can be parsed by QueryParser.
|
| toString | | public String toString()(Code) | | Prints a query to a string.
|
|
|