Package com.couchbase.lite

Class FullTextFunction

java.lang.Object

com.couchbase.lite.FullTextFunction

public final class FullTextFunction
extends java.lang.Object

Full-text function.

Method Summary

Modifier and Type	Method	Description
static Expression	match(java.lang.String indexName, java.lang.String text)	Creates a full-text expression with the given full-text index name and search text.
static Expression	rank(java.lang.String indexName)	Creates a full-text rank function with the given full-text index name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

match

@NonNull
public static Expression match(@NonNull
                               java.lang.String indexName,
                               @NonNull
                               java.lang.String text)

Creates a full-text expression with the given full-text index name and search text.

Parameters:

indexName - The full-text index name.

text - The search text

Returns:

The full-text match expression

rank

@NonNull
public static Expression rank(@NonNull
                              java.lang.String indexName)

Creates a full-text rank function with the given full-text index name. The rank function indicates how well the current query result matches the full-text query when performing the match comparison.

Parameters:

indexName - The index name.

Returns:

The full-text rank function.