ai.grakn.graql.internal.pattern.property

Class RelationProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.RelationProperty

All Implemented Interfaces:

UniqueVarProperty, VarProperty, VarPropertyInternal

public class RelationProperty
extends Object
implements UniqueVarProperty

Represents the relation property (e.g. ($x, $y) or (wife: $x, husband: $y)) on a Relation. 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
RelationProperty(com.google.common.collect.ImmutableMultiset<RelationPlayer> relationPlayers)

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(GraknGraph graph, VarPatternAdmin var) Check if the given property can be used in a match query
void	checkValidProperty(GraknGraph graph, VarPatternAdmin var)
void	delete(GraknGraph graph, Concept concept) Delete the given property from the graph, if possible.
boolean	equals(Object o)
java.util.stream.Stream<VarPatternAdmin>	getImplicitInnerVars()
java.util.stream.Stream<VarPatternAdmin>	getInnerVars()
java.util.stream.Stream<RelationPlayer>	getRelationPlayers()
java.util.stream.Stream<VarPatternAdmin>	getTypes()
int	hashCode()
void	insert(InsertQueryExecutor insertQueryExecutor, Concept concept) Insert the given property into the graph, if possible.
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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

isUnique

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

getImplicitInnerVars, graqlString

Constructor Detail

RelationProperty

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

Method Detail

getRelationPlayers

public java.util.stream.Stream<RelationPlayer> getRelationPlayers()

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

getInnerVars

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

Specified by:

getInnerVars in interface VarProperty

Specified by:

getInnerVars in interface VarPropertyInternal

checkValidProperty

public void checkValidProperty(GraknGraph 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 void insert(InsertQueryExecutor insertQueryExecutor,
                   Concept concept)
            throws GraqlQueryException

Description copied from interface: VarPropertyInternal

Insert the given property into the graph, if possible.

Specified by:

insert in interface VarPropertyInternal

Parameters:

insertQueryExecutor - the instance handling the insert query

concept - the concept to insert a property on

Throws:

GraqlQueryException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

mapToAtom

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

Specified by:

mapToAtom in interface VarProperty

checkValid

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

Description copied from interface: VarPropertyInternal

Check if the given property can be used in a match query

Specified by:

checkValid in interface VarPropertyInternal

Throws:

GraqlQueryException

delete

public void delete(GraknGraph graph,
                   Concept concept)

Description copied from interface: VarPropertyInternal

Delete the given property from the graph, if possible.

Specified by:

delete in interface VarPropertyInternal

Parameters:

graph - the graph to operate on

concept - the concept to delete properties of

getImplicitInnerVars

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

Specified by:

getImplicitInnerVars in interface VarProperty