Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class RegexpQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.RegexpQueryBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, MultiTermQueryBuilder, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

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.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 final boolean	DEFAULT_CASE_INSENSITIVITY
static final int	DEFAULT_FLAGS_VALUE
static final int	DEFAULT_MAX_DETERMINIZED_STATES
static final String	NAME

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.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	caseInsensitive()
RegexpQueryBuilder	caseInsensitive(boolean caseInsensitive)
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(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
String	fieldName()	Returns the field name used in this query.
int	flags()
RegexpQueryBuilder	flags(int flags)
RegexpQueryBuilder	flags(RegexpFlag... flags)
static RegexpQueryBuilder	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
int	maxDeterminizedStates()
RegexpQueryBuilder	maxDeterminizedStates(int value)	Sets the regexp maxDeterminizedStates.
String	rewrite()
RegexpQueryBuilder	rewrite(String rewrite)
String	value()	Returns the value used in this query.

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

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeTo

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, toQuery

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

writeTo

Field Details

NAME

public static final 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

DEFAULT_CASE_INSENSITIVITY

public static final boolean DEFAULT_CASE_INSENSITIVITY

See Also:

• Constant Field Values

Constructor Details

RegexpQueryBuilder

public RegexpQueryBuilder(String fieldName,
 String value)

Constructs a new regex query.

Parameters:

fieldName - The name of the field

value - The regular expression

RegexpQueryBuilder

public RegexpQueryBuilder(StreamInput in)
                   throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<RegexpQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Returns the field name used in this query.

Specified by:

fieldName in interface MultiTermQueryBuilder

value

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

caseInsensitive

public RegexpQueryBuilder caseInsensitive(boolean caseInsensitive)

caseInsensitive

public boolean caseInsensitive()

maxDeterminizedStates

public RegexpQueryBuilder maxDeterminizedStates(int value)

Sets the regexp maxDeterminizedStates.

maxDeterminizedStates

public int maxDeterminizedStates()

rewrite

public RegexpQueryBuilder rewrite(String rewrite)

rewrite

public String rewrite()

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<RegexpQueryBuilder>

Throws:

IOException

fromXContent

public static RegexpQueryBuilder fromXContent(XContentParser parser)
                                       throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws QueryShardException,
IOException

Specified by:

doToQuery in class AbstractQueryBuilder<RegexpQueryBuilder>

Throws:

QueryShardException

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>

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable