ai.grakn.graql.internal.gremlin

Enum FragmentPriority

java.lang.Object

java.lang.Enum<FragmentPriority>

ai.grakn.graql.internal.gremlin.FragmentPriority

All Implemented Interfaces:

Serializable, Comparable<FragmentPriority>

public enum FragmentPriority
extends Enum<FragmentPriority>

represents the priority of a Fragment.

Higher priority patterns are expected to be more efficient and better filter the query and are executed first.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTINCT_CASTING Confirming that castings are all distinct
EDGE_BOUNDED Moving along an edge, where a concept can be expected to have a small number bounded by the ontology (e.g.
EDGE_RELATION Moving along a relation edge, where a concept can be expected to have a large number of relations.
EDGE_UNBOUNDED Moving along an edge that a concept may have a HUGE number of, e.g.
EDGE_UNIQUE Moving along an edge, where a concept can be expected to have at most one (e.g.
ID Looking up by ID.
NOT_CASTING The identity step, that does nothing
VALUE_NONSPECIFIC Looking up things by non-specific values.
VALUE_SPECIFIC Looking up things by value.

Method Summary

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

VALUE_SPECIFIC

public static final FragmentPriority VALUE_SPECIFIC

Looking up things by value. Values are non-unique so this is only slightly slower than lookup by ID

ID

public static final FragmentPriority ID

Looking up by ID. Because types are often super-nodes and are usually referred to by ID, it is usually better to start from an instance (looked up by value) than from a type (looked up by ID) if possible.

VALUE_NONSPECIFIC

public static final FragmentPriority VALUE_NONSPECIFIC

Looking up things by non-specific values. This includes predicates (e.g. 'value > 100') and very short strings, which are assumed to be common.

EDGE_UNIQUE

public static final FragmentPriority EDGE_UNIQUE

Moving along an edge, where a concept can be expected to have at most one (e.g. ISA, SUB)

EDGE_BOUNDED

public static final FragmentPriority EDGE_BOUNDED

Moving along an edge, where a concept can be expected to have a small number bounded by the ontology (e.g. PLAYS_ROLE, HAS_ROLE)

EDGE_RELATION

public static final FragmentPriority EDGE_RELATION

Moving along a relation edge, where a concept can be expected to have a large number of relations.

EDGE_UNBOUNDED

public static final FragmentPriority EDGE_UNBOUNDED

Moving along an edge that a concept may have a HUGE number of, e.g. all instances of a type

DISTINCT_CASTING

public static final FragmentPriority DISTINCT_CASTING

Confirming that castings are all distinct

NOT_CASTING

public static final FragmentPriority NOT_CASTING

The identity step, that does nothing

Method Detail

values

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

Returns:

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

valueOf

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