org.apache.solr.search

Class ExtendedDismaxQParser.ExtendedSolrQueryParser

java.lang.Object

org.apache.lucene.queryParser.QueryParser

org.apache.solr.search.SolrQueryParser

org.apache.solr.search.ExtendedDismaxQParser.ExtendedSolrQueryParser

All Implemented Interfaces:

org.apache.lucene.queryParser.QueryParserConstants

Enclosing class:

ExtendedDismaxQParser

class ExtendedDismaxQParser.ExtendedSolrQueryParser
extends SolrQueryParser

A subclass of SolrQueryParser that supports aliasing fields for constructing DisjunctionMaxQueries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias A simple container for storing alias info

Nested classes/interfaces inherited from class org.apache.solr.search.SolrQueryParser

SolrQueryParser.MagicFieldName

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.util.Map<java.lang.String,ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias>	aliases Where we store a map from field name we expect to see in our query string, to Alias object containing the fields to use in our DisjunctionMaxQuery and the tiebreaker to use.
(package private) boolean	allowWildcard
(package private) ExtendedAnalyzer	analyzer
(package private) boolean	bool
(package private) boolean	disableCoord
(package private) boolean	exceptions
(package private) java.lang.String	field
(package private) float	flt
(package private) boolean	makeDismax
(package private) int	minClauseSize
(package private) java.lang.String	minShouldMatch
(package private) int	slop
(package private) ExtendedDismaxQParser.QType	type
(package private) java.lang.String	val
(package private) java.lang.String	val2

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

defaultField, parser, 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
ExtendedSolrQueryParser(QParser parser, java.lang.String defaultField)

Method Summary

Modifier and Type	Method and Description
void	addAlias(java.lang.String field, float tiebreaker, java.util.Map<java.lang.String,java.lang.Float> fieldBoosts) Add an alias to this query parser.
protected void	addClause(java.util.List clauses, int conj, int mods, org.apache.lucene.search.Query q)
ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias	getAlias(java.lang.String field) Returns the aliases found for a field.
protected org.apache.lucene.search.Query	getAliasedQuery() Delegates to the super class unless the field has been specified as an alias -- in which case we recurse on each of the aliased fields, and the results are composed into a DisjunctionMaxQuery.
protected org.apache.lucene.search.Query	getBooleanQuery(java.util.List clauses, boolean disableCoord)
protected org.apache.lucene.search.Query	getFieldQuery(java.lang.String field, java.lang.String val, boolean quoted)
protected org.apache.lucene.search.Query	getFieldQuery(java.lang.String field, java.lang.String val, int slop)
protected org.apache.lucene.search.Query	getFuzzyQuery(java.lang.String field, java.lang.String val, float minSimilarity)
protected org.apache.lucene.search.Query	getPrefixQuery(java.lang.String field, java.lang.String val)
protected java.util.List<org.apache.lucene.search.Query>	getQueries(ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias a)
private org.apache.lucene.search.Query	getQuery()
protected org.apache.lucene.search.Query	getRangeQuery(java.lang.String field, java.lang.String a, java.lang.String b, boolean inclusive)
protected org.apache.lucene.search.Query	getWildcardQuery(java.lang.String field, java.lang.String val)
void	setRemoveStopFilter(boolean remove)
private void	validateCyclicAliasing(java.lang.String field) Validate there is no cyclic referencing in the aliasing
private boolean	validateField(java.lang.String field, java.util.Set<java.lang.String> set)

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

analyzeIfMultitermTermText, getReversedWildcardFilterFactory

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

Clause, Conjunction, disable_tracing, enable_tracing, escape, generateParseException, getAllowLeadingWildcard, getAnalyzer, getAutoGeneratePhraseQueries, getBooleanQuery, getDateResolution, getDefaultOperator, getEnablePositionIncrements, getField, getFieldQuery, getFuzzyMinSim, getFuzzyPrefixLength, 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

makeDismax

boolean makeDismax

disableCoord

boolean disableCoord

allowWildcard

boolean allowWildcard

minClauseSize

int minClauseSize

exceptions

boolean exceptions

minShouldMatch

java.lang.String minShouldMatch

analyzer

ExtendedAnalyzer analyzer

aliases

protected java.util.Map<java.lang.String,ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias> aliases

Where we store a map from field name we expect to see in our query string, to Alias object containing the fields to use in our DisjunctionMaxQuery and the tiebreaker to use.

type

ExtendedDismaxQParser.QType type

field

java.lang.String field

val

java.lang.String val

val2

java.lang.String val2

bool

boolean bool

flt

float flt

slop

int slop

Constructor Detail

ExtendedSolrQueryParser

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

Method Detail

setRemoveStopFilter

public void setRemoveStopFilter(boolean remove)

getBooleanQuery

protected org.apache.lucene.search.Query getBooleanQuery(java.util.List clauses,
                                                         boolean disableCoord)
                                                  throws org.apache.lucene.queryParser.ParseException

Overrides:

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

Throws:

org.apache.lucene.queryParser.ParseException

addClause

protected void addClause(java.util.List clauses,
                         int conj,
                         int mods,
                         org.apache.lucene.search.Query q)

Overrides:

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

addAlias

public void addAlias(java.lang.String field,
                     float tiebreaker,
                     java.util.Map<java.lang.String,java.lang.Float> fieldBoosts)

Add an alias to this query parser.

Parameters:

field - the field name that should trigger alias mapping

fieldBoosts - the mapping from fieldname to boost value that should be used to build up the clauses of the DisjunctionMaxQuery.

tiebreaker - to the tiebreaker to be used in the DisjunctionMaxQuery

See Also:

SolrPluginUtils.parseFieldBoosts(java.lang.String)

getAlias

public ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias getAlias(java.lang.String field)

Returns the aliases found for a field.

Parameters:

field - source field name

Returns:

null if there are no aliases for the field

getFieldQuery

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

Overrides:

getFieldQuery in class SolrQueryParser

Throws:

org.apache.lucene.queryParser.ParseException

getFieldQuery

protected org.apache.lucene.search.Query getFieldQuery(java.lang.String field,
                                                       java.lang.String val,
                                                       int slop)
                                                throws org.apache.lucene.queryParser.ParseException

Overrides:

getFieldQuery 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 val)
                                                 throws org.apache.lucene.queryParser.ParseException

Overrides:

getPrefixQuery in class SolrQueryParser

Throws:

org.apache.lucene.queryParser.ParseException

getRangeQuery

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

Overrides:

getRangeQuery in class SolrQueryParser

Throws:

org.apache.lucene.queryParser.ParseException

getWildcardQuery

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

Overrides:

getWildcardQuery in class SolrQueryParser

Throws:

org.apache.lucene.queryParser.ParseException

getFuzzyQuery

protected org.apache.lucene.search.Query getFuzzyQuery(java.lang.String field,
                                                       java.lang.String val,
                                                       float minSimilarity)
                                                throws org.apache.lucene.queryParser.ParseException

Overrides:

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

Throws:

org.apache.lucene.queryParser.ParseException

getAliasedQuery

protected org.apache.lucene.search.Query getAliasedQuery()
                                                  throws org.apache.lucene.queryParser.ParseException

Delegates to the super class unless the field has been specified as an alias -- in which case we recurse on each of the aliased fields, and the results are composed into a DisjunctionMaxQuery. (so yes: aliases which point at other aliases should work)

Throws:

org.apache.lucene.queryParser.ParseException

validateCyclicAliasing

private void validateCyclicAliasing(java.lang.String field)
                             throws org.apache.lucene.queryParser.ParseException

Validate there is no cyclic referencing in the aliasing

Throws:

org.apache.lucene.queryParser.ParseException

validateField

private boolean validateField(java.lang.String field,
                              java.util.Set<java.lang.String> set)

getQueries

protected java.util.List<org.apache.lucene.search.Query> getQueries(ExtendedDismaxQParser.ExtendedSolrQueryParser.Alias a)
                                                             throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

getQuery

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

Throws:

org.apache.lucene.queryParser.ParseException