java.lang.Object
- org.elasticsearch.index.query.AbstractQueryBuilder<SimpleQueryStringBuilder>
- - org.elasticsearch.index.query.SimpleQueryStringBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>
```
public class SimpleQueryStringBuilder
extends AbstractQueryBuilder<SimpleQueryStringBuilder>
```
SimpleQuery is a query parser that acts similar to a query_string query, but won't throw exceptions for any weird string syntax. It supports the following:
- '+' specifies AND operation: token1+token2
- '|' specifies OR operation: token1|token2
- '-' negates a single token: -token0
- '"' creates phrases of terms: "term1 term2 ..."
- '*' at the end of terms specifies prefix query: term*
- '(' and ')' specifies precedence: token1 + (token2 | token3)
- '~N' at the end of terms specifies fuzzy query: term~1
- '~N' at the end of phrases specifies near/slop query: "term1 term2"~5
See: SimpleQueryStringQueryParser for more information.
This query supports these options:
Required: query - query text to be converted into other queries
Optional: analyzer - anaylzer to be used for analyzing tokens to determine which kind of query they should be converted into, defaults to "standard" default_operator - default operator for boolean queries, defaults to OR fields - fields to search, defaults to _all if not set, allows boosting a field with ^n For more detailed explanation of the query string syntax see also the online documentation.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`DEFAULT_ANALYZE_WILDCARD`	Default for wildcard analysis.
`static int`	`DEFAULT_FLAGS`	Default for search flags to use.
`static int`	`DEFAULT_FUZZY_MAX_EXPANSIONS`	Default number of terms fuzzy queries will expand to.
`static int`	`DEFAULT_FUZZY_PREFIX_LENGTH`	Default for prefix length in fuzzy queries.
`static boolean`	`DEFAULT_FUZZY_TRANSPOSITIONS`	Default for using transpositions in fuzzy queries.
`static boolean`	`DEFAULT_LENIENT`	Default for using lenient query parsing.
`static Operator`	`DEFAULT_OPERATOR`	Default for default operator to use for linking boolean clauses.
`static String`	`NAME`	Name for (de-)serialization.

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS

Constructor Summary

Constructors
Constructor	Description
`SimpleQueryStringBuilder(String queryText)`	Construct a new simple query with this query string.
`SimpleQueryStringBuilder(StreamInput in)`	Read from a stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`analyzer()`	Returns the analyzer to use for the query.
`SimpleQueryStringBuilder`	`analyzer(String analyzer)`	Specify an analyzer to use for the query.
`boolean`	`analyzeWildcard()`	Returns whether wildcards should by analyzed.
`SimpleQueryStringBuilder`	`analyzeWildcard(boolean analyzeWildcard)`	Specifies whether wildcards should be analyzed.
`boolean`	`autoGenerateSynonymsPhraseQuery()`	Whether phrase queries should be automatically generated for multi terms synonyms.
`SimpleQueryStringBuilder`	`autoGenerateSynonymsPhraseQuery(boolean value)`
`Operator`	`defaultOperator()`	Returns the default operator for the query.
`SimpleQueryStringBuilder`	`defaultOperator(Operator defaultOperator)`	Specify the default operator for the query.
`protected boolean`	`doEquals(SimpleQueryStringBuilder other)`	Indicates whether some other `QueryBuilder` object of the same type is "equal to" this one.
`protected int`	`doHashCode()`
`protected Query`	`doToQuery(QueryShardContext context)`
`protected void`	`doWriteTo(StreamOutput out)`
`protected void`	`doXContent(XContentBuilder builder, ToXContent.Params params)`
`SimpleQueryStringBuilder`	`field(String field)`	Add a field to run the query against.
`SimpleQueryStringBuilder`	`field(String field, float boost)`	Add a field to run the query against with a specific boost.
`Map<String,Float>`	`fields()`	Returns the fields including their respective boosts to run the query against.
`SimpleQueryStringBuilder`	`fields(Map<String,Float> fields)`	Add several fields to run the query against with a specific boost.
`SimpleQueryStringBuilder`	`flags(SimpleQueryStringFlag... flags)`	Specify the enabled features of the SimpleQueryString.
`static SimpleQueryStringBuilder`	`fromXContent(XContentParser parser)`
`int`	`fuzzyMaxExpansions()`
`SimpleQueryStringBuilder`	`fuzzyMaxExpansions(int fuzzyMaxExpansions)`
`int`	`fuzzyPrefixLength()`
`SimpleQueryStringBuilder`	`fuzzyPrefixLength(int fuzzyPrefixLength)`
`boolean`	`fuzzyTranspositions()`
`SimpleQueryStringBuilder`	`fuzzyTranspositions(boolean fuzzyTranspositions)`	Sets whether transpositions are supported in fuzzy queries.
`String`	`getWriteableName()`	Returns the name of the writeable object
`boolean`	`lenient()`	Returns whether query parsing should be lenient.
`SimpleQueryStringBuilder`	`lenient(boolean lenient)`	Specifies whether query parsing should be lenient.
`String`	`minimumShouldMatch()`	Returns the minimumShouldMatch to apply to the resulting query should that be a Boolean query.
`SimpleQueryStringBuilder`	`minimumShouldMatch(String minimumShouldMatch)`	Specifies the minimumShouldMatch to apply to the resulting query should that be a Boolean query.
`String`	`quoteFieldSuffix()`	Return the suffix to append to field names for phrase matching.
`SimpleQueryStringBuilder`	`quoteFieldSuffix(String suffix)`	Set the suffix to append to field names for phrase matching.
`String`	`value()`	Returns the text to parse the query from.

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment

