Package com.couchbase.client.java.search

Class SearchQuery

java.lang.Object

com.couchbase.client.java.search.SearchQuery

Direct Known Subclasses:

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

@Internal
public abstract class SearchQuery
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	Description
protected	SearchQuery()

Method Summary

Modifier and Type	Method	Description
static BooleanFieldQuery	booleanField(boolean value)	Prepare a BooleanFieldQuery body.
static BooleanQuery	booleans()	Prepare a BooleanQuery body.
SearchQuery	boost(double boost)
static ConjunctionQuery	conjuncts(SearchQuery... queries)	Prepare a ConjunctionQuery body.
static DateRangeQuery	dateRange()	Prepare a DateRangeQuery body.
static DisjunctionQuery	disjuncts(SearchQuery... queries)	Prepare a DisjunctionQuery body.
static DocIdQuery	docId(String... docIds)	Prepare a DocIdQuery body.
JsonObject	export()	Exports the whole query as a JsonObject.
static GeoBoundingBoxQuery	geoBoundingBox(double topLeftLon, double topLeftLat, double bottomRightLon, double bottomRightLat)	Prepare a GeoBoundingBoxQuery body.
static GeoBoundingBoxQuery	geoBoundingBox(Coordinate topLeftCoordinate, Coordinate bottomRightCoordinate)	Prepare a GeoBoundingBoxQuery body.
static GeoDistanceQuery	geoDistance(double locationLon, double locationLat, String distance)	Prepare a GeoDistanceQuery body.
static GeoDistanceQuery	geoDistance(Coordinate locationCoordinate, String distance)	Prepare a GeoDistanceQuery body.
static GeoPolygonQuery	geoPolygon(List<Coordinate> coordinates)	Prepare a GeoPolygonQuery body.
protected abstract void	injectParams(JsonObject input)
void	injectParamsAndBoost(JsonObject input)
static MatchQuery	match(String match)	Prepare a MatchQuery body.
static MatchAllQuery	matchAll()	Prepare a MatchAllQuery body.
static MatchNoneQuery	matchNone()	Prepare a MatchNoneQuery body.
static MatchPhraseQuery	matchPhrase(String matchPhrase)	Prepare a MatchPhraseQuery body.
static NumericRangeQuery	numericRange()	Prepare a NumericRangeQuery body.
static PhraseQuery	phrase(String... terms)	Prepare a PhraseQuery body.
static PrefixQuery	prefix(String prefix)	Prepare a PrefixQuery body.
static QueryStringQuery	queryString(String query)	Prepare a QueryStringQuery body.
static RegexpQuery	regexp(String regexp)	Prepare a RegexpQuery body.
static TermQuery	term(String term)	Prepare a TermQuery body.
static TermRangeQuery	termRange()	Prepare a TermRangeQuery body.
String	toString()
static WildcardQuery	wildcard(String wildcard)	Prepare a WildcardQuery body.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchQuery

protected SearchQuery()

Method Details

boost

public SearchQuery boost(double boost)

injectParamsAndBoost

public void injectParamsAndBoost(JsonObject input)

injectParams

protected abstract void injectParams(JsonObject input)

export

public JsonObject export()

Exports the whole query as a JsonObject.

See Also:

for the part that deals with global parameters

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.

queryString

public static QueryStringQuery queryString(String query)

Prepare a QueryStringQuery body.

match

public static MatchQuery match(String match)

Prepare a MatchQuery body.

matchPhrase

public static MatchPhraseQuery matchPhrase(String matchPhrase)

Prepare a MatchPhraseQuery body.

prefix

public static PrefixQuery prefix(String prefix)

Prepare a PrefixQuery body.

regexp

public static RegexpQuery regexp(String regexp)

Prepare a RegexpQuery body.

termRange

public static TermRangeQuery termRange()

Prepare a TermRangeQuery body.

numericRange

public static NumericRangeQuery numericRange()

Prepare a NumericRangeQuery body.

dateRange

public static DateRangeQuery dateRange()

Prepare a DateRangeQuery body.

disjuncts

public static DisjunctionQuery disjuncts(SearchQuery... queries)

Prepare a DisjunctionQuery body.

conjuncts

public static ConjunctionQuery conjuncts(SearchQuery... queries)

Prepare a ConjunctionQuery body.

booleans

public static BooleanQuery booleans()

Prepare a BooleanQuery body.

wildcard

public static WildcardQuery wildcard(String wildcard)

Prepare a WildcardQuery body.

docId

public static DocIdQuery docId(String... docIds)

Prepare a DocIdQuery body.

booleanField

public static BooleanFieldQuery booleanField(boolean value)

Prepare a BooleanFieldQuery body.

term

public static TermQuery term(String term)

Prepare a TermQuery body.

phrase

public static PhraseQuery phrase(String... terms)

Prepare a PhraseQuery body.

matchAll

public static MatchAllQuery matchAll()

Prepare a MatchAllQuery body.

matchNone

public static MatchNoneQuery matchNone()

Prepare a MatchNoneQuery body.

geoBoundingBox

public static GeoBoundingBoxQuery geoBoundingBox(double topLeftLon,
double topLeftLat,
double bottomRightLon,
double bottomRightLat)

Prepare a GeoBoundingBoxQuery body.

geoBoundingBox

@Uncommitted
public static GeoBoundingBoxQuery geoBoundingBox(Coordinate topLeftCoordinate,
Coordinate bottomRightCoordinate)

Prepare a GeoBoundingBoxQuery body.

geoDistance

public static GeoDistanceQuery geoDistance(double locationLon,
double locationLat,
String distance)

Prepare a GeoDistanceQuery body.

geoDistance

@Uncommitted
public static GeoDistanceQuery geoDistance(Coordinate locationCoordinate,
String distance)

Prepare a GeoDistanceQuery body.

geoPolygon

@Uncommitted
public static GeoPolygonQuery geoPolygon(List<Coordinate> coordinates)

Prepare a GeoPolygonQuery body.