org.apache.solr.search
Class QParser

java.lang.Object
  org.apache.solr.search.QParser

Direct Known Subclasses:

FunctionQParser

public abstract class QParser
extends Object

Constructor Summary

QParser(String qstr, org.apache.solr.common.params.SolrParams localParams, org.apache.solr.common.params.SolrParams params, SolrQueryRequest req)

Method Summary

void	addDebugInfo(org.apache.solr.common.util.NamedList<Object> debugInfo)
String[]	getDefaultHighlightFields()
org.apache.lucene.search.Query	getHighlightQuery()
org.apache.solr.common.params.SolrParams	getLocalParams()
protected String	getParam(String name) check both local and global params
org.apache.solr.common.params.SolrParams	getParams()
static QParser	getParser(String qstr, String defaultType, SolrQueryRequest req) Create a QParser to parse qstr, assuming that the default query type is defaultType.
org.apache.lucene.search.Query	getQuery() Returns the resulting query from this QParser, calling parse() only the first time and caching the Query result.
SolrQueryRequest	getReq()
SortSpec	getSort(boolean useGlobalParams)
String	getString()
abstract org.apache.lucene.search.Query	parse() Create and return the Query object represented by qstr
void	setLocalParams(org.apache.solr.common.params.SolrParams localParams)
void	setParams(org.apache.solr.common.params.SolrParams params)
void	setReq(SolrQueryRequest req)
void	setString(String s)
QParser	subQuery(String q, String defaultType) Create a new QParser for parsing an embedded sub-query

Methods inherited from class java.lang.Object

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

Constructor Detail

QParser

public QParser(String qstr,
               org.apache.solr.common.params.SolrParams localParams,
               org.apache.solr.common.params.SolrParams params,
               SolrQueryRequest req)

Method Detail

parse

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

Create and return the Query object represented by qstr

Throws:

org.apache.lucene.queryParser.ParseException

See Also:

getQuery()

getLocalParams

public org.apache.solr.common.params.SolrParams getLocalParams()

setLocalParams

public void setLocalParams(org.apache.solr.common.params.SolrParams localParams)

getParams

public org.apache.solr.common.params.SolrParams getParams()

setParams

public void setParams(org.apache.solr.common.params.SolrParams params)

getReq

public SolrQueryRequest getReq()

setReq

public void setReq(SolrQueryRequest req)

getString

public String getString()

setString

public void setString(String s)

getQuery

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

Returns the resulting query from this QParser, calling parse() only the first time and caching the Query result.

Throws:

org.apache.lucene.queryParser.ParseException

getParam

protected String getParam(String name)

check both local and global params

subQuery

public QParser subQuery(String q,
                        String defaultType)
                 throws org.apache.lucene.queryParser.ParseException

Create a new QParser for parsing an embedded sub-query

Throws:

org.apache.lucene.queryParser.ParseException

getSort

public SortSpec getSort(boolean useGlobalParams)
                 throws org.apache.lucene.queryParser.ParseException

Parameters:

useGlobalParams - look up sort, start, rows in global params if not in local params

Returns:

the sort specification

Throws:

org.apache.lucene.queryParser.ParseException

getDefaultHighlightFields

public String[] getDefaultHighlightFields()

getHighlightQuery

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

Throws:

org.apache.lucene.queryParser.ParseException

addDebugInfo

public void addDebugInfo(org.apache.solr.common.util.NamedList<Object> debugInfo)

getParser

public static QParser getParser(String qstr,
                                String defaultType,
                                SolrQueryRequest req)
                         throws org.apache.lucene.queryParser.ParseException

Create a QParser to parse qstr, assuming that the default query type is defaultType. The query type may be overridden by local parameters in the query string itself. For example if defaultType="dismax" and qstr=foo, then the dismax query parser will be used to parse and construct the query object. However if qstr={!prefix f=myfield}foo then the prefix query parser will be used.

Throws:

org.apache.lucene.queryParser.ParseException