org.elasticsearch.index.query

Class RegexpFilterBuilder

java.lang.Object

org.elasticsearch.index.query.BaseFilterBuilder

org.elasticsearch.index.query.RegexpFilterBuilder

All Implemented Interfaces:

ToXContent, FilterBuilder

public class RegexpFilterBuilder
extends BaseFilterBuilder

A filter that restricts search results to values that have a matching regular expression in a given field.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
RegexpFilterBuilder(String name, String regexp) A filter that restricts search results to values that have a matching prefix in a given field.

Method Summary

Modifier and Type	Method and Description
RegexpFilterBuilder	cache(boolean cache) Should the filter be cached or not.
RegexpFilterBuilder	cacheKey(String cacheKey)
void	doXContent(XContentBuilder builder, ToXContent.Params params)
RegexpFilterBuilder	filterName(String filterName) Sets the filter name for the filter that can be used when searching for matched_filters per hit.
RegexpFilterBuilder	flags(RegexpFlag... flags) Sets the regexp flags (see RegexpFlag).
RegexpFilterBuilder	maxDeterminizedStates(int value) Sets the regexp maxDeterminizedStates.

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

buildAsBytes, buildAsBytes, toString, toXContent

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexpFilterBuilder

public RegexpFilterBuilder(String name,
                           String regexp)

A filter that restricts search results to values that have a matching prefix in a given field.

Parameters:

name - The field name

regexp - The regular expression

Method Detail

filterName

public RegexpFilterBuilder filterName(String filterName)

Sets the filter name for the filter that can be used when searching for matched_filters per hit.

flags

public RegexpFilterBuilder flags(RegexpFlag... flags)

Sets the regexp flags (see RegexpFlag).

maxDeterminizedStates

public RegexpFilterBuilder maxDeterminizedStates(int value)

Sets the regexp maxDeterminizedStates.

cache

public RegexpFilterBuilder cache(boolean cache)

Should the filter be cached or not. Defaults to false.

cacheKey

public RegexpFilterBuilder cacheKey(String cacheKey)

doXContent

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

Specified by:

doXContent in class BaseFilterBuilder

Throws:

IOException