- Field Detail
  - DEFAULT_LENIENT
```
public static final boolean DEFAULT_LENIENT
```
    Default for using lenient query parsing.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ANALYZE_WILDCARD
```
public static final boolean DEFAULT_ANALYZE_WILDCARD
```
    Default for wildcard analysis.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OPERATOR
```
public static final Operator DEFAULT_OPERATOR
```
    Default for default operator to use for linking boolean clauses.
  - DEFAULT_FLAGS
```
public static final int DEFAULT_FLAGS
```
    Default for search flags to use.
  - DEFAULT_FUZZY_PREFIX_LENGTH
```
public static final int DEFAULT_FUZZY_PREFIX_LENGTH
```
    Default for prefix length in fuzzy queries.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FUZZY_MAX_EXPANSIONS
```
public static final int DEFAULT_FUZZY_MAX_EXPANSIONS
```
    Default number of terms fuzzy queries will expand to.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FUZZY_TRANSPOSITIONS
```
public static final boolean DEFAULT_FUZZY_TRANSPOSITIONS
```
    Default for using transpositions in fuzzy queries.
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Name for (de-)serialization.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SimpleQueryStringBuilder
```
public SimpleQueryStringBuilder(String queryText)
```
    Construct a new simple query with this query string.
  - SimpleQueryStringBuilder
```
public SimpleQueryStringBuilder(StreamInput in)
                         throws IOException
```
    Read from a stream.
    
    Throws:
    
    IOException
- Method Detail
  - doWriteTo
```
protected void doWriteTo(StreamOutput out)
                  throws IOException
```
    Specified by:
    
    doWriteTo in class AbstractQueryBuilder<SimpleQueryStringBuilder>
    
    Throws:
    
    IOException
  - value
```
public String value()
```
    Returns the text to parse the query from.
  - field
```
public SimpleQueryStringBuilder field(String field)
```
    Add a field to run the query against.
  - field
```
public SimpleQueryStringBuilder field(String field,
                                      float boost)
```
    Add a field to run the query against with a specific boost.
  - fields
```
public SimpleQueryStringBuilder fields(Map<String,Float> fields)
```
    Add several fields to run the query against with a specific boost.
  - fields
```
public Map<String,Float> fields()
```
    Returns the fields including their respective boosts to run the query against.
  - analyzer
```
public SimpleQueryStringBuilder analyzer(String analyzer)
```
    Specify an analyzer to use for the query.
  - analyzer
```
public String analyzer()
```
    Returns the analyzer to use for the query.
  - defaultOperator
```
public SimpleQueryStringBuilder defaultOperator(Operator defaultOperator)
```
    Specify the default operator for the query. Defaults to "OR" if no operator is specified.
  - defaultOperator
```
public Operator defaultOperator()
```
    Returns the default operator for the query.
  - flags
```
public SimpleQueryStringBuilder flags(SimpleQueryStringFlag... flags)
```
    Specify the enabled features of the SimpleQueryString. Defaults to ALL if none are specified.
  - quoteFieldSuffix
```
public SimpleQueryStringBuilder quoteFieldSuffix(String suffix)
```
    Set the suffix to append to field names for phrase matching.
  - quoteFieldSuffix
```
public String quoteFieldSuffix()
```
    Return the suffix to append to field names for phrase matching.
  - lenient
