org.apache.solr.search

Class DisMaxQParser

java.lang.Object

org.apache.solr.search.QParser

org.apache.solr.search.DisMaxQParser

public class DisMaxQParser
extends QParser

Query parser for dismax queries

Note: This API is experimental and may change in non backward-compatible ways in the future

Version:

$Id: DisMaxQParser.java 1306151 2012-03-28 04:19:31Z dsmiley $

Field Summary

Fields

Modifier and Type	Field and Description
protected QParser	altQParser
protected org.apache.lucene.search.Query	altUserQuery
protected java.lang.String[]	boostParams
protected java.util.List<org.apache.lucene.search.Query>	boostQueries
private static java.lang.String	IMPOSSIBLE_FIELD_NAME A field we can't ever find in any schema, so we can safely tell DisjunctionMaxQueryParser to use it as our defaultField, and map aliases from it to any field in our schema.
protected org.apache.lucene.search.Query	parsedUserQuery
protected java.util.Map<java.lang.String,java.lang.Float>	queryFields

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

localParams, localParamsEnd, params, qstr, query, recurseCount, req, stringIncludingLocalParams, valFollowedParams

Constructor Summary

Constructors

Constructor and Description
DisMaxQParser(java.lang.String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req)

Method Summary

Modifier and Type	Method and Description
protected void	addBoostFunctions(org.apache.lucene.search.BooleanQuery query, SolrParams solrParams)
protected void	addBoostQuery(org.apache.lucene.search.BooleanQuery query, SolrParams solrParams)
void	addDebugInfo(NamedList<java.lang.Object> debugInfo)
protected boolean	addMainQuery(org.apache.lucene.search.BooleanQuery query, SolrParams solrParams) Adds the main query to the query argument.
protected org.apache.lucene.search.Query	getAlternateUserQuery(SolrParams solrParams)
java.lang.String[]	getDefaultHighlightFields()
org.apache.lucene.search.Query	getHighlightQuery()
protected SolrPluginUtils.DisjunctionMaxQueryParser	getParser(java.util.Map<java.lang.String,java.lang.Float> fields, java.lang.String paramName, SolrParams solrParams, float tiebreaker)
protected org.apache.lucene.search.Query	getPhraseQuery(java.lang.String userQuery, SolrPluginUtils.DisjunctionMaxQueryParser pp)
protected org.apache.lucene.search.Query	getUserQuery(java.lang.String userQuery, SolrPluginUtils.DisjunctionMaxQueryParser up, SolrParams solrParams)
org.apache.lucene.search.Query	parse() Create and return the Query object represented by qstr.

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

getLocalParams, getParam, getParams, getParser, getQuery, getReq, getSort, getString, setLocalParams, setParams, setReq, setString, subQuery

Methods inherited from class java.lang.Object

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

Field Detail

IMPOSSIBLE_FIELD_NAME

private static java.lang.String IMPOSSIBLE_FIELD_NAME

A field we can't ever find in any schema, so we can safely tell DisjunctionMaxQueryParser to use it as our defaultField, and map aliases from it to any field in our schema.

queryFields

protected java.util.Map<java.lang.String,java.lang.Float> queryFields

parsedUserQuery

protected org.apache.lucene.search.Query parsedUserQuery

boostParams

protected java.lang.String[] boostParams

boostQueries

protected java.util.List<org.apache.lucene.search.Query> boostQueries

altUserQuery

protected org.apache.lucene.search.Query altUserQuery

altQParser

protected QParser altQParser

Constructor Detail

DisMaxQParser

public DisMaxQParser(java.lang.String qstr,
                     SolrParams localParams,
                     SolrParams params,
                     SolrQueryRequest req)

Method Detail

parse

public org.apache.lucene.search.Query parse()
                                     throws org.apache.lucene.queryParser.ParseException

Description copied from class: QParser

Create and return the Query object represented by qstr. Null MAY be returned to signify there was no input (e.g. no query string) to parse.

Specified by:

parse in class QParser

Throws:

org.apache.lucene.queryParser.ParseException

See Also:

QParser.getQuery()

addBoostFunctions

protected void addBoostFunctions(org.apache.lucene.search.BooleanQuery query,
                                 SolrParams solrParams)
                          throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

addBoostQuery

protected void addBoostQuery(org.apache.lucene.search.BooleanQuery query,
                             SolrParams solrParams)
                      throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

addMainQuery

protected boolean addMainQuery(org.apache.lucene.search.BooleanQuery query,
                               SolrParams solrParams)
                        throws org.apache.lucene.queryParser.ParseException

Adds the main query to the query argument. If its blank then false is returned.

Throws:

org.apache.lucene.queryParser.ParseException

getAlternateUserQuery

protected org.apache.lucene.search.Query getAlternateUserQuery(SolrParams solrParams)
                                                        throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

getPhraseQuery

protected org.apache.lucene.search.Query getPhraseQuery(java.lang.String userQuery,
                                                        SolrPluginUtils.DisjunctionMaxQueryParser pp)
                                                 throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

getUserQuery

protected org.apache.lucene.search.Query getUserQuery(java.lang.String userQuery,
                                                      SolrPluginUtils.DisjunctionMaxQueryParser up,
                                                      SolrParams solrParams)
                                               throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

getParser

protected SolrPluginUtils.DisjunctionMaxQueryParser getParser(java.util.Map<java.lang.String,java.lang.Float> fields,
                                                              java.lang.String paramName,
                                                              SolrParams solrParams,
                                                              float tiebreaker)

getDefaultHighlightFields

public java.lang.String[] getDefaultHighlightFields()

Overrides:

getDefaultHighlightFields in class QParser

getHighlightQuery

public org.apache.lucene.search.Query getHighlightQuery()
                                                 throws org.apache.lucene.queryParser.ParseException

Overrides:

getHighlightQuery in class QParser

Throws:

org.apache.lucene.queryParser.ParseException

addDebugInfo

public void addDebugInfo(NamedList<java.lang.Object> debugInfo)

Overrides:

addDebugInfo in class QParser