ai.grakn.concept

Interface RoleType

All Superinterfaces:

Comparable<Concept>, Concept, Type

public interface RoleType
extends Type

An ontological element which defines a role which can be played in a relation type.

This ontological element defines the roles which make up a RelationType. It behaves similarly to Type when relating to other types. It has some additional functionality: 1. It cannot play a role to itself. 2. It is special in that it is unique to relation types.

Author:

fppt

Method Summary

Modifier and Type	Method and Description
RoleType	copy()
RoleType	deletePlays(RoleType roleType) Removes the RoleType to prevent instances from playing it
RoleType	deleteScope(Instance scope) Delete the scope specified.
RoleType	key(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked in a strictly one-to-one mapping.
Collection<Type>	playedByTypes() Returns a collection of the Types that can play this RoleType.
RoleType	plays(RoleType roleType) Sets the RoleType which instances of this Type may play.
Collection<RelationType>	relationTypes() Returns the RelationTypes that this RoleType takes part in.
RoleType	resource(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked.
RoleType	scope(Instance scope) Classifies the type to a specific scope.
RoleType	setAbstract(Boolean isAbstract) Sets the RoleType to be abstract - which prevents it from having any instances.
RoleType	subType(RoleType type) Adds another subtype to this type
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

getLabel, getRulesOfConclusion, getRulesOfHypothesis, instances, isAbstract, isImplicit, keys, plays, resources, scopes

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

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

subType

RoleType subType(RoleType type)

Adds another subtype to this type

Parameters:

type - The sub type of this role type

Returns:

The RoleType itself

plays

RoleType plays(RoleType roleType)

Sets the RoleType which instances of this Type may play.

Specified by:

plays in interface Type

Parameters:

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

Returns:

The RoleType itself

deletePlays

RoleType deletePlays(RoleType roleType)

Removes the RoleType to prevent instances from playing it

Specified by:

deletePlays in interface Type

Parameters:

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

Returns:

The RoleType itself

scope

RoleType scope(Instance scope)

Classifies the type to a specific scope. This allows you to optionally categorise types.

Specified by:

scope in interface Type

Parameters:

scope - The category of this Type

Returns:

The Type itself.

deleteScope

RoleType deleteScope(Instance scope)

Delete the scope specified.

Specified by:

deleteScope in interface Type

Parameters:

scope - The Instances that is currently scoping this Type.

Returns:

The Type itself

key

RoleType key(ResourceType resourceType)

Creates a RelationType which allows this type and a resource type to be linked in a strictly one-to-one mapping.

Specified by:

key in interface Type

Parameters:

resourceType - The resource type which instances of this type should be allowed to play.

Returns:

The Type itself.

resource

RoleType resource(ResourceType resourceType)

Creates a RelationType which allows this type and a resource type to be linked.

Specified by:

resource in interface Type

Parameters:

resourceType - The resource type which instances of this type should be allowed to play.

Returns:

The Type 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

relationTypes

Collection<RelationType> relationTypes()

Returns the RelationTypes that this RoleType takes part in.

Returns:

The RelationTypes 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

copy

RoleType copy()

Specified by:

copy in interface Type

Returns:

a deep copy of this concept.