Package org.apache.lucene.search
Class Query
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
BooleanQuery
,BoostedQuery
,BoostingQuery
,CommonTermsQuery
,ConstantScoreQuery
,CustomScoreQuery
,DisjunctionMaxQuery
,DrillDownQuery
,FilteredQuery
,FunctionQuery
,MatchAllDocsQuery
,MoreLikeThisQuery
,MultiPhraseQuery
,MultiTermQuery
,PhraseQuery
,SpanQuery
,TermQuery
public abstract class Query extends Object implements Cloneable
The abstract base class for queries.Instantiable subclasses are:
-
TermQuery
-
BooleanQuery
-
WildcardQuery
-
PhraseQuery
-
PrefixQuery
-
MultiPhraseQuery
-
FuzzyQuery
-
RegexpQuery
-
TermRangeQuery
-
NumericRangeQuery
-
ConstantScoreQuery
-
DisjunctionMaxQuery
-
MatchAllDocsQuery
See also the family of
Span Queries
and additional queries available in the Queries module
-
-
Constructor Summary
Constructors Constructor Description Query()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Query
clone()
Returns a clone of this query.Weight
createWeight(IndexSearcher searcher)
Expert: Constructs an appropriate Weight implementation for this query.boolean
equals(Object obj)
void
extractTerms(Set<Term> terms)
Expert: adds all terms occurring in this query to the terms set.float
getBoost()
Gets the boost for this clause.int
hashCode()
Query
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.void
setBoost(float b)
Sets the boost for this query clause tob
.String
toString()
Prints a query to a string.abstract String
toString(String field)
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
-
-
Method Detail
-
setBoost
public void setBoost(float b)
Sets the boost for this query clause tob
. Documents matching this clause will (in addition to the normal weightings) have their score multiplied byb
.
-
getBoost
public float getBoost()
Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied byb
. The boost is 1.0 by default.
-
toString
public abstract String toString(String field)
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
createWeight
public Weight createWeight(IndexSearcher searcher) throws IOException
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Throws:
IOException
-
rewrite
public Query rewrite(IndexReader reader) throws IOException
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.- Throws:
IOException
-
extractTerms
public void extractTerms(Set<Term> terms)
Expert: adds all terms occurring in this query to the terms set. Only works if this query is in itsrewritten
form.- Throws:
UnsupportedOperationException
- if this query is not yet rewritten
-
clone
public Query clone()
Returns a clone of this query.
-
-