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
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,MultiTermQueryBuilder
,QueryBuilder
,Rewriteable<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.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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_CASE_INSENSITIVITY
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, 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 RegexpQueryBuilder(java.lang.String fieldName, java.lang.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 otherQueryBuilder
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(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 RegexpQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectint
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, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, 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.index.query.QueryBuilder
boost, boost, getName, queryName, queryName, rewrite, toQuery
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent
toXContent
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
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
-
DEFAULT_CASE_INSENSITIVITY
public static final boolean DEFAULT_CASE_INSENSITIVITY- See Also:
- Constant Field Values
-
-
Constructor Details
-
RegexpQueryBuilder
public RegexpQueryBuilder(java.lang.String fieldName, java.lang.String value)Constructs a new regex query.- Parameters:
fieldName
- The name of the fieldvalue
- The regular expression
-
RegexpQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<RegexpQueryBuilder>
- Throws:
java.io.IOException
-
fieldName
public java.lang.String fieldName()Returns the field name used in this query.- Specified by:
fieldName
in interfaceMultiTermQueryBuilder
-
value
public java.lang.String value()Returns the value used in this query. -
flags
-
flags
-
flags
public int flags() -
caseInsensitive
-
caseInsensitive
public boolean caseInsensitive() -
maxDeterminizedStates
Sets the regexp maxDeterminizedStates. -
maxDeterminizedStates
public int maxDeterminizedStates() -
rewrite
-
rewrite
public java.lang.String rewrite() -
doXContent
protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<RegexpQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static RegexpQueryBuilder fromXContent(org.elasticsearch.common.xcontent.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- Specified by:
getWriteableName
in interfaceNamedWriteable
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws QueryShardException, java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<RegexpQueryBuilder>
- Throws:
QueryShardException
java.io.IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<RegexpQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<RegexpQueryBuilder>
-