org.apache.lucene.queryparser.classic

Class MapperQueryParser

java.lang.Object

org.apache.lucene.util.QueryBuilder

org.apache.lucene.queryparser.classic.QueryParserBase

org.apache.lucene.queryparser.classic.QueryParser

org.apache.lucene.queryparser.analyzing.AnalyzingQueryParser

org.apache.lucene.queryparser.classic.MapperQueryParser

All Implemented Interfaces:

org.apache.lucene.queryparser.classic.QueryParserConstants, org.apache.lucene.queryparser.flexible.standard.CommonQueryParserConfiguration

public class MapperQueryParser
extends org.apache.lucene.queryparser.analyzing.AnalyzingQueryParser

A query parser that uses the MapperService in order to build smarter queries based on the mapping information.

Also breaks fields with [type].[name] into a boolean query that must include the type as well as the query on the name.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapperQueryParser.CheckedBiFunction<T,U,R> A BiFuntion that can throw an IOException

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

org.apache.lucene.queryparser.classic.QueryParser.Operator

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,FieldQueryExtension>	FIELD_QUERY_EXTENSIONS

Fields inherited from class org.apache.lucene.queryparser.classic.QueryParser

DEFAULT_SPLIT_ON_WHITESPACE, jj_nt, token, token_source

Fields inherited from class org.apache.lucene.queryparser.classic.QueryParserBase

AND_OPERATOR, field, OR_OPERATOR

Fields inherited from class org.apache.lucene.util.QueryBuilder

analyzer, autoGenerateMultiTermSynonymsPhraseQuery, enableGraphQueries, enablePositionIncrements

Fields inherited from interface org.apache.lucene.queryparser.classic.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, Range, RANGE_GOOP, RANGE_QUOTED, RANGE_TO, RANGEEX_END, RANGEEX_START, RANGEIN_END, RANGEIN_START, REGEXPTERM, RPAREN, STAR, TERM, tokenImage, WILDTERM

Constructor Summary

Constructors

Constructor and Description
MapperQueryParser(QueryShardContext context)

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.search.spans.SpanQuery	analyzeGraphPhrase(org.apache.lucene.analysis.TokenStream source, java.lang.String field, int phraseSlop) See analyzeGraphPhraseWithLimit(org.apache.lucene.analysis.TokenStream, java.lang.String, int, org.apache.lucene.queryparser.classic.MapperQueryParser.CheckedBiFunction<org.apache.lucene.analysis.TokenStream, java.lang.String, org.apache.lucene.search.spans.SpanQuery>, boolean)
static org.apache.lucene.search.spans.SpanQuery	analyzeGraphPhraseWithLimit(org.apache.lucene.analysis.TokenStream source, java.lang.String field, int phraseSlop, MapperQueryParser.CheckedBiFunction<org.apache.lucene.analysis.TokenStream,java.lang.String,org.apache.lucene.search.spans.SpanQuery> spanQueryFunc, boolean isHardLimit) Overrides QueryBuilder.analyzeGraphPhrase(TokenStream, String, int) to add a limit (see BooleanQuery.getMaxClauseCount()) to the number of SpanQuery that this method can create.
protected org.apache.lucene.search.Query	createFieldQuery(org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.search.BooleanClause.Occur operator, java.lang.String field, java.lang.String queryText, boolean quoted, int phraseSlop) Checks if graph analysis should be enabled for the field depending on the provided Analyzer
protected org.apache.lucene.search.Query	getBooleanQuery(java.util.List<org.apache.lucene.search.BooleanClause> clauses)
protected org.apache.lucene.search.Query	getBooleanQueryCoordDisabled(java.util.List<org.apache.lucene.search.BooleanClause> clauses) Deprecated. review all use of this, don't rely on coord
org.apache.lucene.search.Query	getFieldQuery(java.lang.String field, java.lang.String queryText, boolean quoted)
protected org.apache.lucene.search.Query	getFieldQuery(java.lang.String field, java.lang.String queryText, int slop)
protected org.apache.lucene.search.Query	getFuzzyQuery(java.lang.String field, java.lang.String termStr, java.lang.String minSimilarity)
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 startInclusive, boolean endInclusive)
protected org.apache.lucene.search.Query	getRegexpQuery(java.lang.String field, java.lang.String termStr)
protected org.apache.lucene.search.Query	getWildcardQuery(java.lang.String field, java.lang.String termStr)
protected org.apache.lucene.search.Query	newFuzzyQuery(org.apache.lucene.index.Term term, float minimumSimilarity, int prefixLength)
protected org.apache.lucene.search.Query	newMatchAllDocsQuery()
protected org.apache.lucene.search.Query	newTermQuery(org.apache.lucene.index.Term term)
org.apache.lucene.search.Query	parse(java.lang.String query)
void	reset(QueryParserSettings settings)
static boolean	shouldApplyGraphPhraseLimit() Checks the value of the JVM option es.query.write.apply_graph_phrase_limit to determine if the analysis of graph phrase should be limited to BooleanQuery.getMaxClauseCount().

