org.apache.solr.search

Class SolrQueryParser

java.lang.Object

org.apache.lucene.queryParser.QueryParser

org.apache.solr.search.SolrQueryParser

All Implemented Interfaces:

org.apache.lucene.queryParser.QueryParserConstants

Direct Known Subclasses:

ExtendedDismaxQParser.ExtendedSolrQueryParser, SolrPluginUtils.DisjunctionMaxQueryParser

public class SolrQueryParser
extends org.apache.lucene.queryParser.QueryParser

A variation on the Lucene QueryParser which knows about the field types and query time analyzers configured in Solr's schema.xml.

This class also deviates from the Lucene QueryParser by using ConstantScore versions of RangeQuery and PrefixQuery to prevent TooManyClauses exceptions.

If the magic field name "_val_" is used in a term or phrase query, the value is parsed as a function.

See Also:

QueryParsing.parseFunction(java.lang.String, org.apache.solr.schema.IndexSchema)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrQueryParser.MagicFieldName Identifies the list of all known "magic fields" that trigger special parsing behavior

Nested classes/interfaces inherited from class org.apache.lucene.queryParser.QueryParser

org.apache.lucene.queryParser.QueryParser.Operator

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultField
private java.util.Map<FieldType,ReversedWildcardFilterFactory>	leadingWildcards
protected QParser	parser
protected IndexSchema	schema

Fields inherited from class org.apache.lucene.queryParser.QueryParser

AND_OPERATOR, jj_nt, OR_OPERATOR, token, token_source

Fields inherited from interface org.apache.lucene.queryParser.QueryParserConstants

_ESCAPED_CHAR, _NUM_CHAR, _QUOTED_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, BAREOPER, Boost, CARAT, COLON, DEFAULT, EOF, FUZZY_SLOP, LPAREN, MINUS, NOT, NUMBER, OR, PLUS, PREFIXTERM, QUOTED, RangeEx, RANGEEX_END, RANGEEX_GOOP, RANGEEX_QUOTED, RANGEEX_START, RANGEEX_TO, RangeIn, RANGEIN_END, RANGEIN_GOOP, RANGEIN_QUOTED, RANGEIN_START, RANGEIN_TO, RPAREN, STAR, TERM, tokenImage, WILDTERM

Constructor Summary

Constructors

Constructor and Description
SolrQueryParser(IndexSchema schema, java.lang.String defaultField) Constructs a SolrQueryParser using the schema to understand the formats and datatypes of each field.
SolrQueryParser(QParser parser, java.lang.String defaultField)
SolrQueryParser(QParser parser, java.lang.String defaultField, org.apache.lucene.analysis.Analyzer analyzer)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	analyzeIfMultitermTermText(java.lang.String field, java.lang.String part, FieldType fieldType)
private void	checkNullField(java.lang.String field)
protected org.apache.lucene.search.Query	getFieldQuery(java.lang.String field, java.lang.String queryText, boolean quoted)
protected org.apache.lucene.search.Query	getPrefixQuery(java.lang.String field, java.lang.String termStr)
protected org.apache.lucene.search.Query	getRangeQuery(java.lang.String field, java.lang.String part1, java.lang.String part2, boolean inclusive)
protected ReversedWildcardFilterFactory	getReversedWildcardFilterFactory(FieldType fieldType)
protected org.apache.lucene.search.Query	getWildcardQuery(java.lang.String field, java.lang.String termStr)

Methods inherited from class org.apache.lucene.queryParser.QueryParser

