ai.grakn.graql.internal.pattern.property

Class PlaysProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.PlaysProperty

All Implemented Interfaces:

VarProperty, VarPropertyInternal

public abstract class PlaysProperty
extends Object

Reperesents the plays property on a Type. This property relates a Type and a Role. It indicates that an Thing whose type is this Type is permitted to be a role-player playing the role of the given Role.

Author:

Felix Chapman

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
PlaysProperty()

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()
String	getProperty()
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 PlaysProperty	of(VarPatternAdmin role, boolean required)
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

checkInsertable, checkValid, from, insert, uniquelyIdentifiesConcept

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

graqlString, implicitInnerVarPatterns, isUnique

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

PlaysProperty

public PlaysProperty()

Method Detail

of

public static PlaysProperty of(VarPatternAdmin role,
                               boolean required)

getName

public String getName()

getProperty

public String getProperty()

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

Specified by:

match in interface VarPropertyInternal

getTypes

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

Specified by:

getTypes in interface VarProperty

innerVarPatterns

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

Specified by:

innerVarPatterns in interface VarProperty

Specified by:

innerVarPatterns in interface VarPropertyInternal

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)

Specified by:

mapToAtom in interface VarProperty

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

implicitInnerVarPatterns

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

Specified by:

implicitInnerVarPatterns in interface VarProperty

toString

public final String toString()

Overrides:

toString in class Object