com.couchbase.client.java.search.util

Class SearchUtils

java.lang.Object

com.couchbase.client.java.search.util.SearchUtils

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public class SearchUtils
extends Object

Utility class around FTS (Full Text Search), and especially handling of the default FTS date format (which corresponds to RFC 3339).

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Constructor and Description
SearchUtils()

Method Summary

Modifier and Type	Method and Description
static Date	fromFtsString(String date) Attempts to convert a date string, as returned by the FTS service, into a Date.
static String	toFtsUtcString(Date date) Converts a date to the default string representation in FTS (RFC 3339).

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchUtils

public SearchUtils()

Method Detail

toFtsUtcString

public static String toFtsUtcString(Date date)

Converts a date to the default string representation in FTS (RFC 3339).

Parameters:

date - the Date to convert.

Returns:

the RFC 3339 representation of the date, in UTC timezone (eg. “2016-01-19T14:44:01Z”)

fromFtsString

public static Date fromFtsString(String date)

Attempts to convert a date string, as returned by the FTS service, into a Date.

The FTS service is expected to return date strings in RFC 3339 format, including the timezone information. For example: 2016-01-10T14:44:01-08:00 for a date in the UTC-8/PDT timezone.

Parameters:

date - the date in RFC 3339 format.

Returns:

the corresponding Date.

Throws:

CouchbaseException - when the date could not be parsed.