Package org.apache.solr.search

Class RankQParserPlugin

java.lang.Object

org.apache.solr.search.QParserPlugin

org.apache.solr.search.RankQParserPlugin

All Implemented Interfaces:

SolrInfoBean, NamedListInitializedPlugin

public class RankQParserPlugin
extends QParserPlugin

RankQParserPlugin can be used to introduce document-depending scoring factors to ranking. While this QParser delivers a (subset of) functionality already available via FunctionQParser, the benefit is that RankQParserPlugin can be used in combination with the minExactCount to use BlockMax-WAND algorithm (skip non-competitive documents) to provide faster responses.

Since:

8.6

See Also:

RankField

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankQParserPlugin.RankQParser

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXPONENT
static String	FIELD
static String	FUNCTION
static String	NAME
static String	PIVOT
static String	SCALING_FACTOR
static String	WEIGHT

Fields inherited from class org.apache.solr.search.QParserPlugin

DEFAULT_QTYPE, standardPlugins

Constructor Summary

Constructors

Constructor	Description
RankQParserPlugin()

Method Summary

Modifier and Type	Method	Description
QParser	createParser(String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req)	return a QParser

Methods inherited from class org.apache.solr.search.QParserPlugin

getCategory, getDescription, getMetricNames, getName, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getMetricRegistry, getMetricsSnapshot, registerMetricName

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

FIELD

public static final String FIELD

See Also:

Constant Field Values

FUNCTION

public static final String FUNCTION

See Also:

Constant Field Values

WEIGHT

public static final String WEIGHT

See Also:

Constant Field Values

PIVOT

public static final String PIVOT

See Also:

Constant Field Values

SCALING_FACTOR

public static final String SCALING_FACTOR

See Also:

Constant Field Values

EXPONENT

public static final String EXPONENT

See Also:

Constant Field Values

Constructor Detail

RankQParserPlugin

public RankQParserPlugin()

Method Detail

createParser

public QParser createParser(String qstr,
                            SolrParams localParams,
                            SolrParams params,
                            SolrQueryRequest req)

Description copied from class: QParserPlugin

return a QParser

Specified by:

createParser in class QParserPlugin