org.elasticsearch.index.query

Class RegexpQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.AbstractQueryBuilder<RegexpQueryBuilder>

org.elasticsearch.index.query.RegexpQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, MultiTermQueryBuilder, QueryBuilder

public class RegexpQueryBuilder
extends AbstractQueryBuilder<RegexpQueryBuilder>
implements MultiTermQueryBuilder

A Query that does fuzzy matching for a specific value.

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 int	DEFAULT_FLAGS_VALUE
static int	DEFAULT_MAX_DETERMINIZED_STATES
static java.lang.String	NAME

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

boost, BOOST_FIELD, DEFAULT_BOOST, queryName

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
RegexpQueryBuilder(StreamInput in) Read from a stream.
RegexpQueryBuilder(java.lang.String fieldName, java.lang.String value) Constructs a new regex query.

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(RegexpQueryBuilder 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)
java.lang.String	fieldName() Returns the field name used in this query.
int	flags()
RegexpQueryBuilder	flags(int flags)
RegexpQueryBuilder	flags(RegexpFlag... flags)
static java.util.Optional<RegexpQueryBuilder>	fromXContent(QueryParseContext parseContext)
java.lang.String	getWriteableName() Returns the name of the writeable object
int	maxDeterminizedStates()
RegexpQueryBuilder	maxDeterminizedStates(int value) Sets the regexp maxDeterminizedStates.
java.lang.String	rewrite()
RegexpQueryBuilder	rewrite(java.lang.String rewrite)
java.lang.String	value() Returns the value used in this query.

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, 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.index.query.QueryBuilder

boost, boost, getName, queryName, queryName, rewrite, rewriteQuery, toFilter, toQuery

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

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

isFragment, toXContent

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_FLAGS_VALUE

public static final int DEFAULT_FLAGS_VALUE

DEFAULT_MAX_DETERMINIZED_STATES

public static final int DEFAULT_MAX_DETERMINIZED_STATES

See Also:

Constant Field Values

Constructor Detail

RegexpQueryBuilder

public RegexpQueryBuilder(java.lang.String fieldName,
                          java.lang.String value)

Constructs a new regex query.

Parameters:

fieldName - The name of the field

value - The regular expression

RegexpQueryBuilder

public RegexpQueryBuilder(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<RegexpQueryBuilder>

Throws:

java.io.IOException

fieldName

public java.lang.String fieldName()

Returns the field name used in this query.

value

public java.lang.String value()

Returns the value used in this query.

flags

public RegexpQueryBuilder flags(RegexpFlag... flags)

flags

public RegexpQueryBuilder flags(int flags)

flags

public int flags()

maxDeterminizedStates

public RegexpQueryBuilder maxDeterminizedStates(int value)

Sets the regexp maxDeterminizedStates.

maxDeterminizedStates

public int maxDeterminizedStates()

rewrite

public RegexpQueryBuilder rewrite(java.lang.String rewrite)

rewrite

public java.lang.String rewrite()

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<RegexpQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static java.util.Optional<RegexpQueryBuilder> fromXContent(QueryParseContext parseContext)
                                                           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

Specified by:

getWriteableName in interface NamedWriteable

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<RegexpQueryBuilder>

Throws:

QueryShardException

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<RegexpQueryBuilder>

doEquals

protected boolean doEquals(RegexpQueryBuilder 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<RegexpQueryBuilder>