org.elasticsearch.index.query

Class SimpleQueryStringParser

java.lang.Object

org.elasticsearch.index.query.SimpleQueryStringParser

All Implemented Interfaces:

QueryParser

public class SimpleQueryStringParser
extends Object
implements QueryParser

SimpleQueryStringParser 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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
SimpleQueryStringParser()

Method Summary

Modifier and Type	Method and Description
String[]	names() The names this query parser is registered under.
org.apache.lucene.search.Query	parse(QueryParseContext parseContext) Parses the into a query from the current parser location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

SimpleQueryStringParser

@Inject
public SimpleQueryStringParser()

Method Detail

names

public String[] names()

Description copied from interface: QueryParser

The names this query parser is registered under.

Specified by:

names in interface QueryParser

parse

public org.apache.lucene.search.Query parse(QueryParseContext parseContext)
                                     throws IOException,
                                            QueryParsingException

Description copied from interface: QueryParser

Parses the into a query from the current parser location. Will be at "START_OBJECT" location, and should end when the token is at the matching "END_OBJECT".

Returns null if this query should be ignored in the context of the DSL.

Specified by:

parse in interface QueryParser

Throws:

IOException

QueryParsingException