Methods inherited from class org.apache.lucene.queryparser.analyzing.AnalyzingQueryParser

getFuzzyQuery

Methods inherited from class org.apache.lucene.queryparser.classic.QueryParser

Clause, Conjunction, disable_tracing, enable_tracing, generateParseException, getNextToken, getSplitOnWhitespace, getToken, Modifiers, MultiTerm, Query, ReInit, ReInit, setAutoGeneratePhraseQueries, setSplitOnWhitespace, Term, TopLevelQuery

Methods inherited from class org.apache.lucene.queryparser.classic.QueryParserBase

addClause, addMultiTermClauses, escape, getAllowLeadingWildcard, getAnalyzeRangeTerms, getAutoGeneratePhraseQueries, getDateResolution, getDefaultOperator, getField, getFuzzyMinSim, getFuzzyPrefixLength, getLocale, getLowercaseExpandedTerms, getMaxDeterminizedStates, getMultiTermRewriteMethod, getPhraseSlop, getTimeZone, init, newBooleanClause, newFieldQuery, newPrefixQuery, newRangeQuery, newRegexpQuery, newWildcardQuery, setAllowLeadingWildcard, setAnalyzeRangeTerms, setDateResolution, setDateResolution, setDefaultOperator, setFuzzyMinSim, setFuzzyPrefixLength, setLocale, setLowercaseExpandedTerms, setMaxDeterminizedStates, setMultiTermRewriteMethod, setPhraseSlop, setTimeZone

Methods inherited from class org.apache.lucene.util.QueryBuilder

add, analyzeBoolean, analyzeGraphBoolean, analyzeMultiBoolean, analyzeMultiPhrase, analyzePhrase, analyzeTerm, createBooleanQuery, createBooleanQuery, createFieldQuery, createMinShouldMatchQuery, createPhraseQuery, createPhraseQuery, createSpanQuery, getAnalyzer, getAutoGenerateMultiTermSynonymsPhraseQuery, getEnableGraphQueries, getEnablePositionIncrements, newBooleanQuery, newGraphSynonymQuery, newMultiPhraseQueryBuilder, newSynonymQuery, setAnalyzer, setAutoGenerateMultiTermSynonymsPhraseQuery, setEnableGraphQueries, setEnablePositionIncrements

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.queryparser.flexible.standard.CommonQueryParserConfiguration

getAnalyzer, getEnablePositionIncrements, setEnablePositionIncrements

Field Detail

FIELD_QUERY_EXTENSIONS

public static final java.util.Map<java.lang.String,FieldQueryExtension> FIELD_QUERY_EXTENSIONS

Constructor Detail

MapperQueryParser

public MapperQueryParser(QueryShardContext context)

Method Detail

reset

public void reset(QueryParserSettings settings)

newTermQuery

protected org.apache.lucene.search.Query newTermQuery(org.apache.lucene.index.Term term)

Overrides:

newTermQuery in class org.apache.lucene.util.QueryBuilder

newMatchAllDocsQuery

protected org.apache.lucene.search.Query newMatchAllDocsQuery()

Overrides:

newMatchAllDocsQuery in class org.apache.lucene.queryparser.classic.QueryParserBase

getFieldQuery

public org.apache.lucene.search.Query getFieldQuery(java.lang.String field,
                                                    java.lang.String queryText,
                                                    boolean quoted)
                                             throws org.apache.lucene.queryparser.classic.ParseException

Overrides:

getFieldQuery in class org.apache.lucene.queryparser.classic.QueryParserBase

Throws:

org.apache.lucene.queryparser.classic.ParseException

getFieldQuery

protected org.apache.lucene.search.Query getFieldQuery(java.lang.String field,
                                                       java.lang.String queryText,
                                                       int slop)
                                                throws org.apache.lucene.queryparser.classic.ParseException

Overrides:

getFieldQuery in class org.apache.lucene.queryparser.classic.QueryParserBase

Throws:

org.apache.lucene.queryparser.classic.ParseException

getRangeQuery

protected org.apache.lucene.search.Query getRangeQuery(java.lang.String field,
                                                       java.lang.String part1,
                                                       java.lang.String part2,
                                                       boolean startInclusive,
                                                       boolean endInclusive)
                                                throws org.apache.lucene.queryparser.classic.ParseException

Overrides:

getRangeQuery in class org.apache.lucene.queryparser.classic.QueryParserBase

Throws:

org.apache.lucene.queryparser.classic.ParseException

getFuzzyQuery

