public class QueryStringQueryParser extends XQueryParser
XQueryParser
that uses the MapperService
in order to build smarter
queries based on the mapping information.
This class uses MultiMatchQuery
to build the text query around operators and XQueryParser
to assemble the result logically.DEFAULT_SPLIT_ON_WHITESPACE, jj_nt, token, token_source
AND_OPERATOR, field, OR_OPERATOR
analyzer, autoGenerateMultiTermSynonymsPhraseQuery, enableGraphQueries, enablePositionIncrements
_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 and Description |
---|
QueryStringQueryParser(QueryShardContext context,
boolean lenient)
Defaults to all queryiable fields extracted from the mapping for query terms
|
QueryStringQueryParser(QueryShardContext context,
java.util.Map<java.lang.String,java.lang.Float> fieldsAndWeights) |
QueryStringQueryParser(QueryShardContext context,
java.util.Map<java.lang.String,java.lang.Float> fieldsAndWeights,
boolean lenient) |
QueryStringQueryParser(QueryShardContext context,
java.lang.String defaultField) |
QueryStringQueryParser(QueryShardContext context,
java.lang.String defaultField,
boolean lenient) |
Modifier and Type | Method and Description |
---|---|
protected org.apache.lucene.search.Query |
getBooleanQuery(java.util.List<org.apache.lucene.search.BooleanClause> clauses) |
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,
float 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 |
handleBareFuzzy(java.lang.String field,
org.apache.lucene.queryparser.classic.Token fuzzySlop,
java.lang.String termImage) |
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 |
setAnalyzeWildcard(boolean analyzeWildcard) |
void |
setAutoGenerateMultiTermSynonymsPhraseQuery(boolean enable) |
void |
setDefaultOperator(org.apache.lucene.queryparser.classic.QueryParser.Operator op) |
void |
setForceAnalyzer(org.apache.lucene.analysis.Analyzer analyzer) |
void |
setForceQuoteAnalyzer(org.apache.lucene.analysis.Analyzer analyzer) |
void |
setFuzziness(Fuzziness fuzziness) |
void |
setFuzzyMaxExpansions(int fuzzyMaxExpansions) |
void |
setFuzzyRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod fuzzyRewriteMethod) |
void |
setFuzzyTranspositions(boolean fuzzyTranspositions) |
void |
setGroupTieBreaker(float groupTieBreaker) |
void |
setQuoteFieldSuffix(java.lang.String quoteFieldSuffix) |
void |
setTimeZone(org.joda.time.DateTimeZone timeZone) |
void |
setType(MultiMatchQueryBuilder.Type type) |
Clause, Conjunction, disable_tracing, enable_tracing, generateParseException, getNextToken, getSplitOnWhitespace, getToken, Modifiers, MultiTerm, Query, ReInit, ReInit, setAutoGeneratePhraseQueries, setSplitOnWhitespace, Term, TopLevelQuery
addClause, addMultiTermClauses, escape, getAllowLeadingWildcard, getAutoGeneratePhraseQueries, getDateResolution, getDefaultOperator, getField, getFuzzyMinSim, getFuzzyPrefixLength, getLocale, getMaxDeterminizedStates, getMultiTermRewriteMethod, getPhraseSlop, getTimeZone, init, newBooleanClause, newFieldQuery, newPrefixQuery, newRangeQuery, newRegexpQuery, newWildcardQuery, setAllowLeadingWildcard, setDateResolution, setDateResolution, setFuzzyMinSim, setFuzzyPrefixLength, setLocale, setMaxDeterminizedStates, setMultiTermRewriteMethod, setPhraseSlop, setTimeZone
add, analyzeBoolean, analyzeGraphBoolean, analyzeGraphPhrase, analyzeMultiBoolean, analyzeMultiPhrase, analyzePhrase, analyzeTerm, createBooleanQuery, createBooleanQuery, createFieldQuery, createFieldQuery, createMinShouldMatchQuery, createPhraseQuery, createPhraseQuery, createSpanQuery, getAnalyzer, getAutoGenerateMultiTermSynonymsPhraseQuery, getEnableGraphQueries, getEnablePositionIncrements, newBooleanQuery, newGraphSynonymQuery, newMultiPhraseQueryBuilder, newSynonymQuery, setAnalyzer, setEnableGraphQueries, setEnablePositionIncrements
public QueryStringQueryParser(QueryShardContext context, java.lang.String defaultField)
context
- The query shard context.defaultField
- The default field for query terms.public QueryStringQueryParser(QueryShardContext context, java.lang.String defaultField, boolean lenient)
context
- The query shard context.defaultField
- The default field for query terms.lenient
- If set to `true` will cause format based failures (like providing text to a numeric field) to be ignored.public QueryStringQueryParser(QueryShardContext context, java.util.Map<java.lang.String,java.lang.Float> fieldsAndWeights)
context
- The query shard contextfieldsAndWeights
- The default fields and weights expansion for query termspublic QueryStringQueryParser(QueryShardContext context, java.util.Map<java.lang.String,java.lang.Float> fieldsAndWeights, boolean lenient)
context
- The query shard context.fieldsAndWeights
- The default fields and weights expansion for query terms.lenient
- If set to `true` will cause format based failures (like providing text to a numeric field) to be ignored.public QueryStringQueryParser(QueryShardContext context, boolean lenient)
context
- The query shard contextlenient
- If set to `true` will cause format based failures (like providing text to a numeric field) to be ignored.public void setDefaultOperator(org.apache.lucene.queryparser.classic.QueryParser.Operator op)
setDefaultOperator
in class org.apache.lucene.queryparser.classic.QueryParserBase
public void setType(MultiMatchQueryBuilder.Type type)
type
- Sets how multiple fields should be combined to build textual part queries.public void setFuzziness(Fuzziness fuzziness)
fuzziness
- Sets the default Fuzziness
for fuzzy query.
Defaults to Fuzziness.AUTO
.public void setFuzzyRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod fuzzyRewriteMethod)
fuzzyRewriteMethod
- Sets the default rewrite method for fuzzy query.public void setFuzzyMaxExpansions(int fuzzyMaxExpansions)
fuzzyMaxExpansions
- Sets the maximum number of expansions allowed in a fuzzy query.
Defaults to FuzzyQuery.defaultMaxExpansions
.public void setForceAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
analyzer
- Force the provided analyzer to be used for all query analysis regardless of the field.public void setForceQuoteAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
analyzer
- Force the provided analyzer to be used for all phrase query analysis regardless of the field.public void setQuoteFieldSuffix(java.lang.String quoteFieldSuffix)
quoteFieldSuffix
- The suffix to append to fields for quoted parts of the query string.public void setAnalyzeWildcard(boolean analyzeWildcard)
analyzeWildcard
- If true, the wildcard operator analyzes the term to build a wildcard query.
Otherwise the query terms are only normalized.public void setTimeZone(org.joda.time.DateTimeZone timeZone)
timeZone
- Time Zone to be applied to any range query related to dates.public void setGroupTieBreaker(float groupTieBreaker)
groupTieBreaker
- The tie breaker to apply when multiple fields are used.public void setAutoGenerateMultiTermSynonymsPhraseQuery(boolean enable)
setAutoGenerateMultiTermSynonymsPhraseQuery
in class org.apache.lucene.util.QueryBuilder
public void setFuzzyTranspositions(boolean fuzzyTranspositions)
fuzzyTranspositions
- Sets whether transpositions are supported in fuzzy queries.
Defaults to FuzzyQuery.defaultTranspositions
.protected org.apache.lucene.search.Query newTermQuery(org.apache.lucene.index.Term term)
newTermQuery
in class org.apache.lucene.util.QueryBuilder
protected org.apache.lucene.search.Query newMatchAllDocsQuery()
newMatchAllDocsQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
public org.apache.lucene.search.Query getFieldQuery(java.lang.String field, java.lang.String queryText, boolean quoted) throws org.apache.lucene.queryparser.classic.ParseException
getFieldQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
protected org.apache.lucene.search.Query getFieldQuery(java.lang.String field, java.lang.String queryText, int slop) throws org.apache.lucene.queryparser.classic.ParseException
getFieldQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
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
getRangeQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
protected org.apache.lucene.search.Query handleBareFuzzy(java.lang.String field, org.apache.lucene.queryparser.classic.Token fuzzySlop, java.lang.String termImage) throws org.apache.lucene.queryparser.classic.ParseException
handleBareFuzzy
in class XQueryParser
org.apache.lucene.queryparser.classic.ParseException
protected org.apache.lucene.search.Query getFuzzyQuery(java.lang.String field, java.lang.String termStr, float minSimilarity) throws org.apache.lucene.queryparser.classic.ParseException
getFuzzyQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
protected org.apache.lucene.search.Query newFuzzyQuery(org.apache.lucene.index.Term term, float minimumSimilarity, int prefixLength)
newFuzzyQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
protected org.apache.lucene.search.Query getPrefixQuery(java.lang.String field, java.lang.String termStr) throws org.apache.lucene.queryparser.classic.ParseException
getPrefixQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
protected org.apache.lucene.search.Query getWildcardQuery(java.lang.String field, java.lang.String termStr) throws org.apache.lucene.queryparser.classic.ParseException
getWildcardQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
protected org.apache.lucene.search.Query getRegexpQuery(java.lang.String field, java.lang.String termStr) throws org.apache.lucene.queryparser.classic.ParseException
getRegexpQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
protected org.apache.lucene.search.Query getBooleanQuery(java.util.List<org.apache.lucene.search.BooleanClause> clauses) throws org.apache.lucene.queryparser.classic.ParseException
getBooleanQuery
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException
public org.apache.lucene.search.Query parse(java.lang.String query) throws org.apache.lucene.queryparser.classic.ParseException
parse
in class org.apache.lucene.queryparser.classic.QueryParserBase
org.apache.lucene.queryparser.classic.ParseException