org.opencypher.gremlin.translation.translator

Enum TranslatorFeature

java.lang.Object

java.lang.Enum<TranslatorFeature>

org.opencypher.gremlin.translation.translator.TranslatorFeature

All Implemented Interfaces:

Serializable, Comparable<TranslatorFeature>

public enum TranslatorFeature
extends Enum<TranslatorFeature>

Translator features are additional behaviors that can be allowed in translation. These need to be enabled individually when creating a Translator.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CYPHER_EXTENSIONS Support for custom functions and predicates provided by the CfoG Gremlin Server plugin.
EXPERIMENTAL_GREMLIN_FUNCTION Enables experimental `gremlin` Cypher function that allows including Gremlin steps in translated query
MULTIPLE_LABELS Support for specifying multiple labels for a vertex and matching by multiple labels.
RETURN_GREMLIN_ELEMENTS Return Gremlin graph elements (e.g Vertex, Edge) instead of normalizing elements to a map of tokens and properties (as by default).

Method Summary

Modifier and Type	Method and Description
static TranslatorFeature	valueOf(String name) Returns the enum constant of this type with the specified name.
static TranslatorFeature[]	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

Enum Constant Detail

CYPHER_EXTENSIONS

public static final TranslatorFeature CYPHER_EXTENSIONS

Support for custom functions and predicates provided by the CfoG Gremlin Server plugin.

MULTIPLE_LABELS

public static final TranslatorFeature MULTIPLE_LABELS

Support for specifying multiple labels for a vertex and matching by multiple labels.

RETURN_GREMLIN_ELEMENTS

public static final TranslatorFeature RETURN_GREMLIN_ELEMENTS

Return Gremlin graph elements (e.g Vertex, Edge) instead of normalizing elements to a map of tokens and properties (as by default).

EXPERIMENTAL_GREMLIN_FUNCTION

public static final TranslatorFeature EXPERIMENTAL_GREMLIN_FUNCTION

Enables experimental `gremlin` Cypher function that allows including Gremlin steps in translated query

Method Detail

values

public static TranslatorFeature[] 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 (TranslatorFeature c : TranslatorFeature.values())
    System.out.println(c);

Returns:

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

valueOf

public static TranslatorFeature 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