ai.grakn.graql.internal.pattern.property

Class RelatesProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.RelatesProperty

All Implemented Interfaces:

VarProperty, VarPropertyInternal

public abstract class RelatesProperty
extends Object

Represents the relates property on a RelationshipType.

This property can be queried, inserted or deleted.

This property relates a RelationshipType and a Role. It indicates that a Relationship whose type is this RelationshipType may have a role-player playing the given Role.

Author:

Felix Chapman

Constructor Summary

Constructors

Constructor and Description
RelatesProperty()

Method Summary

Modifier and Type	Method and Description
void	buildString(StringBuilder builder)
void	checkValid(GraknTx graph, VarPatternAdmin var) Check if the given property can be used in a Match
Collection<PropertyExecutor>	define(Var var)
String	getName()
java.util.stream.Stream<VarPatternAdmin>	getTypes()
java.util.stream.Stream<VarPatternAdmin>	implicitInnerVarPatterns()
java.util.stream.Stream<VarPatternAdmin>	innerVarPatterns()
Collection<PropertyExecutor>	insert(Var var) Returns a PropertyExecutor that describes how to insert the given VarProperty into.
Atomic	mapToAtom(VarPatternAdmin var, Set<VarPatternAdmin> vars, ReasonerQuery parent)
Collection<EquivalentFragmentSet>	match(Var start) Return a collection of EquivalentFragmentSet to match the given property in the graph
static RelatesProperty	of(VarPatternAdmin role)
static RelatesProperty	of(VarPatternAdmin role, VarPatternAdmin superRole)
String	toString()
Collection<PropertyExecutor>	undefine(Var var)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.graql.internal.pattern.property.VarPropertyInternal

from, uniquelyIdentifiesConcept

Methods inherited from interface ai.grakn.graql.admin.VarProperty

graqlString, isUnique

Constructor Detail

RelatesProperty

public RelatesProperty()

Method Detail

of

public static RelatesProperty of(VarPatternAdmin role,
                                 @Nullable
                                 VarPatternAdmin superRole)

of

public static RelatesProperty of(VarPatternAdmin role)

getName

public String getName()

buildString

public void buildString(StringBuilder builder)

match

public Collection<EquivalentFragmentSet> match(Var start)

Description copied from interface: VarPropertyInternal

Return a collection of EquivalentFragmentSet to match the given property in the graph

getTypes

public java.util.stream.Stream<VarPatternAdmin> getTypes()

Specified by:

getTypes in interface VarProperty

innerVarPatterns

public java.util.stream.Stream<VarPatternAdmin> innerVarPatterns()

define

public Collection<PropertyExecutor> define(Var var)
                                    throws GraqlQueryException

Specified by:

define in interface VarPropertyInternal

Throws:

GraqlQueryException

undefine

public Collection<PropertyExecutor> undefine(Var var)
                                      throws GraqlQueryException

Specified by:

undefine in interface VarPropertyInternal

Throws:

GraqlQueryException

mapToAtom

public Atomic mapToAtom(VarPatternAdmin var,
                        Set<VarPatternAdmin> vars,
                        ReasonerQuery parent)

checkValid

public final void checkValid(GraknTx graph,
                             VarPatternAdmin var)
                      throws GraqlQueryException

Description copied from interface: VarPropertyInternal

Check if the given property can be used in a Match

Specified by:

checkValid in interface VarPropertyInternal

Throws:

GraqlQueryException

insert

public Collection<PropertyExecutor> insert(Var var)
                                    throws GraqlQueryException

Description copied from interface: VarPropertyInternal

Returns a PropertyExecutor that describes how to insert the given VarProperty into.

Specified by:

insert in interface VarPropertyInternal

Throws:

GraqlQueryException - if this VarProperty cannot be inserted

implicitInnerVarPatterns

public java.util.stream.Stream<VarPatternAdmin> implicitInnerVarPatterns()

Specified by:

implicitInnerVarPatterns in interface VarProperty

toString

public final String toString()

Overrides:

toString in class Object