org.elasticsearch.index.query

Class WildcardQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.MultiTermQueryBuilder

org.elasticsearch.index.query.WildcardQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<WildcardQueryBuilder>

public class WildcardQueryBuilder
extends MultiTermQueryBuilder
implements BoostableQueryBuilder<WildcardQueryBuilder>

Implements the wildcard search query. Supported wildcards are *, which matches any character sequence (including the empty one), and ?, which matches any single character. Note this query can be slow, as it needs to iterate over many terms. In order to prevent extremely slow WildcardQueries, a Wildcard term should not start with one of the wildcards * or ?.

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
WildcardQueryBuilder(String name, String wildcard) Implements the wildcard search query.

Method Summary

Methods

Modifier and Type	Method and Description
WildcardQueryBuilder	boost(float boost) Sets the boost for this query.
void	doXContent(XContentBuilder builder, ToXContent.Params params)
WildcardQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.
WildcardQueryBuilder	rewrite(String rewrite)

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

toXContent

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WildcardQueryBuilder

public WildcardQueryBuilder(String name,
                    String wildcard)

Implements the wildcard search query. Supported wildcards are *, which matches any character sequence (including the empty one), and ?, which matches any single character. Note this query can be slow, as it needs to iterate over many terms. In order to prevent extremely slow WildcardQueries, a Wildcard term should not start with one of the wildcards * or ?.

Parameters:

name - The field name

wildcard - The wildcard query string

Method Detail

rewrite

public WildcardQueryBuilder rewrite(String rewrite)

boost

public WildcardQueryBuilder boost(float boost)

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.

Specified by:

boost in interface BoostableQueryBuilder<WildcardQueryBuilder>

queryName

public WildcardQueryBuilder queryName(String queryName)

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

doXContent

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

Specified by:

doXContent in class QueryBuilder

Throws:

IOException