public class QueryStringQueryBuilder extends QueryBuilder implements BoostableQueryBuilder<QueryStringQueryBuilder>
field(String)
, will run the query once and non prefixed fields
will use the defaultField(String)
set. The second, when one or more fields are added
(using field(String)
), will run the parsed query against the provided fields, and combine
them either using DisMax or a plain boolean query (see useDisMax(boolean)
).Modifier and Type | Class and Description |
---|---|
static class |
QueryStringQueryBuilder.Operator |
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
EMPTY_PARAMS
Constructor and Description |
---|
QueryStringQueryBuilder(String queryString) |
Modifier and Type | Method and Description |
---|---|
QueryStringQueryBuilder |
allowLeadingWildcard(boolean allowLeadingWildcard)
Should leading wildcards be allowed or not.
|
QueryStringQueryBuilder |
analyzer(String analyzer)
The optional analyzer used to analyze the query string.
|
QueryStringQueryBuilder |
analyzeWildcard(boolean analyzeWildcard)
Set to true to enable analysis on wildcard and prefix queries.
|
QueryStringQueryBuilder |
autoGeneratePhraseQueries(boolean autoGeneratePhraseQueries)
Set to true if phrase queries will be automatically generated
when the analyzer returns more than one term from whitespace
delimited text.
|
QueryStringQueryBuilder |
boost(float boost)
Sets the boost for this query.
|
QueryStringQueryBuilder |
defaultField(String defaultField)
The default field to run against when no prefix field is specified.
|
QueryStringQueryBuilder |
defaultOperator(QueryStringQueryBuilder.Operator defaultOperator)
Sets the boolean operator of the query parser used to parse the query string.
|
protected void |
doXContent(XContentBuilder builder,
ToXContent.Params params) |
QueryStringQueryBuilder |
enablePositionIncrements(boolean enablePositionIncrements)
Set to true to enable position increments in result query.
|
QueryStringQueryBuilder |
escape(boolean escape)
Set to true to enable escaping of the query string
|
QueryStringQueryBuilder |
field(String field)
Adds a field to run the query string against.
|
QueryStringQueryBuilder |
field(String field,
float boost)
Adds a field to run the query string against with a specific boost.
|
QueryStringQueryBuilder |
fuzziness(Fuzziness fuzziness)
Set the edit distance for fuzzy queries.
|
QueryStringQueryBuilder |
fuzzyMaxExpansions(int fuzzyMaxExpansions) |
QueryStringQueryBuilder |
fuzzyPrefixLength(int fuzzyPrefixLength)
Set the minimum prefix length for fuzzy queries.
|
QueryStringQueryBuilder |
fuzzyRewrite(String fuzzyRewrite) |
QueryStringQueryBuilder |
lenient(Boolean lenient)
Sets the query string parser to be lenient when parsing field values, defaults to the index
setting and if not set, defaults to false.
|
QueryStringQueryBuilder |
locale(Locale locale) |
QueryStringQueryBuilder |
lowercaseExpandedTerms(boolean lowercaseExpandedTerms)
Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically
lower-cased or not.
|
QueryStringQueryBuilder |
maxDeterminizedStates(int maxDeterminizedStates)
Protects against too-difficult regular expression queries.
|
QueryStringQueryBuilder |
minimumShouldMatch(String minimumShouldMatch) |
QueryStringQueryBuilder |
phraseSlop(int phraseSlop)
Sets the default slop for phrases.
|
QueryStringQueryBuilder |
queryName(String queryName)
Sets the query name for the filter that can be used when searching for matched_filters per hit.
|
QueryStringQueryBuilder |
quoteAnalyzer(String analyzer)
The optional analyzer used to analyze the query string for phrase searches.
|
QueryStringQueryBuilder |
quoteFieldSuffix(String quoteFieldSuffix)
An optional field name suffix to automatically try and add to the field searched when using quoted text.
|
QueryStringQueryBuilder |
rewrite(String rewrite) |
QueryStringQueryBuilder |
tieBreaker(float tieBreaker)
When more than one field is used with the query string, and combined queries are using
dis max, control the tie breaker for it.
|
QueryStringQueryBuilder |
timeZone(String timeZone)
In case of date field, we can adjust the from/to fields using a timezone
|
QueryStringQueryBuilder |
useDisMax(boolean useDisMax)
When more than one field is used with the query string, should queries be combined using
dis max, or boolean query.
|
toXContent
buildAsBytes, buildAsBytes, toString
public QueryStringQueryBuilder(String queryString)
public QueryStringQueryBuilder defaultField(String defaultField)
public QueryStringQueryBuilder field(String field)
public QueryStringQueryBuilder field(String field, float boost)
public QueryStringQueryBuilder useDisMax(boolean useDisMax)
public QueryStringQueryBuilder tieBreaker(float tieBreaker)
public QueryStringQueryBuilder defaultOperator(QueryStringQueryBuilder.Operator defaultOperator)
In default mode (QueryStringQueryBuilder.Operator.OR
) terms without any modifiers
are considered optional: for example capital of Hungary
is equal to
capital OR of OR Hungary
.
In QueryStringQueryBuilder.Operator.AND
mode terms are considered to be in conjunction: the
above mentioned query is parsed as capital AND of AND Hungary
public QueryStringQueryBuilder analyzer(String analyzer)
public QueryStringQueryBuilder quoteAnalyzer(String analyzer)
public QueryStringQueryBuilder autoGeneratePhraseQueries(boolean autoGeneratePhraseQueries)
Set to false if phrase queries should only be generated when surrounded by double quotes.
public QueryStringQueryBuilder maxDeterminizedStates(int maxDeterminizedStates)
public QueryStringQueryBuilder allowLeadingWildcard(boolean allowLeadingWildcard)
public QueryStringQueryBuilder lowercaseExpandedTerms(boolean lowercaseExpandedTerms)
public QueryStringQueryBuilder enablePositionIncrements(boolean enablePositionIncrements)
When set, result phrase and multi-phrase queries will be aware of position increments. Useful when e.g. a StopFilter increases the position increment of the token that follows an omitted token.
public QueryStringQueryBuilder fuzziness(Fuzziness fuzziness)
public QueryStringQueryBuilder fuzzyPrefixLength(int fuzzyPrefixLength)
public QueryStringQueryBuilder fuzzyMaxExpansions(int fuzzyMaxExpansions)
public QueryStringQueryBuilder fuzzyRewrite(String fuzzyRewrite)
public QueryStringQueryBuilder phraseSlop(int phraseSlop)
public QueryStringQueryBuilder analyzeWildcard(boolean analyzeWildcard)
public QueryStringQueryBuilder rewrite(String rewrite)
public QueryStringQueryBuilder minimumShouldMatch(String minimumShouldMatch)
public QueryStringQueryBuilder boost(float boost)
boost
in interface BoostableQueryBuilder<QueryStringQueryBuilder>
public QueryStringQueryBuilder quoteFieldSuffix(String quoteFieldSuffix)
public QueryStringQueryBuilder lenient(Boolean lenient)
public QueryStringQueryBuilder queryName(String queryName)
public QueryStringQueryBuilder locale(Locale locale)
public QueryStringQueryBuilder timeZone(String timeZone)
public QueryStringQueryBuilder escape(boolean escape)
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
doXContent
in class QueryBuilder
IOException
Copyright © 2009–2016. All rights reserved.