Package com.couchbase.client.java.search.queries

Class TermRangeQuery

java.lang.Object

com.couchbase.client.java.search.queries.AbstractFtsQuery

com.couchbase.client.java.search.queries.TermRangeQuery

@Uncommitted
@Public
public class TermRangeQuery
extends AbstractFtsQuery

A FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.

Since:

2.4.5

Author:

Michael Nitschinger

Constructor Summary

Constructors

Constructor	Description
TermRangeQuery()

Method Summary

Modifier and Type	Method	Description
TermRangeQuery	boost(double boost)
TermRangeQuery	field(String field)
protected void	injectParams(JsonObject input)	Override to inject query-specific parameters when doing the SearchQuery.export().
TermRangeQuery	max(String max)	Sets the upper boundary of the range.
TermRangeQuery	max(String max, boolean inclusive)	Sets the upper boundary of the range, inclusive or not depending on the second parameter.
TermRangeQuery	min(String min)	Sets the lower boundary of the range.
TermRangeQuery	min(String min, boolean inclusive)	Sets the lower boundary of the range, inclusive or not depending on the second parameter.

Methods inherited from class com.couchbase.client.java.search.queries.AbstractFtsQuery

injectParamsAndBoost, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TermRangeQuery

public TermRangeQuery()

Method Detail

min

public TermRangeQuery min(String min,
                          boolean inclusive)

Sets the lower boundary of the range, inclusive or not depending on the second parameter.

min

public TermRangeQuery min(String min)

Sets the lower boundary of the range. The lower boundary is considered inclusive by default on the server side.

See Also:

min(String, boolean)

max

public TermRangeQuery max(String max,
                          boolean inclusive)

Sets the upper boundary of the range, inclusive or not depending on the second parameter.

max

public TermRangeQuery max(String max)

Sets the upper boundary of the range. The upper boundary is considered exclusive by default on the server side.

See Also:

max(String, boolean)

field

public TermRangeQuery field(String field)

boost

public TermRangeQuery boost(double boost)

Overrides:

boost in class AbstractFtsQuery

injectParams

protected void injectParams(JsonObject input)

Description copied from class: AbstractFtsQuery

Override to inject query-specific parameters when doing the SearchQuery.export().

Specified by:

injectParams in class AbstractFtsQuery

Parameters:

input - the prepared JsonObject that will represent the query.