PrefixQuery (Couchbase Java SDK)

java.lang.Object

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

com.couchbase.client.java.search.queries.PrefixQuery

@Uncommitted
@Public
public class PrefixQuery
extends AbstractFtsQuery

A FTS query that allows for simple matching on a given prefix.

Since:: 2.3.0
Author:: Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Constructor Description

PrefixQuery(String prefix)

Method Summary

Modifier and Type	Method	Description
`PrefixQuery`	`boost(double boost)`
`PrefixQuery`	`field(String field)`
`protected void`	`injectParams(JsonObject input)`	Override to inject query-specific parameters when doing the `SearchQuery.export()`.

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 Details
- PrefixQuery
  
  public PrefixQuery(String prefix)
Method Details
- field
  
  public PrefixQuery field(String field)
- boost
  
  public PrefixQuery 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.