Text (JanusGraph 0.3.1 API)

java.lang.Object
- java.lang.Enum<Text>
- - org.janusgraph.core.attribute.Text

All Implemented Interfaces:

Serializable, Comparable<Text>, BiPredicate<Object,Object>, JanusGraphPredicate
```
public enum Text
extends Enum<Text>
implements JanusGraphPredicate
```
Comparison relations for text objects. These comparisons are based on a tokenized representation of the text, i.e. the text is considered as a set of word tokens.

Author:

Matthias Broecheler (me@matthiasb.com)

Nested Class Summary
- Nested classes/interfaces inherited from interface org.janusgraph.graphdb.query.JanusGraphPredicate
  JanusGraphPredicate.Converter

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CONTAINS` Whether the text contains a given term as a token in the text (case insensitive)
`CONTAINS_FUZZY` Whether the text contains a token is at X Lenvenstein of a token (case insensitive) with X=: - 0 for strings of one or two characters - 1 for strings of three, four or five characters - 2 for strings of more than five characters
`CONTAINS_PREFIX` Whether the text contains a token that starts with a given term (case insensitive)
`CONTAINS_REGEX` Whether the text contains a token that matches a regular expression
`FUZZY` Whether the text is at X Lenvenstein of a token (case sensitive) with X=: - 0 for strings of one or two characters - 1 for strings of three, four or five characters - 2 for strings of more than five characters
`PREFIX` Whether the text starts with a given prefix (case sensitive)
`REGEX` Whether the text matches a regular expression (case sensitive)

Field Summary

Fields
Modifier and Type Field and Description

static Set<Text> HAS_CONTAINS

Fields
Modifier and Type	Field and Description
`static Set<Text>`	`HAS_CONTAINS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasNegation()` Whether this predicate has a predicate that is semantically its negation.
`boolean`	`isQNF()` Returns true if this predicate is in query normal form.
`boolean`	`isValidValueType(Class<?> clazz)` Whether the given class is a valid data type for a value to which this predicate may be applied.
`JanusGraphPredicate`	`negate()` Returns the negation of this predicate if it exists, otherwise an exception is thrown.
`void`	`preevaluate(Object value, Object condition)`
`static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V>`	`textContains(V value)`
`static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V>`	`textContainsFuzzy(V value)`
`static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V>`	`textContainsPrefix(V value)`
`static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V>`	`textContainsRegex(V value)`
`static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V>`	`textFuzzy(V value)`
`static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V>`	`textPrefix(V value)`
`static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V>`	`textRegex(V value)`
`static List<String>`	`tokenize(String str)`
`static Text`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Text[]`	`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 org.janusgraph.graphdb.query.JanusGraphPredicate
isValidCondition, test

Methods inherited from interface java.util.function.BiPredicate
and, or

- Enum Constant Detail
  - CONTAINS
```
public static final Text CONTAINS
```
    Whether the text contains a given term as a token in the text (case insensitive)
  - CONTAINS_PREFIX
```
public static final Text CONTAINS_PREFIX
```
    Whether the text contains a token that starts with a given term (case insensitive)
  - CONTAINS_REGEX
```
public static final Text CONTAINS_REGEX
```
    Whether the text contains a token that matches a regular expression
  - PREFIX
```
public static final Text PREFIX
```
    Whether the text starts with a given prefix (case sensitive)
  - REGEX
```
public static final Text REGEX
```
    Whether the text matches a regular expression (case sensitive)
  - FUZZY
```
public static final Text FUZZY
```
    Whether the text is at X Lenvenstein of a token (case sensitive) with X=: - 0 for strings of one or two characters - 1 for strings of three, four or five characters - 2 for strings of more than five characters
  - CONTAINS_FUZZY
```
public static final Text CONTAINS_FUZZY
```
    Whether the text contains a token is at X Lenvenstein of a token (case insensitive) with X=: - 0 for strings of one or two characters - 1 for strings of three, four or five characters - 2 for strings of more than five characters
- Field Detail
  - HAS_CONTAINS
```
public static final Set<Text> HAS_CONTAINS
```
- Method Detail
  - values
```
public static Text[] 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 (Text c : Text.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Text 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
  - preevaluate
```
public void preevaluate(Object value,
                        Object condition)
```
  - tokenize
```
public static List<String> tokenize(String str)
```
  - isValidValueType
```
public boolean isValidValueType(Class<?> clazz)
```
    Description copied from interface: JanusGraphPredicate
    
    Whether the given class is a valid data type for a value to which this predicate may be applied.
    For instance, the Cmp.GREATER_THAN can only be applied to Comparable values.
    
    Specified by:
    
    isValidValueType in interface JanusGraphPredicate
    
    Returns:
  - hasNegation
```
public boolean hasNegation()
```
    Description copied from interface: JanusGraphPredicate
    
    Whether this predicate has a predicate that is semantically its negation. For instance, Cmp.EQUAL and Cmp.NOT_EQUAL are negatives of each other.
    
    Specified by:
    
    hasNegation in interface JanusGraphPredicate
    
    Returns:
  - negate
```
public JanusGraphPredicate negate()
```
    Description copied from interface: JanusGraphPredicate
    
    Returns the negation of this predicate if it exists, otherwise an exception is thrown. Check JanusGraphPredicate.hasNegation() first.
    
    Specified by:
    
    negate in interface BiPredicate<Object,Object>
    
    Specified by:
    
    negate in interface JanusGraphPredicate
  - isQNF
```
public boolean isQNF()
```
    Description copied from interface: JanusGraphPredicate
    
    Returns true if this predicate is in query normal form.
    
    Specified by:
    
    isQNF in interface JanusGraphPredicate
    
    Returns:
  - textContains
```
public static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V> textContains(V value)
```
  - textContainsPrefix
```
public static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V> textContainsPrefix(V value)
```
  - textContainsRegex
```
public static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V> textContainsRegex(V value)
```
  - textPrefix
```
public static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V> textPrefix(V value)
```
  - textRegex
```
public static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V> textRegex(V value)
```
  - textContainsFuzzy
```
public static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V> textContainsFuzzy(V value)
```
  - textFuzzy
```
public static <V> org.apache.tinkerpop.gremlin.process.traversal.P<V> textFuzzy(V value)
```

Enum Text

Nested Class Summary

Nested classes/interfaces inherited from interface org.janusgraph.graphdb.query.JanusGraphPredicate

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.janusgraph.graphdb.query.JanusGraphPredicate

Methods inherited from interface java.util.function.BiPredicate

Enum Constant Detail

CONTAINS

CONTAINS_PREFIX

CONTAINS_REGEX

PREFIX

REGEX

FUZZY

CONTAINS_FUZZY

Field Detail

HAS_CONTAINS

Method Detail

values

valueOf

preevaluate

tokenize

isValidValueType

hasNegation

negate

isQNF

textContains

textContainsPrefix

textContainsRegex

textPrefix

textRegex

textContainsFuzzy

textFuzzy