org.apache.solr.search
Class FunctionQParser

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

public class FunctionQParser
extends QParser

Field Summary

protected org.apache.solr.search.QueryParsing.StrParser

sp

Constructor Summary

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

Method Summary

protected boolean	consumeArgumentDelimiter() Consume an argument delimiter (a comma) from the token stream.
boolean	hasMoreArguments() Are there more arguments in the argument list being parsed?
org.apache.lucene.search.Query	parse() Create and return the Query object represented by qstr
Float	parseFloat() Parse a float.
String	parseId() TODO: Doc
org.apache.lucene.search.Query	parseNestedQuery() TODO: Doc
ValueSource	parseValueSource() Parse an individual ValueSource.
protected ValueSource	parseValueSource(boolean doConsumeDelimiter) Parse an individual value source.
List<ValueSource>	parseValueSourceList() Parse a list of ValueSource.

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

addDebugInfo, getDefaultHighlightFields, getHighlightQuery, 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

sp

protected org.apache.solr.search.QueryParsing.StrParser sp

Constructor Detail

FunctionQParser

public FunctionQParser(String qstr,
                       org.apache.solr.common.params.SolrParams localParams,
                       org.apache.solr.common.params.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

Specified by:

parse in class QParser

Throws:

org.apache.lucene.queryParser.ParseException

See Also:

QParser.getQuery()

hasMoreArguments

public boolean hasMoreArguments()
                         throws org.apache.lucene.queryParser.ParseException

Are there more arguments in the argument list being parsed?

Returns:

whether more args exist

Throws:

org.apache.lucene.queryParser.ParseException

parseId

public String parseId()
               throws org.apache.lucene.queryParser.ParseException

TODO: Doc

Throws:

org.apache.lucene.queryParser.ParseException

parseFloat

public Float parseFloat()
                 throws org.apache.lucene.queryParser.ParseException

Parse a float.

Returns:

Float

Throws:

org.apache.lucene.queryParser.ParseException

parseValueSourceList

public List<ValueSource> parseValueSourceList()
                                       throws org.apache.lucene.queryParser.ParseException

Parse a list of ValueSource. Must be the final set of arguments to a ValueSource.

Returns:

List

Throws:

org.apache.lucene.queryParser.ParseException

parseValueSource

public ValueSource parseValueSource()
                             throws org.apache.lucene.queryParser.ParseException

Parse an individual ValueSource.

Throws:

org.apache.lucene.queryParser.ParseException

parseNestedQuery

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

TODO: Doc

Throws:

org.apache.lucene.queryParser.ParseException

parseValueSource

protected ValueSource parseValueSource(boolean doConsumeDelimiter)
                                throws org.apache.lucene.queryParser.ParseException

Parse an individual value source.

Parameters:

doConsumeDelimiter - whether to consume a delimiter following the ValueSource

Throws:

org.apache.lucene.queryParser.ParseException

consumeArgumentDelimiter

protected boolean consumeArgumentDelimiter()
                                    throws org.apache.lucene.queryParser.ParseException

Consume an argument delimiter (a comma) from the token stream. Only consumes if more arguments should exist (no ending parens or end of string).

Returns:

whether a delimiter was consumed

Throws:

org.apache.lucene.queryParser.ParseException