org.elasticsearch.index.query

Class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>>

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.BaseTermQueryBuilder<QB>

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder<QB>

Direct Known Subclasses:

SpanTermQueryBuilder, TermQueryBuilder

public abstract class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>>
extends AbstractQueryBuilder<QB>

Nested Class Summary

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

Writeable.Reader<R>

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
protected java.lang.String	fieldName Name of field to match against.
protected java.lang.Object	value Value to find matches for.
static ParseField	VALUE_FIELD

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

Modifier	Constructor and Description
protected	BaseTermQueryBuilder(StreamInput in) Read from a stream.
	BaseTermQueryBuilder(java.lang.String fieldName, boolean value) Constructs a new base term query.
	BaseTermQueryBuilder(java.lang.String fieldName, double value) Constructs a new base term query.
	BaseTermQueryBuilder(java.lang.String fieldName, float value) Constructs a new base term query.
	BaseTermQueryBuilder(java.lang.String fieldName, int value) Constructs a new base term query.
	BaseTermQueryBuilder(java.lang.String fieldName, long value) Constructs a new base term query.
	BaseTermQueryBuilder(java.lang.String fieldName, java.lang.Object value) Constructs a new base term query.
	BaseTermQueryBuilder(java.lang.String fieldName, java.lang.String value) Constructs a new base term query.

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(BaseTermQueryBuilder other) Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	fieldName() Returns the field name used in this query.
java.lang.Object	value() Returns the value used in this query.

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

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

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

buildAsBytes, buildAsBytes, 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

rewriteQuery

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

getWriteableName

Field Detail

VALUE_FIELD

public static final ParseField VALUE_FIELD

fieldName

protected final java.lang.String fieldName

Name of field to match against.

value

protected final java.lang.Object value

Value to find matches for.

Constructor Detail

BaseTermQueryBuilder

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

Constructs a new base term query.

Parameters:

fieldName - The name of the field

value - The value of the term

BaseTermQueryBuilder

public BaseTermQueryBuilder(java.lang.String fieldName,
                            int value)

Constructs a new base term query.

Parameters:

fieldName - The name of the field

value - The value of the term

BaseTermQueryBuilder

public BaseTermQueryBuilder(java.lang.String fieldName,
                            long value)

Constructs a new base term query.

Parameters:

fieldName - The name of the field

value - The value of the term

BaseTermQueryBuilder

public BaseTermQueryBuilder(java.lang.String fieldName,
                            float value)

Constructs a new base term query.

Parameters:

fieldName - The name of the field

value - The value of the term

BaseTermQueryBuilder

public BaseTermQueryBuilder(java.lang.String fieldName,
                            double value)

Constructs a new base term query.

Parameters:

fieldName - The name of the field

value - The value of the term

BaseTermQueryBuilder

public BaseTermQueryBuilder(java.lang.String fieldName,
                            boolean value)

Constructs a new base term query.

Parameters:

fieldName - The name of the field

value - The value of the term

BaseTermQueryBuilder

public BaseTermQueryBuilder(java.lang.String fieldName,
                            java.lang.Object value)

Constructs a new base term query. In case value is assigned to a string, we internally convert it to a BytesRef because in TermQueryBuilder and SpanTermQueryBuilder string values are parsed to BytesRef and we want internal representation of query to be equal regardless of whether it was created from XContent or via Java API.

Parameters:

fieldName - The name of the field

value - The value of the term

BaseTermQueryBuilder

protected BaseTermQueryBuilder(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<QB extends BaseTermQueryBuilder<QB>>

Throws:

java.io.IOException

fieldName

public java.lang.String fieldName()

Returns the field name used in this query.

value

public java.lang.Object value()

Returns the value used in this query. If necessary, converts internal BytesRef representation back to string.

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<QB extends BaseTermQueryBuilder<QB>>

Throws:

java.io.IOException

doHashCode

protected final int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<QB extends BaseTermQueryBuilder<QB>>

doEquals

protected final boolean doEquals(BaseTermQueryBuilder 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<QB extends BaseTermQueryBuilder<QB>>