Package org.elasticsearch.index.query

Class RangeQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.RangeQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, MultiTermQueryBuilder, QueryBuilder, Rewriteable<QueryBuilder>

public class RangeQueryBuilder
extends AbstractQueryBuilder<RangeQueryBuilder>
implements MultiTermQueryBuilder

A Query that matches documents within an range of terms.

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_INCLUDE_LOWER
static boolean	DEFAULT_INCLUDE_UPPER
static org.elasticsearch.common.xcontent.ParseField	FROM_FIELD
static org.elasticsearch.common.xcontent.ParseField	GT_FIELD
static org.elasticsearch.common.xcontent.ParseField	GTE_FIELD
static org.elasticsearch.common.xcontent.ParseField	LT_FIELD
static org.elasticsearch.common.xcontent.ParseField	LTE_FIELD
static String	NAME
static org.elasticsearch.common.xcontent.ParseField	TO_FIELD

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

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RangeQueryBuilder(String fieldName)	A Query that matches documents within an range of terms.
RangeQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(RangeQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
String	fieldName()	Get the field name for this query.
String	format()	Gets the format field to parse the from/to fields
RangeQueryBuilder	format(String format)	In case of format field, we can parse the from/to fields using this time format
Object	from()	Gets the lower range value for this query.
RangeQueryBuilder	from(Object from)	The from part of the range query.
RangeQueryBuilder	from(Object from, boolean includeLower)	The from part of the range query.
static RangeQueryBuilder	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
protected MappedFieldType.Relation	getRelation(QueryRewriteContext queryRewriteContext)
String	getWriteableName()	Returns the name of the writeable object
RangeQueryBuilder	gt(Object from)	The from part of the range query.
RangeQueryBuilder	gte(Object from)	The from part of the range query.
boolean	includeLower()	Gets the includeLower flag for this query.
RangeQueryBuilder	includeLower(boolean includeLower)	Should the lower bound be included or not.
boolean	includeUpper()	Gets the includeUpper flag for this query.
RangeQueryBuilder	includeUpper(boolean includeUpper)	Should the upper bound be included or not.
RangeQueryBuilder	lt(Object to)	The to part of the range query.
RangeQueryBuilder	lte(Object to)	The to part of the range query.
ShapeRelation	relation()
RangeQueryBuilder	relation(String relation)
String	timeZone()	In case of date field, gets the from/to fields timezone adjustment
RangeQueryBuilder	timeZone(String timeZone)	In case of date field, we can adjust the from/to fields using a timezone
Object	to()	Gets the upper range value for this query.
RangeQueryBuilder	to(Object to)	The to part of the range query.
RangeQueryBuilder	to(Object to, boolean includeUpper)	The to part of the range query.

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

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

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

toXContent

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

isFragment

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

writeTo

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

DEFAULT_INCLUDE_UPPER

public static final boolean DEFAULT_INCLUDE_UPPER

See Also:

Constant Field Values

DEFAULT_INCLUDE_LOWER

public static final boolean DEFAULT_INCLUDE_LOWER

See Also:

Constant Field Values

LTE_FIELD

public static final org.elasticsearch.common.xcontent.ParseField LTE_FIELD

GTE_FIELD

public static final org.elasticsearch.common.xcontent.ParseField GTE_FIELD

FROM_FIELD

public static final org.elasticsearch.common.xcontent.ParseField FROM_FIELD

TO_FIELD

public static final org.elasticsearch.common.xcontent.ParseField TO_FIELD

GT_FIELD

public static final org.elasticsearch.common.xcontent.ParseField GT_FIELD

LT_FIELD

public static final org.elasticsearch.common.xcontent.ParseField LT_FIELD

Constructor Details

RangeQueryBuilder

public RangeQueryBuilder(String fieldName)

A Query that matches documents within an range of terms.

Parameters:

fieldName - The field name

RangeQueryBuilder

public RangeQueryBuilder(StreamInput in)
                  throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<RangeQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Get the field name for this query.

Specified by:

fieldName in interface MultiTermQueryBuilder

from

public RangeQueryBuilder from(Object from,
 boolean includeLower)

The from part of the range query. Null indicates unbounded. In case lower bound is assigned to a string, we internally convert it to a BytesRef because in RangeQueryBuilder field are later parsed as BytesRef and we need internal representation of query to be equal regardless of whether it was created from XContent or via Java API.

from

public RangeQueryBuilder from(Object from)

The from part of the range query. Null indicates unbounded.

from

public Object from()

Gets the lower range value for this query.

gt

public RangeQueryBuilder gt(Object from)

The from part of the range query. Null indicates unbounded.

gte

public RangeQueryBuilder gte(Object from)

The from part of the range query. Null indicates unbounded.

to

public RangeQueryBuilder to(Object to,
 boolean includeUpper)

The to part of the range query. Null indicates unbounded.

to

public RangeQueryBuilder to(Object to)

The to part of the range query. Null indicates unbounded.

to

public Object to()

Gets the upper range value for this query. In case upper bound is assigned to a string, we internally convert it to a BytesRef because in RangeQueryBuilder field are later parsed as BytesRef and we need internal representation of query to be equal regardless of whether it was created from XContent or via Java API.

lt

public RangeQueryBuilder lt(Object to)

The to part of the range query. Null indicates unbounded.

lte

public RangeQueryBuilder lte(Object to)

The to part of the range query. Null indicates unbounded.

includeLower

public RangeQueryBuilder includeLower(boolean includeLower)

Should the lower bound be included or not. Defaults to true.

includeLower

public boolean includeLower()

Gets the includeLower flag for this query.

includeUpper

public RangeQueryBuilder includeUpper(boolean includeUpper)

Should the upper bound be included or not. Defaults to true.

includeUpper

public boolean includeUpper()

Gets the includeUpper flag for this query.

timeZone

public RangeQueryBuilder timeZone(String timeZone)

In case of date field, we can adjust the from/to fields using a timezone

timeZone

public String timeZone()

In case of date field, gets the from/to fields timezone adjustment

format

public RangeQueryBuilder format(String format)

In case of format field, we can parse the from/to fields using this time format

format

public String format()

Gets the format field to parse the from/to fields

relation

public ShapeRelation relation()

relation

public RangeQueryBuilder relation(String relation)

doXContent

protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<RangeQueryBuilder>

Throws:

IOException

fromXContent

public static RangeQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                      throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

getRelation

protected MappedFieldType.Relation getRelation(QueryRewriteContext queryRewriteContext)
                                        throws IOException

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<RangeQueryBuilder>

Throws:

IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<RangeQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<RangeQueryBuilder>

doEquals

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