org.elasticsearch.index.query

Class SimpleQueryStringBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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: SimpleQueryParser 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.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ANALYZE_WILDCARD Default for wildcard analysis.
static int	DEFAULT_FLAGS Default for search flags to use.
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 java.lang.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.common.xcontent.ToXContent

EMPTY_PARAMS

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

MAX_REWRITE_ROUNDS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	analyzer() Returns the analyzer to use for the query.
SimpleQueryStringBuilder	analyzer(java.lang.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.
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 org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
SimpleQueryStringBuilder	field(java.lang.String field) Add a field to run the query against.
SimpleQueryStringBuilder	field(java.lang.String field, float boost) Add a field to run the query 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.
SimpleQueryStringBuilder	fields(java.util.Map<java.lang.String,java.lang.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)
java.lang.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.
java.lang.String	minimumShouldMatch() Returns the minimumShouldMatch to apply to the resulting query should that be a Boolean query.
SimpleQueryStringBuilder	minimumShouldMatch(java.lang.String minimumShouldMatch) Specifies the minimumShouldMatch to apply to the resulting query should that be a Boolean query.
java.lang.String	quoteFieldSuffix() Return the suffix to append to field names for phrase matching.
SimpleQueryStringBuilder	quoteFieldSuffix(java.lang.String suffix) Set the suffix to append to field names for phrase matching.
java.lang.Boolean	useAllFields()
SimpleQueryStringBuilder	useAllFields(java.lang.Boolean useAllFields)
java.lang.String	value() Returns the text to parse the query from.

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString, toString

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

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

rewrite, rewrite, rewrite, rewriteAndFetch, rewriteAndFetch

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.

NAME

public static final java.lang.String NAME

Name for (de-)serialization.

See Also:

Constant Field Values

Constructor Detail

SimpleQueryStringBuilder

public SimpleQueryStringBuilder(java.lang.String queryText)

Construct a new simple query with this query string.

SimpleQueryStringBuilder

public SimpleQueryStringBuilder(StreamInput in)
                         throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<SimpleQueryStringBuilder>

Throws:

java.io.IOException

value

public java.lang.String value()

Returns the text to parse the query from.

field

public SimpleQueryStringBuilder field(java.lang.String field)

Add a field to run the query against.

field

public SimpleQueryStringBuilder field(java.lang.String field,
                                      float boost)

Add a field to run the query against with a specific boost.

fields

public SimpleQueryStringBuilder fields(java.util.Map<java.lang.String,java.lang.Float> fields)

Add several fields to run the query against with a specific boost.

fields

public java.util.Map<java.lang.String,java.lang.Float> fields()

Returns the fields including their respective boosts to run the query against.

analyzer

public SimpleQueryStringBuilder analyzer(java.lang.String analyzer)

Specify an analyzer to use for the query.

analyzer

public java.lang.String analyzer()

Returns the analyzer to use for the query.

useAllFields

public java.lang.Boolean useAllFields()

useAllFields

public SimpleQueryStringBuilder useAllFields(java.lang.Boolean useAllFields)

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(java.lang.String suffix)

Set the suffix to append to field names for phrase matching.

quoteFieldSuffix

public java.lang.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(java.lang.String minimumShouldMatch)

Specifies the minimumShouldMatch to apply to the resulting query should that be a Boolean query.

minimumShouldMatch

public java.lang.String minimumShouldMatch()

Returns the minimumShouldMatch to apply to the resulting query should that be a Boolean query.

doToQuery

protected org.apache.lucene.search.Query doToQuery(QueryShardContext context)
                                            throws java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<SimpleQueryStringBuilder>

Throws:

java.io.IOException

doXContent

protected void doXContent(XContentBuilder builder,
                          ToXContent.Params params)
                   throws java.io.IOException

Specified by:

doXContent in class AbstractQueryBuilder<SimpleQueryStringBuilder>

Throws:

java.io.IOException

fromXContent

public static SimpleQueryStringBuilder fromXContent(XContentParser parser)
                                             throws java.io.IOException

Throws:

java.io.IOException

getWriteableName

public java.lang.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>