ai.grakn.kb.internal.concept

Class RelationshipImpl

java.lang.Object

ai.grakn.kb.internal.concept.RelationshipImpl

All Implemented Interfaces:

Concept, Relationship, Thing, CacheOwner, ConceptVertex

public class RelationshipImpl
extends Object
implements Relationship, ConceptVertex, CacheOwner

Encapsulates relationships between Thing

A relation which is an instance of a RelationshipType defines how instances may relate to one another.

Author:

fppt

Method Summary

Modifier and Type	Method and Description
Relationship	assign(Role role, Thing player) Expands this Relationship to include a new role player which is playing a specific Role.
Relationship	attributeInferred(Attribute attribute)
java.util.stream.Stream<Attribute<?>>	attributes(AttributeType[] attributeTypes)
Collection<Cache>	caches()
static RelationshipImpl	create(ai.grakn.kb.internal.concept.RelationshipStructure relationshipStructure)
void	delete()
boolean	equals(Object object)
static RelationshipImpl	from(Relationship relationship)
Relationship	has(Attribute attribute)
int	hashCode()
ConceptId	id()
boolean	isDeleted()
boolean	isInferred()
java.util.stream.Stream<Attribute<?>>	keys(AttributeType[] attributeTypes)
Keyspace	keyspace()
Optional<RelationshipReified>	reified() Gets the RelationshipReified if the Relationship has been reified.
RelationshipReified	reify() Reifys and returns the RelationshipReified
java.util.stream.Stream<Relationship>	relationships(Role... roles)
Relationship	relhas(Attribute attribute)
java.util.stream.Stream<Thing>	rolePlayers(Role... roles)
Map<Role,Set<Thing>>	rolePlayersMap() Retrieve a list of all Thing involved in the Relationship, and the Role they play.
java.util.stream.Stream<Role>	roles()
ai.grakn.kb.internal.concept.RelationshipStructure	structure()
String	toString()
RelationshipType	type()
void	unassign(Role role, Thing player)
Relationship	unhas(Attribute attribute)
VertexElement	vertex()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.concept.Relationship

asRelationship, isRelationship

Methods inherited from interface ai.grakn.concept.Thing

asThing, isThing

Methods inherited from interface ai.grakn.concept.Concept

asAttribute, asAttributeType, asEntity, asEntityType, asRelationshipType, asRole, asRule, asSchemaConcept, asType, isAttribute, isAttributeType, isEntity, isEntityType, isRelationshipType, isRole, isRule, isSchemaConcept, isType

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

from

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

from, registerCache, txCacheClear, txCacheFlush

Method Detail

create

public static RelationshipImpl create(ai.grakn.kb.internal.concept.RelationshipStructure relationshipStructure)

reified

public Optional<RelationshipReified> reified()

Gets the RelationshipReified if the Relationship has been reified. To reify the Relationship you use reify(). NOTE: This approach is done to make sure that only write operations will cause the Relationship to reify

Returns:

The RelationshipReified if the Relationship has been reified

reify

public RelationshipReified reify()

Reifys and returns the RelationshipReified

structure

public ai.grakn.kb.internal.concept.RelationshipStructure structure()

has

public Relationship has(Attribute attribute)

Specified by:

has in interface Relationship

Specified by:

has in interface Thing

relhas

public Relationship relhas(Attribute attribute)

Specified by:

relhas in interface Thing

attributes

public java.util.stream.Stream<Attribute<?>> attributes(AttributeType[] attributeTypes)

Specified by:

attributes in interface Thing

keys

public java.util.stream.Stream<Attribute<?>> keys(AttributeType[] attributeTypes)

Specified by:

keys in interface Thing

type

public RelationshipType type()

Specified by:

type in interface Relationship

Specified by:

type in interface Thing

relationships

public java.util.stream.Stream<Relationship> relationships(Role... roles)

Specified by:

relationships in interface Thing

roles

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

Specified by:

roles in interface Thing

rolePlayersMap

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

Retrieve a list of all Thing involved in the Relationship, and the Role they play.

Specified by:

rolePlayersMap in interface Relationship

Returns:

A list of all the Roles and the Things playing them in this Relationship.

See Also:

Role

rolePlayers

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

Specified by:

rolePlayers in interface Relationship

assign

public Relationship assign(Role role,
                           Thing player)

Expands this Relationship to include a new role player which is playing a specific Role.

Specified by:

assign in interface Relationship

Parameters:

role - The role of the new role player.

player - The new role player.

Returns:

The Relationship itself

unhas

public Relationship unhas(Attribute attribute)

Specified by:

unhas in interface Relationship

Specified by:

unhas in interface Thing

isInferred

public boolean isInferred()

Specified by:

isInferred in interface Thing

unassign

public void unassign(Role role,
                     Thing player)

Specified by:

unassign in interface Relationship

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

id

public ConceptId id()

Specified by:

id in interface Concept

keyspace

public Keyspace keyspace()

Specified by:

keyspace in interface Concept

delete

public void delete()

Specified by:

delete in interface Concept

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface Concept

vertex

public VertexElement vertex()

Specified by:

vertex in interface ConceptVertex

from

public static RelationshipImpl from(Relationship relationship)

caches

public Collection<Cache> caches()

Specified by:

caches in interface CacheOwner

Returns:

all the caches beloning to the CacheOwner

attributeInferred

public Relationship attributeInferred(Attribute attribute)