Package com.couchbase.lite

Class FullTextFunction

  • public final class FullTextFunction
extends java.lang.Object
    Full-text functions.

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static Expression match​(IndexExpression index, java.lang.String query)
      Creates a full-text match() function with the given full-text index expression and the query text
      static Expression match​(java.lang.String indexName, java.lang.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​(java.lang.String indexName)
      Deprecated.
      Use: FullTextFunction.rank(IndexExpression)

      • Methods inherited from class java.lang.Object

        equals, 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
                               java.lang.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
                              java.lang.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
                               java.lang.String indexName,
                               @NonNull
                               java.lang.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