com.couchbase.client.java.search.queries

Class AbstractFtsQuery

java.lang.Object

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

Direct Known Subclasses:

AbstractCompoundQuery, BooleanFieldQuery, BooleanQuery, DateRangeQuery, DocIdQuery, GeoBoundingBoxQuery, GeoDistanceQuery, MatchAllQuery, MatchNoneQuery, MatchPhraseQuery, MatchQuery, NumericRangeQuery, PhraseQuery, PrefixQuery, QueryStringQuery, RegexpQuery, TermQuery, TermRangeQuery, WildcardQuery

@InterfaceStability.Uncommitted
 @InterfaceAudience.Private
public abstract class AbstractFtsQuery
extends Object

A base class for all FTS query classes. Exposes the common FTS query parameters. In order to instantiate various flavors of queries, look at concrete classes or static factory methods in SearchQuery.

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFtsQuery()

Method Summary

Modifier and Type	Method and Description
AbstractFtsQuery	boost(double boost)
protected abstract void	injectParams(JsonObject input) Override to inject query-specific parameters when doing the SearchQuery.export().
void	injectParamsAndBoost(JsonObject input) Injects the query’s parameters (including the common boost and query-specific parameters) into a prepared JsonObject.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFtsQuery

protected AbstractFtsQuery()

Method Detail

boost

public AbstractFtsQuery boost(double boost)

injectParamsAndBoost

public void injectParamsAndBoost(JsonObject input)

Injects the query’s parameters (including the common boost and query-specific parameters) into a prepared JsonObject.

Parameters:

input - the prepared JsonObject to receive the parameters.

See Also:

for a usage of this method.

injectParams

protected abstract void injectParams(JsonObject input)

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

Parameters:

input - the prepared JsonObject that will represent the query.

toString

public String toString()

Overrides:

toString in class Object

Returns:

the String representation of the FTS query, which is its JSON representation without global parameters.