protected org.apache.lucene.search.Query getFuzzyQuery(java.lang.String field,
                                                       java.lang.String termStr,
                                                       java.lang.String minSimilarity)
                                                throws org.apache.lucene.queryparser.classic.ParseException

Throws:

org.apache.lucene.queryparser.classic.ParseException

newFuzzyQuery

protected org.apache.lucene.search.Query newFuzzyQuery(org.apache.lucene.index.Term term,
                                                       float minimumSimilarity,
                                                       int prefixLength)

Overrides:

newFuzzyQuery in class org.apache.lucene.queryparser.classic.QueryParserBase

getPrefixQuery

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

Overrides:

getPrefixQuery in class org.apache.lucene.queryparser.analyzing.AnalyzingQueryParser

Throws:

org.apache.lucene.queryparser.classic.ParseException

getWildcardQuery

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

Overrides:

getWildcardQuery in class org.apache.lucene.queryparser.analyzing.AnalyzingQueryParser

Throws:

org.apache.lucene.queryparser.classic.ParseException

getRegexpQuery

protected org.apache.lucene.search.Query getRegexpQuery(java.lang.String field,
                                                        java.lang.String termStr)
                                                 throws org.apache.lucene.queryparser.classic.ParseException

Overrides:

getRegexpQuery in class org.apache.lucene.queryparser.classic.QueryParserBase

Throws:

org.apache.lucene.queryparser.classic.ParseException

getBooleanQueryCoordDisabled

@Deprecated
protected org.apache.lucene.search.Query getBooleanQueryCoordDisabled(java.util.List<org.apache.lucene.search.BooleanClause> clauses)
                                                                           throws org.apache.lucene.queryparser.classic.ParseException

Deprecated. review all use of this, don't rely on coord

Throws:

org.apache.lucene.queryparser.classic.ParseException

getBooleanQuery

protected org.apache.lucene.search.Query getBooleanQuery(java.util.List<org.apache.lucene.search.BooleanClause> clauses)
                                                  throws org.apache.lucene.queryparser.classic.ParseException

Overrides:

getBooleanQuery in class org.apache.lucene.queryparser.classic.QueryParserBase

Throws:

org.apache.lucene.queryparser.classic.ParseException

parse

public org.apache.lucene.search.Query parse(java.lang.String query)
                                     throws org.apache.lucene.queryparser.classic.ParseException

Overrides:

parse in class org.apache.lucene.queryparser.classic.QueryParserBase

Throws:

org.apache.lucene.queryparser.classic.ParseException

createFieldQuery

protected org.apache.lucene.search.Query createFieldQuery(org.apache.lucene.analysis.Analyzer analyzer,
                                                          org.apache.lucene.search.BooleanClause.Occur operator,
                                                          java.lang.String field,
                                                          java.lang.String queryText,
                                                          boolean quoted,
                                                          int phraseSlop)

Checks if graph analysis should be enabled for the field depending on the provided Analyzer

Overrides:

createFieldQuery in class org.apache.lucene.util.QueryBuilder

analyzeGraphPhrase

protected org.apache.lucene.search.spans.SpanQuery analyzeGraphPhrase(org.apache.lucene.analysis.TokenStream source,
                                                                      java.lang.String field,
                                                                      int phraseSlop)
                                                               throws java.io.IOException

See analyzeGraphPhraseWithLimit(org.apache.lucene.analysis.TokenStream, java.lang.String, int, org.apache.lucene.queryparser.classic.MapperQueryParser.CheckedBiFunction<org.apache.lucene.analysis.TokenStream, java.lang.String, org.apache.lucene.search.spans.SpanQuery>, boolean)

Overrides:

analyzeGraphPhrase in class org.apache.lucene.util.QueryBuilder

Throws:

java.io.IOException

shouldApplyGraphPhraseLimit

public static boolean shouldApplyGraphPhraseLimit()

Checks the value of the JVM option es.query.write.apply_graph_phrase_limit to determine if the analysis of graph phrase should be limited to BooleanQuery.getMaxClauseCount(). The JVM option can only be set to true (false is the default value), any other value will throw an IllegalArgumentException.

analyzeGraphPhraseWithLimit

public static org.apache.lucene.search.spans.SpanQuery analyzeGraphPhraseWithLimit(org.apache.lucene.analysis.TokenStream source,
                                                                                   java.lang.String field,
                                                                                   int phraseSlop,
                                                                                   MapperQueryParser.CheckedBiFunction<org.apache.lucene.analysis.TokenStream,java.lang.String,org.apache.lucene.search.spans.SpanQuery> spanQueryFunc,
                                                                                   boolean isHardLimit)
                                                                            throws java.io.IOException

Overrides QueryBuilder.analyzeGraphPhrase(TokenStream, String, int) to add a limit (see BooleanQuery.getMaxClauseCount()) to the number of SpanQuery that this method can create.

Throws:

java.io.IOException