Class FunctionScoreQuery
If the DoubleValuesSource doesn't return a value for a particular document, then that document will be given a score of 0.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
(package private) static class
private static class
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFunctionScoreQuery
(Query in, DoubleValuesSource source) Create a new FunctionScoreQuery -
Method Summary
Modifier and TypeMethodDescriptionstatic FunctionScoreQuery
boostByQuery
(Query in, Query boostMatch, float boostValue) Returns a FunctionScoreQuery where the scores of a wrapped query are multiplied by a boost factor if the document being scored also matches a separate boosting query.static FunctionScoreQuery
boostByValue
(Query in, DoubleValuesSource boost) Returns a FunctionScoreQuery where the scores of a wrapped query are multiplied by the value of a DoubleValuesSource.createWeight
(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.int
hashCode()
Override and implement query hash code properly in a subclass.rewrite
(IndexSearcher indexSearcher) 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 queries.Methods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
-
Field Details
-
in
-
source
-
-
Constructor Details
-
FunctionScoreQuery
Create a new FunctionScoreQuery- Parameters:
in
- the query to wrapsource
- a source of scores
-
-
Method Details
-
getWrappedQuery
- Returns:
- the wrapped Query
-
getSource
- Returns:
- the underlying value source
-
boostByValue
Returns a FunctionScoreQuery where the scores of a wrapped query are multiplied by the value of a DoubleValuesSource.If the source has no value for a particular document, the score for that document is preserved as-is.
- Parameters:
in
- the query to boostboost
- aDoubleValuesSource
containing the boost values
-
boostByQuery
Returns a FunctionScoreQuery where the scores of a wrapped query are multiplied by a boost factor if the document being scored also matches a separate boosting query.Documents that do not match the boosting query have their scores preserved.
This may be used to 'demote' documents that match the boosting query, by passing in a boostValue between 0 and 1.
- Parameters:
in
- the query to boostboostMatch
- the boosting queryboostValue
- the amount to boost documents which match the boosting query
-
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
- Parameters:
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-
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.Callers are expected to call
rewrite
multiple times if necessary, until the rewritten query is the same as the original query.The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.
- Overrides:
rewrite
in classQuery
- Throws:
IOException
- See Also:
-
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. -
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 to those of the 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.
-