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, ContainsTxCache, ConceptVertex, Comparable<Concept>

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 String	generateNewHash(RelationshipType relationshipType, Map<Role,Set<Thing>> roleMap)
static String	generateNewHash(RelationshipType relationshipType, TreeMap<String,String> resourceMap) Creates a hash for a relation based on it's RelationshipType and the Attribute which serves as it's key
static RelationshipReified	get(VertexElement vertexElement)
ConceptId	getId()
String	innerToString()
boolean	isDeleted() Return whether the relationship has been deleted.
boolean	isReified()
RelationshipReified	reify()
java.util.stream.Stream<Thing>	rolePlayers(Role... roles)
void	setHash(String hash) Sets the internal hash in order to perform a faster lookup
RelationshipType	type()

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

attribute, attributeRelationship, attributes, delete, deleteAttribute, getIndex, plays, relationships, txCacheClear, type

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

addEdge, baseType, compareTo, createShard, currentShard, deleteNode, equals, getId, getShardCount, hashCode, isDeleted, setShardCount, 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.ContainsTxCache

from, txCacheClear

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, getId, isAttribute, isAttributeType, isDeleted, isEntity, isEntityType, isRelationship, isRelationshipType, isRole, isRule, isSchemaConcept, isType

Methods inherited from interface java.lang.Comparable

compareTo

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)

setHash

public void setHash(String hash)

Sets the internal hash in order to perform a faster lookup

generateNewHash

public static String generateNewHash(RelationshipType relationshipType,
                                     Map<Role,Set<Thing>> roleMap)

Parameters:

relationshipType - The type of this relation

roleMap - The roles and their corresponding role players

Returns:

A unique hash identifying this Relationship

generateNewHash

public static String generateNewHash(RelationshipType relationshipType,
                                     TreeMap<String,String> resourceMap)

Creates a hash for a relation based on it's RelationshipType and the Attribute which serves as it's key

Parameters:

relationshipType - the RelationshipType of the Relationship

resourceMap - a sorted map of AttributeType Ids to Attribute Ids

Returns:

A unique hash identifying 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 instances are playing

Returns:

The Casting which unify a Role and Thing with this Relationship

innerToString

public String innerToString()

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

getId

public ConceptId getId()

Returns:

The ConceptId of the Relationship

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.