ai.grakn.concept

Interface RelationType

All Superinterfaces:

Comparable<Concept>, Concept, Type

public interface RelationType
extends Type

A RelationType is a schema element, and is the Concept that represents how Entities relate to one another.

Method Summary

Modifier and Type	Method and Description
Relation	addRelation() Adds a new empty Relation.
RelationType	deleteHasRole(RoleType roleType) Delete a RoleType from this RelationType
RelationType	deletePlaysRole(RoleType roleType) Removes the RoleType to prevent instances of this RelationType from playing it.
RelationType	hasRole(RoleType roleType) Sets a new RoleType for this RelationType.
Collection<RoleType>	hasRoles() Retrieves a list of the RoleTypes that make up this RelationType.
Collection<Relation>	instances() Retrieve all the Relation instances of this RelationType
RelationType	playsRole(RoleType roleType) Sets the RoleType which instances of this RelationType may play.
RelationType	setAbstract(Boolean isAbstract) Sets the RelationType to be abstract - which prevents it from having any instances.
Collection<RelationType>	subTypes() Returns a collection of subtypes of this RelationType.
RelationType	superType() Returns the supertype of this RelationType.
RelationType	superType(RelationType type) Sets the supertype of the RelationType to be the EntityType specified.

Methods inherited from interface ai.grakn.concept.Type

getName, getRulesOfConclusion, getRulesOfHypothesis, hasResource, 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

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

addRelation

Relation addRelation()

Adds a new empty Relation.

Returns:

a new empty relation.

See Also:

Relation

hasRoles

Collection<RoleType> hasRoles()

Retrieves a list of the RoleTypes that make up this RelationType.

Returns:

A list of the RoleTypes which make up this RelationType.

See Also:

RoleType

hasRole

RelationType hasRole(RoleType roleType)

Sets a new RoleType for this RelationType.

Parameters:

roleType - A new role which is part of this relationship.

Returns:

The RelationType itself.

See Also:

RoleType

deleteHasRole

RelationType deleteHasRole(RoleType roleType)

Delete a RoleType from this RelationType

Parameters:

roleType - The RoleType to delete from the RelationType.

Returns:

The RelationType itself.

See Also:

RoleType

setAbstract

RelationType setAbstract(Boolean isAbstract)

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

Specified by:

setAbstract in interface Type

Parameters:

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

Returns:

The RelationType itself.

superType

RelationType superType()

Returns the supertype of this RelationType.

Specified by:

superType in interface Type

Returns:

The supertype of this RelationType

superType

RelationType superType(RelationType type)

Sets the supertype of the RelationType to be the EntityType specified.

Parameters:

type - The supertype of this RelationType

Returns:

The RelationType itself.

subTypes

Collection<RelationType> subTypes()

Returns a collection of subtypes of this RelationType.

Specified by:

subTypes in interface Type

Returns:

All the sub types of this RelationType

playsRole

RelationType playsRole(RoleType roleType)

Sets the RoleType which instances of this RelationType may play.

Specified by:

playsRole in interface Type

Parameters:

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

Returns:

The RelationType itself.

deletePlaysRole

RelationType deletePlaysRole(RoleType roleType)

Removes the RoleType to prevent instances of this RelationType 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 RelationType itself.

instances

Collection<Relation> instances()

Retrieve all the Relation instances of this RelationType

Specified by:

instances in interface Type

Returns:

All the Relation instances of this relation type

See Also:

Relation