ai.grakn.concept

Interface RelationType

All Superinterfaces:

Comparable<Concept>, Concept, Type

public interface RelationType
extends Type

An ontological element which categorises how Instances may relate to each other.

A relation type defines how Type may relate to one another. They are used to model and categorise n-ary relationships.

Author:

fppt

Method Summary

Modifier and Type	Method and Description
Relation	addRelation() Creates and returns a new Relation instance, whose direct type will be this type.
RelationType	copy()
RelationType	deletePlays(RoleType roleType) Removes the RoleType to prevent instances of this RelationType from playing it.
RelationType	deleteRelates(RoleType roleType) Delete a RoleType from this RelationType
RelationType	deleteScope(Instance scope) Delete the scope specified.
Collection<Relation>	instances() Retrieve all the Relation instances of this RelationType
RelationType	key(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked in a strictly one-to-one mapping.
RelationType	plays(RoleType roleType) Sets the RoleType which instances of this RelationType may play.
Collection<RoleType>	relates() Retrieves a list of the RoleTypes that make up this RelationType.
RelationType	relates(RoleType roleType) Sets a new RoleType for this RelationType.
RelationType	resource(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked.
RelationType	scope(Instance scope) Classifies the type to a specific scope.
RelationType	setAbstract(Boolean isAbstract) Sets the RelationType to be abstract - which prevents it from having any instances.
RelationType	subType(RelationType type) Adds another subtype to this type
Collection<RelationType>	subTypes() Returns a collection of subtypes of this RelationType.
RelationType	superType() Returns the direct supertype of this RelationType.
RelationType	superType(RelationType type) Sets the supertype of the RelationType to be the RelationType specified.

Methods inherited from interface ai.grakn.concept.Type

getLabel, getRulesOfConclusion, getRulesOfHypothesis, 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

addRelation

Relation addRelation()

Creates and returns a new Relation instance, whose direct type will be this type.

Returns:

a new empty relation.

Throws:

ConceptException - if this is a meta type

See Also:

Relation

superType

RelationType superType(RelationType type)

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

Parameters:

type - The supertype of this RelationType

Returns:

The RelationType itself.

subType

RelationType subType(RelationType type)

Adds another subtype to this type

Parameters:

type - The sub type of this relation type

Returns:

The RelationType itself

scope

RelationType 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

RelationType 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

RelationType 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

RelationType 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.

relates

Collection<RoleType> relates()

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

relates

RelationType relates(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

deleteRelates

RelationType deleteRelates(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 direct supertype of this RelationType.

Specified by:

superType in interface Type

Returns:

The direct supertype of this RelationType

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

plays

RelationType plays(RoleType roleType)

Sets the RoleType which instances of this RelationType may play.

Specified by:

plays in interface Type

Parameters:

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

Returns:

The RelationType itself.

deletePlays

RelationType deletePlays(RoleType roleType)

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

copy

RelationType copy()

Specified by:

copy in interface Type

Returns:

a deep copy of this concept.