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	casting(VarName relation, VarName casting) An EquivalentFragmentSet that indicates a variable is a relation with a casting.
static EquivalentFragmentSet	dataType(VarName resourceType, ResourceType.DataType<?> dataType) An EquivalentFragmentSet that indicates a variable representing a resource type with a data-type.
static EquivalentFragmentSet	distinctCasting(VarName castingA, VarName castingB) An EquivalentFragmentSet that indicates two castings are unique
static EquivalentFragmentSet	hasScope(VarName relation, VarName scope) An EquivalentFragmentSet that indicates a variable is a relation with a scope.
static EquivalentFragmentSet	id(VarName start, ConceptId id) An EquivalentFragmentSet that indicates a variable representing a concept with a particular ID.
static EquivalentFragmentSet	isa(VarName instance, VarName type) An EquivalentFragmentSet that indicates a variable is an instance of a type.
static EquivalentFragmentSet	isAbstract(VarName start) An EquivalentFragmentSet that indicates a variable represents an abstract type.
static EquivalentFragmentSet	isaCastings(VarName casting, VarName roleType) An EquivalentFragmentSet that indicates a variable is an instance of a role-type.
static EquivalentFragmentSet	label(VarName type, TypeLabel label) An EquivalentFragmentSet that indicates a variable representing a type with a particular label.
static EquivalentFragmentSet	neq(VarName varA, VarName varB) An EquivalentFragmentSet that indicates a variable is not equal to another variable.
static EquivalentFragmentSet	notCasting(VarName start) An EquivalentFragmentSet that indicates a variable is not a casting.
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(VarName type, VarName roleType, boolean required) An EquivalentFragmentSet that indicates a variable is a type whose instances play a role.
static EquivalentFragmentSet	regex(VarName resourceType, String regex) An EquivalentFragmentSet that indicates a resource type whose instances must conform to a given regex.
static EquivalentFragmentSet	relates(VarName relationType, VarName roleType) An EquivalentFragmentSet that indicates a variable is a relation type which involves a role.
static EquivalentFragmentSet	rolePlayer(VarName casting, VarName rolePlayer) An EquivalentFragmentSet that indicates a variable is a casting connected to a role-player.
static EquivalentFragmentSet	shortcut(Optional<TypeLabel> roleTypeA, VarName rolePlayerA, Optional<TypeLabel> roleTypeB, VarName rolePlayerB, Optional<TypeLabel> relationType) An EquivalentFragmentSet that indicates a shortcut edge between two role-players.
static EquivalentFragmentSet	sub(VarName subType, VarName superType) An EquivalentFragmentSet that indicates a variable is a sub-type of another variable.
static EquivalentFragmentSet	value(VarName 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

distinctCasting

public static EquivalentFragmentSet distinctCasting(VarName castingA,
                                                    VarName castingB)

An EquivalentFragmentSet that indicates two castings are unique

plays

public static EquivalentFragmentSet plays(VarName type,
                                          VarName 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"

casting

public static EquivalentFragmentSet casting(VarName relation,
                                            VarName casting)

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

rolePlayer

public static EquivalentFragmentSet rolePlayer(VarName casting,
                                               VarName rolePlayer)

An EquivalentFragmentSet that indicates a variable is a casting connected to a role-player.

isaCastings

public static EquivalentFragmentSet isaCastings(VarName casting,
                                                VarName roleType)

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

shortcut

public static EquivalentFragmentSet shortcut(Optional<TypeLabel> roleTypeA,
                                             VarName rolePlayerA,
                                             Optional<TypeLabel> roleTypeB,
                                             VarName rolePlayerB,
                                             Optional<TypeLabel> relationType)

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

Parameters:

roleTypeA - an optional role-type for

rolePlayerA - a role-player variable label

roleTypeB - an optional role-type for

rolePlayerB - a role-player variable label

relationType - an optional relation-type for the shortcut

sub

public static EquivalentFragmentSet sub(VarName subType,
                                        VarName superType)

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

hasScope

public static EquivalentFragmentSet hasScope(VarName relation,
                                             VarName scope)

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

relates

public static EquivalentFragmentSet relates(VarName relationType,
                                            VarName roleType)

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

notCasting

public static EquivalentFragmentSet notCasting(VarName start)

An EquivalentFragmentSet that indicates a variable is not a casting.

isa

public static EquivalentFragmentSet isa(VarName instance,
                                        VarName type)

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

neq

public static EquivalentFragmentSet neq(VarName varA,
                                        VarName varB)

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

value

public static EquivalentFragmentSet value(VarName resource,
                                          ValuePredicateAdmin predicate)

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

id

public static EquivalentFragmentSet id(VarName start,
                                       ConceptId id)

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

isAbstract

public static EquivalentFragmentSet isAbstract(VarName start)

An EquivalentFragmentSet that indicates a variable represents an abstract type.

label

public static EquivalentFragmentSet label(VarName type,
                                          TypeLabel label)

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

dataType

public static EquivalentFragmentSet dataType(VarName resourceType,
                                             ResourceType.DataType<?> dataType)

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

regex

public static EquivalentFragmentSet regex(VarName 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.