```
public SimpleQueryStringBuilder lenient(boolean lenient)
```
    Specifies whether query parsing should be lenient. Defaults to false.
  - lenient
```
public boolean lenient()
```
    Returns whether query parsing should be lenient.
  - analyzeWildcard
```
public SimpleQueryStringBuilder analyzeWildcard(boolean analyzeWildcard)
```
    Specifies whether wildcards should be analyzed. Defaults to false.
  - analyzeWildcard
```
public boolean analyzeWildcard()
```
    Returns whether wildcards should by analyzed.
  - minimumShouldMatch
```
public SimpleQueryStringBuilder minimumShouldMatch(String minimumShouldMatch)
```
    Specifies the minimumShouldMatch to apply to the resulting query should that be a Boolean query.
  - minimumShouldMatch
```
public String minimumShouldMatch()
```
    Returns the minimumShouldMatch to apply to the resulting query should that be a Boolean query.
  - autoGenerateSynonymsPhraseQuery
```
public SimpleQueryStringBuilder autoGenerateSynonymsPhraseQuery(boolean value)
```
  - autoGenerateSynonymsPhraseQuery
```
public boolean autoGenerateSynonymsPhraseQuery()
```
    Whether phrase queries should be automatically generated for multi terms synonyms. Defaults to true.
  - fuzzyPrefixLength
```
public SimpleQueryStringBuilder fuzzyPrefixLength(int fuzzyPrefixLength)
```
  - fuzzyPrefixLength
```
public int fuzzyPrefixLength()
```
  - fuzzyMaxExpansions
```
public SimpleQueryStringBuilder fuzzyMaxExpansions(int fuzzyMaxExpansions)
```
  - fuzzyMaxExpansions
```
public int fuzzyMaxExpansions()
```
  - fuzzyTranspositions
```
public boolean fuzzyTranspositions()
```
  - fuzzyTranspositions
```
public SimpleQueryStringBuilder fuzzyTranspositions(boolean fuzzyTranspositions)
```
    Sets whether transpositions are supported in fuzzy queries.
    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.
  - doToQuery
```
protected Query doToQuery(QueryShardContext context)
                   throws IOException
```
    Specified by:
    
    doToQuery in class AbstractQueryBuilder<SimpleQueryStringBuilder>
    
    Throws:
    
    IOException
  - doXContent
```
protected void doXContent(XContentBuilder builder,
                          ToXContent.Params params)
                   throws IOException
```
    Specified by:
    
    doXContent in class AbstractQueryBuilder<SimpleQueryStringBuilder>
    
    Throws:
    
    IOException
  - fromXContent
```
public static SimpleQueryStringBuilder fromXContent(XContentParser parser)
                                             throws IOException
```
    Throws:
    
    IOException
  - getWriteableName
```
public String getWriteableName()
```
    Description copied from interface: NamedWriteable
    
    Returns the name of the writeable object
  - doHashCode
```
protected int doHashCode()
```
    Specified by:
    
    doHashCode in class AbstractQueryBuilder<SimpleQueryStringBuilder>
  - doEquals
```
protected boolean doEquals(SimpleQueryStringBuilder other)
```
    Description copied from class: AbstractQueryBuilder
    
    Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
    
    Specified by:
    
    doEquals in class AbstractQueryBuilder<SimpleQueryStringBuilder>

Class SimpleQueryStringBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

Field Detail

DEFAULT_LENIENT

DEFAULT_ANALYZE_WILDCARD

DEFAULT_OPERATOR

DEFAULT_FLAGS

DEFAULT_FUZZY_PREFIX_LENGTH

DEFAULT_FUZZY_MAX_EXPANSIONS

DEFAULT_FUZZY_TRANSPOSITIONS

NAME

Constructor Detail

SimpleQueryStringBuilder

SimpleQueryStringBuilder

Method Detail

doWriteTo

value

field

field

fields

fields

analyzer

analyzer

defaultOperator

defaultOperator

flags

quoteFieldSuffix

quoteFieldSuffix

lenient

lenient

analyzeWildcard

analyzeWildcard

minimumShouldMatch

minimumShouldMatch

autoGenerateSynonymsPhraseQuery

autoGenerateSynonymsPhraseQuery

fuzzyPrefixLength

fuzzyPrefixLength

fuzzyMaxExpansions

fuzzyMaxExpansions

fuzzyTranspositions

fuzzyTranspositions

doToQuery

doXContent

fromXContent

getWriteableName

doHashCode

doEquals