ai.grakn.concept

Interface RoleType

All Superinterfaces:

Comparable<Concept>, Concept, Type

public interface RoleType
extends Type

A RoleType is a schema element that defines a role that can be played in a Relation Type.

See Also:

RelationType

Method Summary

Modifier and Type	Method and Description
RoleType	deletePlaysRole(RoleType roleType) Removes the RoleType to prevent instances from playing it
Collection<Type>	playedByTypes() Returns a collection of the Types that can play this RoleType.
RoleType	playsRole(RoleType roleType) Sets the RoleType which instances of this Type may play.
RelationType	relationType() Returns the RelationType that this RoleType takes part in.
RoleType	setAbstract(Boolean isAbstract) Sets the RoleType to be abstract - which prevents it from having any instances.
Collection<RoleType>	subTypes() Returns the subtypes of this RoleType.
RoleType	superType() Returns the supertype of this RoleType.
RoleType	superType(RoleType type) Sets the supertype of this RoleType.

Methods inherited from interface ai.grakn.concept.Type

getName, getRulesOfConclusion, getRulesOfHypothesis, hasResource, instances, isAbstract, isImplicit, key, playsRoles

Methods inherited from interface ai.grakn.concept.Concept

asEntity, asEntityType, asInstance, asRelation, asRelationType, asResource, asResourceType, asRoleType, asRule, asRuleType, asType, delete, getId, isEntity, isEntityType, isInstance, isRelation, isRelationType, isResource, isResourceType, isRoleType, isRule, isRuleType, isType, type

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setAbstract

RoleType setAbstract(Boolean isAbstract)

Sets the RoleType to be abstract - which prevents it from having any instances.

Specified by:

setAbstract in interface Type

Parameters:

isAbstract - Specifies if the RoleType is to be abstract (true) or not (false).

Returns:

The RoleType itself

superType

RoleType superType(RoleType type)

Sets the supertype of this RoleType.

Parameters:

type - The supertype of this RoleType

Returns:

The RoleType itself

playsRole

RoleType playsRole(RoleType roleType)

Sets the RoleType which instances of this Type may play.

Specified by:

playsRole in interface Type

Parameters:

roleType - The RoleType which the instances of this Type are allowed to play.

Returns:

The RoleType itself

deletePlaysRole

RoleType deletePlaysRole(RoleType roleType)

Removes the RoleType to prevent instances from playing it

Specified by:

deletePlaysRole in interface Type

Parameters:

roleType - The RoleType which the instances of this Type should no longer be allowed to play.

Returns:

The RoleType itself

superType

RoleType superType()

Returns the supertype of this RoleType.

Specified by:

superType in interface Type

Returns:

The supertype of this RoleType

subTypes

Collection<RoleType> subTypes()

Returns the subtypes of this RoleType.

Specified by:

subTypes in interface Type

Returns:

The sub types of this RoleType

relationType

RelationType relationType()

Returns the RelationType that this RoleType takes part in.

Returns:

The RelationType which this role takes part in.

See Also:

RelationType

playedByTypes

Collection<Type> playedByTypes()

Returns a collection of the Types that can play this RoleType.

Returns:

A list of all the Types which can play this role.

See Also:

Type