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, AttributeType.DataType<?> dataType) An EquivalentFragmentSet that indicates a variable representing a resource type with a data-type.
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, boolean mayHaveEdgeInstances) An EquivalentFragmentSet that indicates a variable is a direct 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, com.google.common.collect.ImmutableSet<Label> labels) An EquivalentFragmentSet that indicates a variable representing a schema concept with one of the specified labels.
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, GraknTx graph) Modify the given collection of EquivalentFragmentSet to introduce certain optimisations, such as the AttributeIndexFragmentSet.
static EquivalentFragmentSet	plays(VarProperty varProperty, Var type, Var role, 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 role) An EquivalentFragmentSet that indicates a variable is a relation type which involves a role.
static EquivalentFragmentSet	rolePlayer(VarProperty varProperty, Var relation, Var edge, Var rolePlayer, Var role) Describes the edge connecting a Relationship to a role-player.
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, ValuePredicate 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 role,
                                          boolean required)

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

Parameters:

type - a type variable label

role - a role variable label

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

rolePlayer

public static EquivalentFragmentSet rolePlayer(VarProperty varProperty,
                                               Var relation,
                                               Var edge,
                                               Var rolePlayer,
                                               @Nullable
                                               Var role)

Describes the edge connecting a Relationship to a role-player.

Can be constrained with information about the possible Roles or RelationshipTypes.

sub

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

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

relates

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

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,
                                        boolean mayHaveEdgeInstances)

An EquivalentFragmentSet that indicates a variable is a direct 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,
                                          ValuePredicate 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,
                                          com.google.common.collect.ImmutableSet<Label> labels)

An EquivalentFragmentSet that indicates a variable representing a schema concept with one of the specified labels.

dataType

public static EquivalentFragmentSet dataType(VarProperty varProperty,
                                             Var resourceType,
                                             AttributeType.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,
                                        GraknTx graph)

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

This involves substituting various EquivalentFragmentSet with other EquivalentFragmentSet.