com.couchbase.client.java.search.queries

Class NumericRangeQuery

java.lang.Object

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

com.couchbase.client.java.search.queries.NumericRangeQuery

@InterfaceStability.Uncommitted
 @InterfaceAudience.Public
public class NumericRangeQuery
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.3.0

Author:

Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Constructor and Description
NumericRangeQuery()

Method Summary

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

NumericRangeQuery

public NumericRangeQuery()

Method Detail

min

public NumericRangeQuery min(double min,
                             boolean inclusive)

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

min

public NumericRangeQuery min(double min)

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

See Also:

min(double, boolean)

max

public NumericRangeQuery max(double max,
                             boolean inclusive)

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

max

public NumericRangeQuery max(double max)

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

See Also:

max(double, boolean)

field

public NumericRangeQuery field(String field)

boost

public NumericRangeQuery 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.