ai.grakn.graql.internal.pattern.property

Class WhenProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.RuleProperty

ai.grakn.graql.internal.pattern.property.WhenProperty

All Implemented Interfaces:

UniqueVarProperty, VarProperty, VarPropertyInternal

public abstract class WhenProperty
extends RuleProperty

Represents the when property on a Rule. This property can be inserted and not queried. The when side describes the left-hand of an implication, stating that when the when side of a rule is true the then side must hold.

Author:

Felix Chapman

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
WhenProperty()

Method Summary

Modifier and Type	Method and Description
default 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()
Collection<PropertyExecutor>	insert(Var var) Returns a PropertyExecutor that describes how to insert the given VarProperty into.
static WhenProperty	of(Pattern pattern)
String	toString()
Collection<PropertyExecutor>	undefine(Var var)

Methods inherited from class ai.grakn.graql.internal.pattern.property.RuleProperty

getProperty, mapToAtom, match, pattern

Methods inherited from class java.lang.Object

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

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

isUnique

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

checkInsertable, checkValid, from, innerVarPatterns, insert, undefine, uniquelyIdentifiesConcept

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

getTypes, graqlString, implicitInnerVarPatterns

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

WhenProperty

public WhenProperty()

Method Detail

of

public static WhenProperty of(Pattern pattern)

getName

public String getName()

define

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

Specified by:

define in interface VarPropertyInternal

Throws:

GraqlQueryException

buildString

public void buildString(StringBuilder builder)

Specified by:

buildString in interface VarProperty

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

undefine

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

Specified by:

undefine in interface VarPropertyInternal

Throws:

GraqlQueryException

getTypes

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

Specified by:

getTypes in interface VarProperty

implicitInnerVarPatterns

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

Specified by:

implicitInnerVarPatterns in interface VarProperty

toString

public final String toString()

Overrides:

toString in class Object