NamedWriteable
, Writeable
, ToXContent
, ToXContentObject
, QueryBuilder
, Rewriteable<QueryBuilder>
public class QueryStringQueryBuilder extends AbstractQueryBuilder<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 using Dismax.ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Writeable.Reader<V>, Writeable.Writer<V>
Modifier and Type | Field | Description |
---|---|---|
static boolean |
DEFAULT_ENABLE_POSITION_INCREMENTS |
|
static boolean |
DEFAULT_ESCAPE |
|
static Fuzziness |
DEFAULT_FUZZINESS |
|
static int |
DEFAULT_FUZZY_MAX_EXPANSIONS |
|
static int |
DEFAULT_FUZZY_PREFIX_LENGTH |
|
static boolean |
DEFAULT_FUZZY_TRANSPOSITIONS |
|
static int |
DEFAULT_MAX_DETERMINED_STATES |
|
static Operator |
DEFAULT_OPERATOR |
|
static int |
DEFAULT_PHRASE_SLOP |
|
static MultiMatchQueryBuilder.Type |
DEFAULT_TYPE |
|
static java.lang.String |
NAME |
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
MAX_REWRITE_ROUNDS
EMPTY_PARAMS
Constructor | Description |
---|---|
QueryStringQueryBuilder(java.lang.String queryString) |
|
QueryStringQueryBuilder(StreamInput in) |
Read from a stream.
|
Modifier and Type | Method | Description |
---|---|---|
java.lang.Boolean |
allowLeadingWildcard() |
|
QueryStringQueryBuilder |
allowLeadingWildcard(java.lang.Boolean allowLeadingWildcard) |
Should leading wildcards be allowed or not.
|
java.lang.String |
analyzer() |
The optional analyzer used to analyze the query string.
|
QueryStringQueryBuilder |
analyzer(java.lang.String analyzer) |
The optional analyzer used to analyze the query string.
|
java.lang.Boolean |
analyzeWildcard() |
|
QueryStringQueryBuilder |
analyzeWildcard(java.lang.Boolean analyzeWildcard) |
Set to true to enable analysis on wildcard and prefix queries.
|
boolean |
autoGeneratePhraseQueries() |
Deprecated.
|
QueryStringQueryBuilder |
autoGeneratePhraseQueries(boolean autoGeneratePhraseQueries) |
Deprecated.
|
boolean |
autoGenerateSynonymsPhraseQuery() |
Whether phrase queries should be automatically generated for multi terms synonyms.
|
QueryStringQueryBuilder |
autoGenerateSynonymsPhraseQuery(boolean value) |
|
java.lang.String |
defaultField() |
|
QueryStringQueryBuilder |
defaultField(java.lang.String defaultField) |
The default field to run against when no prefix field is specified.
|
Operator |
defaultOperator() |
|
QueryStringQueryBuilder |
defaultOperator(Operator defaultOperator) |
Sets the boolean operator of the query parser used to parse the query string.
|
protected boolean |
doEquals(QueryStringQueryBuilder other) |
Indicates whether some other
QueryBuilder object of the same type is "equal to" this one. |
protected int |
doHashCode() |
|
protected org.apache.lucene.search.Query |
doToQuery(QueryShardContext context) |
|
protected void |
doWriteTo(StreamOutput out) |
|
protected void |
doXContent(XContentBuilder builder,
ToXContent.Params params) |
|
boolean |
enablePositionIncrements() |
|
QueryStringQueryBuilder |
enablePositionIncrements(boolean enablePositionIncrements) |
Set to true to enable position increments in result query.
|
boolean |
escape() |
|
QueryStringQueryBuilder |
escape(boolean escape) |
Set to true to enable escaping of the query string
|
QueryStringQueryBuilder |
field(java.lang.String field) |
Adds a field to run the query string against.
|
QueryStringQueryBuilder |
field(java.lang.String field,
float boost) |
Adds a field to run the query string against with a specific boost.
|
java.util.Map<java.lang.String,java.lang.Float> |
fields() |
Returns the fields including their respective boosts to run the query against.
|
QueryStringQueryBuilder |
fields(java.util.Map<java.lang.String,java.lang.Float> fields) |
Add several fields to run the query against with a specific boost.
|
static QueryStringQueryBuilder |
fromXContent(XContentParser parser) |
|
Fuzziness |
fuzziness() |
|
QueryStringQueryBuilder |
fuzziness(Fuzziness fuzziness) |
Set the edit distance for fuzzy queries.
|
int |
fuzzyMaxExpansions() |
|
QueryStringQueryBuilder |
fuzzyMaxExpansions(int fuzzyMaxExpansions) |
|
int |
fuzzyPrefixLength() |
|
QueryStringQueryBuilder |
fuzzyPrefixLength(int fuzzyPrefixLength) |
Set the minimum prefix length for fuzzy queries.
|
java.lang.String |
fuzzyRewrite() |
|
QueryStringQueryBuilder |
fuzzyRewrite(java.lang.String fuzzyRewrite) |
|
boolean |
fuzzyTranspositions() |
|
QueryStringQueryBuilder |
fuzzyTranspositions(boolean fuzzyTranspositions) |
Sets whether transpositions are supported in fuzzy queries.
|
java.lang.String |
getWriteableName() |
Returns the name of the writeable object
|
java.lang.Boolean |
lenient() |
|
QueryStringQueryBuilder |
lenient(java.lang.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.
|
int |
maxDeterminizedStates() |
|
QueryStringQueryBuilder |
maxDeterminizedStates(int maxDeterminizedStates) |
Protects against too-difficult regular expression queries.
|
java.lang.String |
minimumShouldMatch() |
|
QueryStringQueryBuilder |
minimumShouldMatch(java.lang.String minimumShouldMatch) |
|
int |
phraseSlop() |
|
QueryStringQueryBuilder |
phraseSlop(int phraseSlop) |
Sets the default slop for phrases.
|
java.lang.String |
queryString() |
|
java.lang.String |
quoteAnalyzer() |
The optional analyzer used to analyze the query string for phrase searches.
|
QueryStringQueryBuilder |
quoteAnalyzer(java.lang.String quoteAnalyzer) |
The optional analyzer used to analyze the query string for phrase searches.
|
java.lang.String |
quoteFieldSuffix() |
|
QueryStringQueryBuilder |
quoteFieldSuffix(java.lang.String quoteFieldSuffix) |
An optional field name suffix to automatically try and add to the field searched when using quoted text.
|
java.lang.String |
rewrite() |
|
QueryStringQueryBuilder |
rewrite(java.lang.String rewrite) |
|
boolean |
splitOnWhitespace() |
Deprecated.
|
QueryStringQueryBuilder |
splitOnWhitespace(boolean value) |
Deprecated.
|
java.lang.Float |
tieBreaker() |
|
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.
|
org.joda.time.DateTimeZone |
timeZone() |
|
QueryStringQueryBuilder |
timeZone(java.lang.String timeZone) |
In case of date field, we can adjust the from/to fields using a timezone
|
QueryStringQueryBuilder |
timeZone(org.joda.time.DateTimeZone timeZone) |
|
void |
type(MultiMatchQueryBuilder.Type type) |
|
java.lang.Boolean |
useAllFields() |
Deprecated.
|
QueryStringQueryBuilder |
useAllFields(java.lang.Boolean useAllFields) |
Deprecated.
|
boolean |
useDisMax() |
Deprecated.
|
QueryStringQueryBuilder |
useDisMax(boolean useDisMax) |
Deprecated.
|
addValidationError, boost, boost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQuery, toString, toXContent, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
public static final java.lang.String NAME
public static final int DEFAULT_MAX_DETERMINED_STATES
public static final boolean DEFAULT_ENABLE_POSITION_INCREMENTS
public static final boolean DEFAULT_ESCAPE
public static final int DEFAULT_FUZZY_PREFIX_LENGTH
public static final int DEFAULT_FUZZY_MAX_EXPANSIONS
public static final int DEFAULT_PHRASE_SLOP
public static final Fuzziness DEFAULT_FUZZINESS
public static final Operator DEFAULT_OPERATOR
public static final MultiMatchQueryBuilder.Type DEFAULT_TYPE
public static final boolean DEFAULT_FUZZY_TRANSPOSITIONS
public QueryStringQueryBuilder(java.lang.String queryString)
public QueryStringQueryBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
protected void doWriteTo(StreamOutput out) throws java.io.IOException
doWriteTo
in class AbstractQueryBuilder<QueryStringQueryBuilder>
java.io.IOException
public java.lang.String queryString()
public QueryStringQueryBuilder defaultField(java.lang.String defaultField)
public java.lang.String defaultField()
@Deprecated public QueryStringQueryBuilder useAllFields(java.lang.Boolean useAllFields)
defaultField(String)
to "*" instead.@Deprecated public java.lang.Boolean useAllFields()
public QueryStringQueryBuilder field(java.lang.String field)
AbstractQueryBuilder.DEFAULT_BOOST
.
Use field(String, float)
to set a specific boost for the field.public QueryStringQueryBuilder field(java.lang.String field, float boost)
public QueryStringQueryBuilder fields(java.util.Map<java.lang.String,java.lang.Float> fields)
public java.util.Map<java.lang.String,java.lang.Float> fields()
public void type(MultiMatchQueryBuilder.Type type)
type
- Sets how multiple fields should be combined to build textual part queries.@Deprecated public QueryStringQueryBuilder useDisMax(boolean useDisMax)
tieBreaker
instead.@Deprecated public boolean useDisMax()
tieBreaker
instead.public QueryStringQueryBuilder tieBreaker(float tieBreaker)
public java.lang.Float tieBreaker()
public QueryStringQueryBuilder defaultOperator(Operator defaultOperator)
In default mode (Operator.OR
) terms without any modifiers
are considered optional: for example capital of Hungary
is equal to
capital OR of OR Hungary
.
In Operator.AND
mode terms are considered to be in conjunction: the
above mentioned query is parsed as capital AND of AND Hungary
public Operator defaultOperator()
public QueryStringQueryBuilder analyzer(java.lang.String analyzer)
public java.lang.String analyzer()
public java.lang.String quoteAnalyzer()
public QueryStringQueryBuilder quoteAnalyzer(java.lang.String quoteAnalyzer)
@Deprecated public QueryStringQueryBuilder autoGeneratePhraseQueries(boolean autoGeneratePhraseQueries)
@Deprecated public boolean autoGeneratePhraseQueries()
public QueryStringQueryBuilder maxDeterminizedStates(int maxDeterminizedStates)
public int maxDeterminizedStates()
public QueryStringQueryBuilder allowLeadingWildcard(java.lang.Boolean allowLeadingWildcard)
public java.lang.Boolean allowLeadingWildcard()
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 boolean enablePositionIncrements()
public QueryStringQueryBuilder fuzziness(Fuzziness fuzziness)
public Fuzziness fuzziness()
public QueryStringQueryBuilder fuzzyPrefixLength(int fuzzyPrefixLength)
public int fuzzyPrefixLength()
public QueryStringQueryBuilder fuzzyMaxExpansions(int fuzzyMaxExpansions)
public int fuzzyMaxExpansions()
public QueryStringQueryBuilder fuzzyRewrite(java.lang.String fuzzyRewrite)
public java.lang.String fuzzyRewrite()
public QueryStringQueryBuilder phraseSlop(int phraseSlop)
public int phraseSlop()
public QueryStringQueryBuilder rewrite(java.lang.String rewrite)
public QueryStringQueryBuilder analyzeWildcard(java.lang.Boolean analyzeWildcard)
public java.lang.Boolean analyzeWildcard()
public java.lang.String rewrite()
public QueryStringQueryBuilder minimumShouldMatch(java.lang.String minimumShouldMatch)
public java.lang.String minimumShouldMatch()
public QueryStringQueryBuilder quoteFieldSuffix(java.lang.String quoteFieldSuffix)
public java.lang.String quoteFieldSuffix()
public QueryStringQueryBuilder lenient(java.lang.Boolean lenient)
public java.lang.Boolean lenient()
public QueryStringQueryBuilder timeZone(java.lang.String timeZone)
public QueryStringQueryBuilder timeZone(org.joda.time.DateTimeZone timeZone)
public org.joda.time.DateTimeZone timeZone()
public QueryStringQueryBuilder escape(boolean escape)
public boolean escape()
@Deprecated public QueryStringQueryBuilder splitOnWhitespace(boolean value)
@Deprecated public boolean splitOnWhitespace()
public QueryStringQueryBuilder autoGenerateSynonymsPhraseQuery(boolean value)
public boolean autoGenerateSynonymsPhraseQuery()
public boolean fuzzyTranspositions()
public QueryStringQueryBuilder fuzzyTranspositions(boolean fuzzyTranspositions)
The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein
distance formula which supports transpositions. Setting transposition to false will
switch to classic Levenshtein distance.
If not set, Damerau-Levenshtein distance metric will be used.
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
doXContent
in class AbstractQueryBuilder<QueryStringQueryBuilder>
java.io.IOException
public static QueryStringQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException
java.io.IOException
public java.lang.String getWriteableName()
NamedWriteable
protected boolean doEquals(QueryStringQueryBuilder other)
AbstractQueryBuilder
QueryBuilder
object of the same type is "equal to" this one.doEquals
in class AbstractQueryBuilder<QueryStringQueryBuilder>
protected int doHashCode()
doHashCode
in class AbstractQueryBuilder<QueryStringQueryBuilder>
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException
doToQuery
in class AbstractQueryBuilder<QueryStringQueryBuilder>
java.io.IOException