ai.grakn.graph.internal

Class RelationReified

java.lang.Object

ai.grakn.graph.internal.RelationReified

All Implemented Interfaces:

Concept, Thing, Comparable<Concept>

public class RelationReified
extends Object

Encapsulates The Relation as a VertexElement

This wraps up a Relation as a VertexElement. It is used to represent any Relation 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()
int	compareTo(Concept o)
void	delete() Deletes the VertexElement or EdgeElement used to represent this Relation
void	delete() Deletes the concept as an Thing
boolean	equals(Object object)
static ai.grakn.graph.internal.ConceptVertex	from(Concept concept)
ConceptId	getId()
ConceptId	getId() Get the unique ID associated with the Concept.
String	getIndex() This index is used by concepts such as casting and relations to speed up internal lookups
int	hashCode()
String	innerToString()
boolean	isReified()
Collection<Role>	plays() Determine the Role Types that this Thing may play.
RelationReified	reify()
Collection<Relation>	relations(Role... roles) Retrieves a Relations which the Thing takes part in, which may optionally be narrowed to a particular set according to the Role you are interested in.
T	resource(Resource resource) Creates a relation from this instance to the provided resource.
Collection<Resource<?>>	resources(ResourceType... resourceTypes) Retrieves a collection of Resources attached to this Instances
Collection<Thing>	rolePlayers(Role... roles)
String	toString()
RelationType	type()
V	type() Return the Type of the Concept.
protected T	type(ai.grakn.graph.internal.TypeImpl type)
ai.grakn.graph.internal.VertexElement	vertex()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.concept.Thing

asThing, isThing

Methods inherited from interface ai.grakn.concept.Concept

asEntity, asEntityType, asOntologyConcept, asRelation, asRelationType, asResource, asResourceType, asRole, asRule, asRuleType, asType, getId, isEntity, isEntityType, isOntologyConcept, isRelation, isRelationType, isResource, isResourceType, isRole, isRule, isRuleType, isType

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

allRolePlayers

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

Returns:

All the Roles and the Things which play them

rolePlayers

public Collection<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)

innerToString

public String innerToString()

reify

public RelationReified reify()

Returns:

The relation structure which has been reified

isReified

public boolean isReified()

Returns:

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

getId

public ConceptId getId()

Returns:

The ConceptId of the Relation

type

public RelationType type()

Returns:

The RelationType of the Relation

delete

public void delete()

Deletes the VertexElement or EdgeElement used to represent this Relation

delete

public void delete()

Deletes the concept as an Thing

Specified by:

delete in interface Concept

getIndex

public String getIndex()

This index is used by concepts such as casting and relations to speed up internal lookups

Returns:

The inner index value of some concepts.

resources

public Collection<Resource<?>> resources(ResourceType... resourceTypes)

Description copied from interface: Thing

Retrieves a collection of Resources attached to this Instances

Specified by:

resources in interface Thing

Parameters:

resourceTypes - Resource Types of the resources attached to this entity

Returns:

All the Resource that this Thing is linked with

See Also:

Resource

relations

public Collection<Relation> relations(Role... roles)

Description copied from interface: Thing

Retrieves a Relations which the Thing takes part in, which may optionally be narrowed to a particular set according to the Role you are interested in.

Specified by:

relations in interface Thing

Parameters:

roles - An optional parameter which allows you to specify the role of the relations you wish to retrieve.

Returns:

A set of Relations which the concept instance takes part in, optionally constrained by the Role Type.

See Also:

Role, Relation

plays

public Collection<Role> plays()

Description copied from interface: Thing

Determine the Role Types that this Thing may play.

Specified by:

plays in interface Thing

Returns:

A set of all the Role Types which this instance plays.

See Also:

Role

resource

public T resource(Resource resource)

Creates a relation from this instance to the provided resource.

Specified by:

resource in interface Thing

Parameters:

resource - The resource to creating a relationship to

Returns:

The instance itself

type

public V type()

Description copied from interface: Thing

Return the Type of the Concept.

Specified by:

type in interface Thing

Returns:

The type of the concept casted to the correct interface

type

protected T type(ai.grakn.graph.internal.TypeImpl type)

Parameters:

type - The type of this concept

Returns:

The concept itself casted to the correct interface

vertex

public ai.grakn.graph.internal.VertexElement vertex()

getId

public ConceptId getId()

Description copied from interface: Concept

Get the unique ID associated with the Concept.

Specified by:

getId in interface Concept

Returns:

A string representing the concept's unique id.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Concept o)

Specified by:

compareTo in interface Comparable<Concept>

from

public static ai.grakn.graph.internal.ConceptVertex from(Concept concept)