ai.grakn.graql.internal.pattern.property

Class RelationshipProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.RelationshipProperty

All Implemented Interfaces:

UniqueVarProperty, VarProperty, VarPropertyInternal

public abstract class RelationshipProperty
extends Object
implements UniqueVarProperty

Represents the relation property (e.g. ($x, $y) or (wife: $x, husband: $y)) on a Relationship. This property can be queried and inserted. This propert is comprised of instances of RelationPlayer, which represents associations between a role-player Thing and an optional Role.

Author:

Felix Chapman

Constructor Summary

Constructors

Constructor and Description
RelationshipProperty()

Method Summary

Modifier and Type	Method and Description
void	buildString(StringBuilder builder)
void	checkInsertable(VarPatternAdmin var) Check if the given property can be inserted
void	checkValid(GraknTx graph, VarPatternAdmin var) Check if the given property can be used in a Match
void	checkValidProperty(GraknTx graph, VarPatternAdmin var)
Collection<PropertyExecutor>	define(Var var)
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 RelationshipProperty	of(com.google.common.collect.ImmutableMultiset<RelationPlayer> relationPlayers)
abstract com.google.common.collect.ImmutableMultiset<RelationPlayer>	relationPlayers()
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.admin.UniqueVarProperty

isUnique

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

graqlString, implicitInnerVarPatterns

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

from, uniquelyIdentifiesConcept

Constructor Detail

RelationshipProperty

public RelationshipProperty()

Method Detail

of

public static RelationshipProperty of(com.google.common.collect.ImmutableMultiset<RelationPlayer> relationPlayers)

relationPlayers

public abstract com.google.common.collect.ImmutableMultiset<RelationPlayer> relationPlayers()

buildString

public void buildString(StringBuilder builder)

Specified by:

buildString in interface VarProperty

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

checkValidProperty

public void checkValidProperty(GraknTx graph,
                               VarPatternAdmin var)
                        throws GraqlQueryException

Throws:

GraqlQueryException

checkInsertable

public void checkInsertable(VarPatternAdmin var)
                     throws GraqlQueryException

Description copied from interface: VarPropertyInternal

Check if the given property can be inserted

Specified by:

checkInsertable 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

mapToAtom

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

Specified by:

mapToAtom 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

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

implicitInnerVarPatterns

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

Specified by:

implicitInnerVarPatterns in interface VarProperty

toString

public final String toString()

Overrides:

toString in class Object