addClause, Clause, Conjunction, disable_tracing, enable_tracing, escape, generateParseException, getAllowLeadingWildcard, getAnalyzer, getAutoGeneratePhraseQueries, getBooleanQuery, getBooleanQuery, getDateResolution, getDefaultOperator, getEnablePositionIncrements, getField, getFieldQuery, getFieldQuery, getFuzzyMinSim, getFuzzyPrefixLength, getFuzzyQuery, getLocale, getLowercaseExpandedTerms, getMultiTermRewriteMethod, getNextToken, getPhraseSlop, getRangeCollator, getToken, main, Modifiers, newBooleanClause, newBooleanQuery, newFuzzyQuery, newMatchAllDocsQuery, newMultiPhraseQuery, newPhraseQuery, newPrefixQuery, newRangeQuery, newTermQuery, newWildcardQuery, parse, Query, ReInit, ReInit, setAllowLeadingWildcard, setAutoGeneratePhraseQueries, setDateResolution, setDateResolution, setDefaultOperator, setEnablePositionIncrements, setFuzzyMinSim, setFuzzyPrefixLength, setLocale, setLowercaseExpandedTerms, setMultiTermRewriteMethod, setPhraseSlop, setRangeCollator, Term, TopLevelQuery

Methods inherited from class java.lang.Object

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

Field Detail

schema

protected final IndexSchema schema

parser

protected final QParser parser

defaultField

protected final java.lang.String defaultField

leadingWildcards

private java.util.Map<FieldType,ReversedWildcardFilterFactory> leadingWildcards

Constructor Detail

SolrQueryParser

public SolrQueryParser(IndexSchema schema,
                       java.lang.String defaultField)

Constructs a SolrQueryParser using the schema to understand the formats and datatypes of each field. Only the defaultSearchField will be used from the IndexSchema (unless overridden), <solrQueryParser> will not be used.

Parameters:

schema - Used for default search field name if defaultField is null and field information is used for analysis

defaultField - default field used for unspecified search terms. if null, the schema default field is used

See Also:

IndexSchema.getDefaultSearchFieldName()

SolrQueryParser

public SolrQueryParser(QParser parser,
                       java.lang.String defaultField)

SolrQueryParser

public SolrQueryParser(QParser parser,
                       java.lang.String defaultField,
                       org.apache.lucene.analysis.Analyzer analyzer)

Method Detail

getReversedWildcardFilterFactory

protected ReversedWildcardFilterFactory getReversedWildcardFilterFactory(FieldType fieldType)

checkNullField

private void checkNullField(java.lang.String field)
                     throws SolrException

Throws:

SolrException

analyzeIfMultitermTermText

protected java.lang.String analyzeIfMultitermTermText(java.lang.String field,
                                                      java.lang.String part,
                                                      FieldType fieldType)

getFieldQuery

protected org.apache.lucene.search.Query getFieldQuery(java.lang.String field,
                                                       java.lang.String queryText,
                                                       boolean quoted)
                                                throws org.apache.lucene.queryParser.ParseException

Overrides:

getFieldQuery in class org.apache.lucene.queryParser.QueryParser

Throws:

org.apache.lucene.queryParser.ParseException

getRangeQuery

protected org.apache.lucene.search.Query getRangeQuery(java.lang.String field,
                                                       java.lang.String part1,
                                                       java.lang.String part2,
                                                       boolean inclusive)
                                                throws org.apache.lucene.queryParser.ParseException

Overrides:

getRangeQuery in class org.apache.lucene.queryParser.QueryParser

Throws:

org.apache.lucene.queryParser.ParseException

getPrefixQuery

protected org.apache.lucene.search.Query getPrefixQuery(java.lang.String field,
                                                        java.lang.String termStr)
                                                 throws org.apache.lucene.queryParser.ParseException

Overrides:

getPrefixQuery in class org.apache.lucene.queryParser.QueryParser

Throws:

org.apache.lucene.queryParser.ParseException

getWildcardQuery

protected org.apache.lucene.search.Query getWildcardQuery(java.lang.String field,
                                                          java.lang.String termStr)
                                                   throws org.apache.lucene.queryParser.ParseException

Overrides:

getWildcardQuery in class org.apache.lucene.queryParser.QueryParser

Throws:

org.apache.lucene.queryParser.ParseException