ai.grakn.graql.internal.gremlin.sets

Class EquivalentFragmentSets

java.lang.Object

ai.grakn.graql.internal.gremlin.sets.EquivalentFragmentSets

public class EquivalentFragmentSets
extends Object

Factory class for producing instances of EquivalentFragmentSet.

Author:

Felix Chapman

Constructor Summary

Constructors

Constructor and Description
EquivalentFragmentSets()

Method Summary

Modifier and Type	Method and Description
static EquivalentFragmentSet	dataType(VarProperty varProperty, Var resourceType, ResourceType.DataType<?> dataType) An EquivalentFragmentSet that indicates a variable representing a resource type with a data-type.
static EquivalentFragmentSet	hasScope(VarProperty varProperty, Var relation, Var scope) An EquivalentFragmentSet that indicates a variable is a relation with a scope.
static EquivalentFragmentSet	id(VarProperty varProperty, Var start, ConceptId id) An EquivalentFragmentSet that indicates a variable representing a concept with a particular ID.
static EquivalentFragmentSet	isa(VarProperty varProperty, Var instance, Var type) An EquivalentFragmentSet that indicates a variable is an instance of a type.
static EquivalentFragmentSet	isAbstract(VarProperty varProperty, Var start) An EquivalentFragmentSet that indicates a variable represents an abstract type.
static EquivalentFragmentSet	label(VarProperty varProperty, Var type, Label label) An EquivalentFragmentSet that indicates a variable representing a type with a particular label.
static EquivalentFragmentSet	neq(VarProperty varProperty, Var varA, Var varB) An EquivalentFragmentSet that indicates a variable is not equal to another variable.
static EquivalentFragmentSet	notInternalFragmentSet(VarProperty varProperty, Var start) An EquivalentFragmentSet that indicates a variable is not a casting or a shard.
static void	optimiseFragmentSets(Collection<EquivalentFragmentSet> fragmentSets, GraknGraph graph) Modify the given collection of EquivalentFragmentSet to introduce certain optimisations, such as the ResourceIndexFragmentSet.
static EquivalentFragmentSet	plays(VarProperty varProperty, Var type, Var roleType, boolean required) An EquivalentFragmentSet that indicates a variable is a type whose instances play a role.
static EquivalentFragmentSet	regex(VarProperty varProperty, Var resourceType, String regex) An EquivalentFragmentSet that indicates a resource type whose instances must conform to a given regex.
static EquivalentFragmentSet	relates(VarProperty varProperty, Var relationType, Var roleType) An EquivalentFragmentSet that indicates a variable is a relation type which involves a role.
static EquivalentFragmentSet	shortcut(VarProperty varProperty, Var relation, Var edge, Var rolePlayer, Optional<Var> roleType) An EquivalentFragmentSet that indicates a shortcut edge between two role-players.
static EquivalentFragmentSet	sub(VarProperty varProperty, Var subType, Var superType) An EquivalentFragmentSet that indicates a variable is a sub-type of another variable.
static EquivalentFragmentSet	value(VarProperty varProperty, Var resource, ValuePredicateAdmin predicate) An EquivalentFragmentSet that indicates a variable represents a resource with value matching a predicate.

Methods inherited from class java.lang.Object

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

Constructor Detail

EquivalentFragmentSets

public EquivalentFragmentSets()

Method Detail

plays

public static EquivalentFragmentSet plays(VarProperty varProperty,
                                          Var type,
                                          Var roleType,
                                          boolean required)

An EquivalentFragmentSet that indicates a variable is a type whose instances play a role.

Parameters:

type - a type variable label

roleType - a role type variable label

required - whether the plays must be constrained to be "required"

shortcut

public static EquivalentFragmentSet shortcut(VarProperty varProperty,
                                             Var relation,
                                             Var edge,
                                             Var rolePlayer,
                                             Optional<Var> roleType)

An EquivalentFragmentSet that indicates a shortcut edge between two role-players.

sub

public static EquivalentFragmentSet sub(VarProperty varProperty,
                                        Var subType,
                                        Var superType)

An EquivalentFragmentSet that indicates a variable is a sub-type of another variable.

hasScope

public static EquivalentFragmentSet hasScope(VarProperty varProperty,
                                             Var relation,
                                             Var scope)

An EquivalentFragmentSet that indicates a variable is a relation with a scope.

relates

public static EquivalentFragmentSet relates(VarProperty varProperty,
                                            Var relationType,
                                            Var roleType)

An EquivalentFragmentSet that indicates a variable is a relation type which involves a role.

notInternalFragmentSet

public static EquivalentFragmentSet notInternalFragmentSet(VarProperty varProperty,
                                                           Var start)

An EquivalentFragmentSet that indicates a variable is not a casting or a shard.

isa

public static EquivalentFragmentSet isa(VarProperty varProperty,
                                        Var instance,
                                        Var type)

An EquivalentFragmentSet that indicates a variable is an instance of a type.

neq

public static EquivalentFragmentSet neq(VarProperty varProperty,
                                        Var varA,
                                        Var varB)

An EquivalentFragmentSet that indicates a variable is not equal to another variable.

value

public static EquivalentFragmentSet value(VarProperty varProperty,
                                          Var resource,
                                          ValuePredicateAdmin predicate)

An EquivalentFragmentSet that indicates a variable represents a resource with value matching a predicate.

id

public static EquivalentFragmentSet id(VarProperty varProperty,
                                       Var start,
                                       ConceptId id)

An EquivalentFragmentSet that indicates a variable representing a concept with a particular ID.

isAbstract

public static EquivalentFragmentSet isAbstract(VarProperty varProperty,
                                               Var start)

An EquivalentFragmentSet that indicates a variable represents an abstract type.

label

public static EquivalentFragmentSet label(VarProperty varProperty,
                                          Var type,
                                          Label label)

An EquivalentFragmentSet that indicates a variable representing a type with a particular label.

dataType

public static EquivalentFragmentSet dataType(VarProperty varProperty,
                                             Var resourceType,
                                             ResourceType.DataType<?> dataType)

An EquivalentFragmentSet that indicates a variable representing a resource type with a data-type.

regex

public static EquivalentFragmentSet regex(VarProperty varProperty,
                                          Var resourceType,
                                          String regex)

An EquivalentFragmentSet that indicates a resource type whose instances must conform to a given regex.

optimiseFragmentSets

public static void optimiseFragmentSets(Collection<EquivalentFragmentSet> fragmentSets,
                                        GraknGraph graph)

Modify the given collection of EquivalentFragmentSet to introduce certain optimisations, such as the ResourceIndexFragmentSet.

This involves substituting various EquivalentFragmentSet with other EquivalentFragmentSet.