org.elasticsearch.index.query

Class PrefixQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.PrefixQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, MultiTermQueryBuilder, QueryBuilder

public class PrefixQueryBuilder
extends AbstractQueryBuilder<PrefixQueryBuilder>
implements MultiTermQueryBuilder

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
PrefixQueryBuilder(StreamInput in) Read from a stream.
PrefixQueryBuilder(java.lang.String fieldName, java.lang.String value) A Query that matches documents containing terms with a specified prefix.

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(PrefixQueryBuilder 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(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
void	doXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	fieldName()
static java.util.Optional<PrefixQueryBuilder>	fromXContent(QueryParseContext parseContext)
java.lang.String	getWriteableName() Returns the name of the writeable object
java.lang.String	rewrite()
PrefixQueryBuilder	rewrite(java.lang.String rewrite)
java.lang.String	value()

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

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

buildAsBytes, buildAsBytes, toString, toString

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

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

writeTo

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

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

toXContent

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

PrefixQueryBuilder

public PrefixQueryBuilder(java.lang.String fieldName,
                          java.lang.String value)

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

Parameters:

fieldName - The name of the field

value - The prefix query

PrefixQueryBuilder

public PrefixQueryBuilder(StreamInput in)
                   throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<PrefixQueryBuilder>

Throws:

java.io.IOException

fieldName

public java.lang.String fieldName()

value

public java.lang.String value()

rewrite

public PrefixQueryBuilder rewrite(java.lang.String rewrite)

rewrite

public java.lang.String rewrite()

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<PrefixQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static java.util.Optional<PrefixQueryBuilder> fromXContent(QueryParseContext parseContext)
                                                           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 interface NamedWriteable

doToQuery

protected org.apache.lucene.search.Query doToQuery(QueryShardContext context)
                                            throws java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<PrefixQueryBuilder>

Throws:

java.io.IOException

doHashCode

protected final int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<PrefixQueryBuilder>

doEquals

protected boolean doEquals(PrefixQueryBuilder 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<PrefixQueryBuilder>