Package org.apache.lucene.search
Class BoostQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.BoostQuery
A
Query
wrapper that allows to give a boost to the wrapped query. Boost values that are
less than one will give less importance to this query compared to other ones while values that
are greater than one will give more importance to the scores returned by this query.
More complex boosts can be applied by using FunctionScoreQuery in the lucene-queries module
-
Constructor Summary
ConstructorDescriptionBoostQuery
(Query query, float boost) Sole constructor: wrapquery
in such a way that the produced scores will be boosted byboost
. -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.float
getBoost()
Return the applied boost.getQuery()
Return the wrappedQuery
.int
hashCode()
Override and implement query hash code properly in a subclass.rewrite
(IndexReader reader) Expert: called to re-write queries into primitive queries.Prints a query to a string, withfield
assumed to be the default field and omitted.void
visit
(QueryVisitor visitor) Recurse through the query tree, visiting any child queriesMethods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
-
Constructor Details
-
BoostQuery
Sole constructor: wrapquery
in such a way that the produced scores will be boosted byboost
.
-
-
Method Details
-
getQuery
Return the wrappedQuery
. -
getBoost
public float getBoost()Return the applied boost. -
equals
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
works properly.Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.
-
hashCode
public int hashCode()Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly. -
rewrite
Description copied from class:Query
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.- Overrides:
rewrite
in classQuery
- Throws:
IOException
-
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries -
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeight
in classQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-