javadoc - add date boosting example to boost parser

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@826548 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yonik Seeley 2009-10-18 23:00:23 +00:00
parent 811df47121
commit c4169ad26d
1 changed files with 4 additions and 1 deletions

View File

@ -29,9 +29,12 @@ import org.apache.solr.search.function.ValueSource;
/**
* Create a boosted query from the input value. The main value is the query to be boosted.
* <br>Other parameters: <code>b</code>, the function query to use as the boost.
* <br>Example: <code>{!boost b=log(popularity)}foo</code> creates a query "foo"
* <p>Example: <code>{!boost b=log(popularity)}foo</code> creates a query "foo"
* which is boosted (scores are multiplied) by the function query <code>log(popularity)</code>.
* The query to be boosted may be of any type.
*
* <p>Example: <code>{!boost b=recip(ms(NOW,mydatefield),3.16e-11,1,1)}foo</code> creates a query "foo"
* which is boosted by the date boosting function referenced in {@link org.apache.solr.search.function.ReciprocalFloatFunction}
*/
public class BoostQParserPlugin extends QParserPlugin {
public static String NAME = "boost";