org.elasticsearch.index.query

Class PrefixQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.MultiTermQueryBuilder

org.elasticsearch.index.query.PrefixQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<PrefixQueryBuilder>

public class PrefixQueryBuilder
extends MultiTermQueryBuilder
implements BoostableQueryBuilder<PrefixQueryBuilder>

A Query that matches documents containing terms with a specified prefix.

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
PrefixQueryBuilder(String name, String prefix) A Query that matches documents containing terms with a specified prefix.

Method Summary

Methods

Modifier and Type	Method and Description
PrefixQueryBuilder	boost(float boost) Sets the boost for this query.
void	doXContent(XContentBuilder builder, ToXContent.Params params)
PrefixQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.
PrefixQueryBuilder	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

PrefixQueryBuilder

public PrefixQueryBuilder(String name,
                  String prefix)

A Query that matches documents containing terms with a specified prefix.

Parameters:

name - The name of the field

prefix - The prefix query

Method Detail

boost

public PrefixQueryBuilder 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<PrefixQueryBuilder>

rewrite

public PrefixQueryBuilder rewrite(String rewrite)

queryName

public PrefixQueryBuilder 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