Package com.couchbase.lite

Class FullTextFunction

java.lang.Object

com.couchbase.lite.FullTextFunction

public final class FullTextFunction
extends Object

Full-text functions.

Method Summary

Modifier and Type	Method	Description
static Expression	match(IndexExpression index, String query)	Creates a full-text match() function with the given full-text index expression and the query text
static Expression	match(String indexName, String query)	Deprecated. Use: FullTextFunction.match(IndexExpression)
static Expression	rank(IndexExpression index)	Creates a full-text rank function with the given full-text index expression.
static Expression	rank(String indexName)	Deprecated. Use: FullTextFunction.rank(IndexExpression)

Methods inherited from class java.lang.Object

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

Method Detail

rank

@NonNull
public static Expression rank(@NonNull
                              IndexExpression index)

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

Parameters:

index - The full-text index expression.

Returns:

The full-text rank function.

match

@NonNull
public static Expression match(@NonNull
                               IndexExpression index,
                               @NonNull
                               String query)

Creates a full-text match() function with the given full-text index expression and the query text

Parameters:

index - The full-text index expression.

query - The query string.

Returns:

The full-text match() function expression.

rank

@Deprecated
@NonNull
public static Expression rank(@NonNull
                              String indexName)

Deprecated.

Use: FullTextFunction.rank(IndexExpression)

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.

match

@Deprecated
@NonNull
public static Expression match(@NonNull
                               String indexName,
                               @NonNull
                               String query)

Deprecated.

Use: FullTextFunction.match(IndexExpression)

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

Parameters:

indexName - The full-text index name.

query - The query string.

Returns:

The full-text match expression