com.datastax.dse.graph.internal

Enum SearchPredicate

java.lang.Object

java.lang.Enum<SearchPredicate>

com.datastax.dse.graph.internal.SearchPredicate

All Implemented Interfaces:

DsePredicate, Serializable, Comparable<SearchPredicate>, BiPredicate<Object,Object>

public enum SearchPredicate
extends Enum<SearchPredicate>
implements DsePredicate

List of predicates for geolocation usage with DseGraph and Search indexes. Should not be accessed directly but through the Search static methods.

Enum Constant Summary

Enum Constants

Enum Constant and Description
fuzzy Whether the text is within a given edit distance from the given term (case sensitive).
phrase Whether tokenized text contains a given phrase, optionally within a given proximity (case insensitive).
prefix Whether the text starts with a given prefix (case sensitive).
regex Whether the text matches a regular expression (case sensitive).
token Whether the text contains a given term as a token in the text (case insensitive).
tokenFuzzy Whether some token in the text is within a given edit distance from the given term (case insensitive).
tokenPrefix Whether the text contains a token that starts with a given term (case insensitive).
tokenRegex Whether the text contains a token that matches a regular expression (case insensitive).

Method Summary

Modifier and Type	Method and Description
static SearchPredicate	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchPredicate[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.datastax.dse.graph.internal.DsePredicate

isValidCondition, preEvaluate

Methods inherited from interface java.util.function.BiPredicate

and, negate, or, test

Enum Constant Detail

token

public static final SearchPredicate token

Whether the text contains a given term as a token in the text (case insensitive).

tokenPrefix

public static final SearchPredicate tokenPrefix

Whether the text contains a token that starts with a given term (case insensitive).

tokenRegex

public static final SearchPredicate tokenRegex

Whether the text contains a token that matches a regular expression (case insensitive).

tokenFuzzy

public static final SearchPredicate tokenFuzzy

Whether some token in the text is within a given edit distance from the given term (case insensitive).

prefix

public static final SearchPredicate prefix

Whether the text starts with a given prefix (case sensitive).

regex

public static final SearchPredicate regex

Whether the text matches a regular expression (case sensitive).

fuzzy

public static final SearchPredicate fuzzy

Whether the text is within a given edit distance from the given term (case sensitive).

phrase

public static final SearchPredicate phrase

Whether tokenized text contains a given phrase, optionally within a given proximity (case insensitive).

Method Detail

values

public static SearchPredicate[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SearchPredicate c : SearchPredicate.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchPredicate valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null