ai.grakn.kb.internal.concept

Class RelationshipEdge

java.lang.Object

ai.grakn.kb.internal.concept.RelationshipEdge

All Implemented Interfaces:

CacheOwner

public class RelationshipEdge
extends Object
implements CacheOwner

Encapsulates The Relationship as a EdgeElement

This wraps up a Relationship as a EdgeElement. It is used to represent any binary Relationship. This also includes the ability to automatically reify a RelationshipEdge into a RelationshipReified.

Author:

fppt

Method Summary

Modifier and Type	Method and Description
Map<Role,Set<Thing>>	allRolePlayers()
Collection<Cache>	caches()
static RelationshipEdge	create(RelationshipType relationshipType, Role ownerRole, Role valueRole, EdgeElement edgeElement)
void	delete() Deletes the VertexElement or EdgeElement used to represent this Relationship
static RelationshipEdge	get(EdgeElement edgeElement)
ConceptId	id()
boolean	isDeleted() Return whether the relationship has been deleted.
boolean	isInferred() Used to indicate if this Relationship has been created as the result of a Rule inference.
boolean	isReified()
Keyspace	keyspace() Used for determining which Keyspace a RelationshipStructure was created in and is bound to.
Thing	owner()
Role	ownerRole()
RelationshipReified	reify()
java.util.stream.Stream<Thing>	rolePlayers(Role... roles)
String	toString()
RelationshipType	type()
Thing	value()
Role	valueRole()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.kb.internal.cache.CacheOwner

from, registerCache, txCacheClear, txCacheFlush

Method Detail

get

public static RelationshipEdge get(EdgeElement edgeElement)

create

public static RelationshipEdge create(RelationshipType relationshipType,
                                      Role ownerRole,
                                      Role valueRole,
                                      EdgeElement edgeElement)

id

public ConceptId id()

Returns:

The ConceptId of the Relationship

keyspace

public Keyspace keyspace()

Used for determining which Keyspace a RelationshipStructure was created in and is bound to.

Returns:

The Keyspace this RelationshipStructure belongs to.

reify

public RelationshipReified reify()

Returns:

The relation structure which has been reified

isReified

public boolean isReified()

Returns:

true if the Relationship has been reified meaning it can support n-ary relationships

type

public RelationshipType type()

Returns:

The RelationshipType of the Relationship

allRolePlayers

public Map<Role,Set<Thing>> allRolePlayers()

Returns:

All the Roles and the Things which play them

rolePlayers

public java.util.stream.Stream<Thing> rolePlayers(Role... roles)

Parameters:

roles - The Roles which are played in this relation

Returns:

The Things which play those Roles

ownerRole

public Role ownerRole()

owner

public Thing owner()

valueRole

public Role valueRole()

value

public Thing value()

delete

public void delete()

Deletes the VertexElement or EdgeElement used to represent this Relationship

isDeleted

public boolean isDeleted()

Return whether the relationship has been deleted.

isInferred

public boolean isInferred()

Used to indicate if this Relationship has been created as the result of a Rule inference.

Returns:

true if this Relationship exists due to a rule

See Also:

Rule

toString

public String toString()

Overrides:

toString in class Object

caches

public Collection<Cache> caches()

Specified by:

caches in interface CacheOwner

Returns:

all the caches beloning to the CacheOwner