ai.grakn.kb.internal.concept

Class RelationshipReified

java.lang.Object

ai.grakn.kb.internal.concept.ConceptImpl

ai.grakn.kb.internal.concept.ThingImpl<Relationship,RelationshipType>

ai.grakn.kb.internal.concept.RelationshipReified

All Implemented Interfaces:

Concept, Thing, CacheOwner, ConceptVertex

public class RelationshipReified
extends ThingImpl<Relationship,RelationshipType>

Encapsulates The Relationship as a VertexElement

This wraps up a Relationship as a VertexElement. It is used to represent any Relationship which has been reified.

Author:

fppt

Method Summary

Modifier and Type	Method and Description
void	addRolePlayer(Role role, Thing thing)
Map<Role,Set<Thing>>	allRolePlayers()
java.util.stream.Stream<Casting>	castingsRelation(Role... roles) Castings are retrieved from the perspective of the Relationship
static RelationshipReified	create(VertexElement vertexElement, RelationshipType type)
void	delete() Deletes the VertexElement or EdgeElement used to represent this Relationship
static RelationshipReified	get(VertexElement vertexElement)
ConceptId	id()
String	innerToString()
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.
void	owner(RelationshipImpl relationship) Sets the owner of this structure to a specific RelationshipImpl.
void	putRolePlayerEdge(Role role, Thing toThing) If the edge does not exist then it adds a Schema.EdgeLabel#ROLE_PLAYER edge from this Relationship to a target Thing which is playing some Role.
RelationshipReified	reify()
java.util.stream.Stream<Thing>	rolePlayers(Role... roles)
RelationshipType	type()

Methods inherited from class ai.grakn.kb.internal.concept.ThingImpl

attributeInferred, attributes, delete, getIndex, has, isInferred, keys, relationships, relhas, roles, type, unhas

Methods inherited from class ai.grakn.kb.internal.concept.ConceptImpl

baseType, caches, createShard, currentShard, deleteNode, equals, hashCode, id, isDeleted, keyspace, shardCount, shards, toString, vertex

Methods inherited from class java.lang.Object

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

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

caches, from, registerCache, txCacheClear, txCacheFlush

Methods inherited from interface ai.grakn.concept.Thing

asThing, isThing

Methods inherited from interface ai.grakn.concept.Concept

asAttribute, asAttributeType, asEntity, asEntityType, asRelationship, asRelationshipType, asRole, asRule, asSchemaConcept, asType, id, isAttribute, isAttributeType, isDeleted, isEntity, isEntityType, isRelationship, isRelationshipType, isRole, isRule, isSchemaConcept, isType, keyspace

Methods inherited from interface ai.grakn.kb.internal.concept.ConceptVertex

from

Method Detail

get

public static RelationshipReified get(VertexElement vertexElement)

create

public static RelationshipReified create(VertexElement vertexElement,
                                         RelationshipType type)

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

addRolePlayer

public void addRolePlayer(Role role,
                          Thing thing)

putRolePlayerEdge

public void putRolePlayerEdge(Role role,
                              Thing toThing)

If the edge does not exist then it adds a Schema.EdgeLabel#ROLE_PLAYER edge from this Relationship to a target Thing which is playing some Role. If the edge does exist nothing is done.

Parameters:

role - The Role being played by the Thing in this Relationship

toThing - The Thing playing a Role in this Relationship

castingsRelation

public java.util.stream.Stream<Casting> castingsRelation(Role... roles)

Castings are retrieved from the perspective of the Relationship

Parameters:

roles - The Role which the Things are playing

Returns:

The Casting which unify a Role and Thing with this Relationship

innerToString

public String innerToString()

owner

public void owner(RelationshipImpl relationship)

Sets the owner of this structure to a specific RelationshipImpl. This is so that the internal structure can use the Relationship reference;

Parameters:

relationship - the owner of this RelationshipReified

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

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.

type

public RelationshipType type()

Returns:

The RelationshipType of the Relationship

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