ai.grakn.kb.internal.concept

Class RelationshipImpl

java.lang.Object

ai.grakn.kb.internal.concept.RelationshipImpl

All Implemented Interfaces:

Concept, Relationship, Thing, ContainsTxCache, ConceptVertex, Comparable<Concept>

public class RelationshipImpl
extends Object
implements Relationship, ConceptVertex, ContainsTxCache

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	addRolePlayer(Role role, Thing thing) Expands this Relationship to include a new role player which is playing a specific Role.
Map<Role,Set<Thing>>	allRolePlayers() Retrieve a list of all Thing involved in the Relationship, and the Role they play.
Relationship	attribute(Attribute attribute)
Relationship	attributeRelationship(Attribute attribute)
java.util.stream.Stream<Attribute<?>>	attributes(AttributeType[] attributeTypes)
int	compareTo(Concept o)
static RelationshipImpl	create(ai.grakn.kb.internal.concept.RelationshipStructure relationshipStructure)
void	delete()
Relationship	deleteAttribute(Attribute attribute)
boolean	equals(Object object)
static RelationshipImpl	from(Relationship relationship)
ConceptId	getId()
int	hashCode()
boolean	isDeleted()
java.util.stream.Stream<Role>	plays()
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)
java.util.stream.Stream<Thing>	rolePlayers(Role... roles)
ai.grakn.kb.internal.concept.RelationshipStructure	structure()
String	toString()
void	txCacheClear() Clears the internal Cache
RelationshipType	type()
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.ContainsTxCache

from

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()

attribute

public Relationship attribute(Attribute attribute)

Specified by:

attribute in interface Relationship

Specified by:

attribute in interface Thing

attributeRelationship

public Relationship attributeRelationship(Attribute attribute)

Specified by:

attributeRelationship in interface Thing

attributes

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

Specified by:

attributes 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

plays

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

Specified by:

plays in interface Thing

allRolePlayers

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

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

Specified by:

allRolePlayers 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

addRolePlayer

public Relationship addRolePlayer(Role role,
                                  Thing thing)

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

Specified by:

addRolePlayer in interface Relationship

Parameters:

role - The role of the new role player.

thing - The new role player.

Returns:

The Relationship itself

deleteAttribute

public Relationship deleteAttribute(Attribute attribute)

Specified by:

deleteAttribute in interface Relationship

Specified by:

deleteAttribute in interface Thing

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

getId

public ConceptId getId()

Specified by:

getId in interface Concept

delete

public void delete()

Specified by:

delete in interface Concept

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface Concept

compareTo

public int compareTo(Concept o)

Specified by:

compareTo in interface Comparable<Concept>

vertex

public VertexElement vertex()

Specified by:

vertex in interface ConceptVertex

from

public static RelationshipImpl from(Relationship relationship)

txCacheClear

public void txCacheClear()

Description copied from interface: ContainsTxCache

Clears the internal Cache

Specified by:

txCacheClear in interface ContainsTxCache