ai.grakn.concept

Interface Type

All Superinterfaces:

Comparable<Concept>, Concept

All Known Subinterfaces:

EntityType, RelationType, ResourceType<D>, RoleType, RuleType

public interface Type
extends Concept

A Type represents any ontological element in the graph.

Types are used to model the behaviour of Instance and how they relate to each other. They also aid in categorising Instance to different types.

Author:

fppt

See Also:

EntityType, RoleType, RelationType, ResourceType, RuleType

Method Summary

Modifier and Type	Method and Description
Type	deletePlaysRole(RoleType roleType)
TypeName	getName() Returns the name of this Type.
Collection<Rule>	getRulesOfConclusion() Return the collection of Rules for which this Type serves as a conclusion.
Collection<Rule>	getRulesOfHypothesis() Return the collection of Rules for which this Type serves as a hypothesis.
RelationType	hasResource(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked.
Collection<? extends Instance>	instances()
Boolean	isAbstract() Return if the type is set to abstract.
Boolean	isImplicit() Return whether the Type was created implicitly.
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.
Type	playsRole(RoleType roleType)
Collection<RoleType>	playsRoles()
Type	setAbstract(Boolean isAbstract) Sets the Entity Type to be abstract - which prevents it from having any instances.
Collection<? extends Type>	subTypes()
Type	superType()

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

Type setAbstract(Boolean isAbstract)

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

Parameters:

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

Returns:

The concept itself

playsRole

Type playsRole(RoleType roleType)

Parameters:

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

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.

Parameters:

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

Returns:

The resulting relation type which allows instances of this type to have relations with the provided resourceType.

hasResource

RelationType hasResource(ResourceType resourceType)

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

Parameters:

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

Returns:

The resulting relation type which allows instances of this type to have relations with the provided resourceType.

getName

TypeName getName()

Returns the name of this Type.

Returns:

The name of this type

playsRoles

Collection<RoleType> playsRoles()

Returns:

A list of Role Types which instances of this Type can play.

superType

Type superType()

Returns:

The super of this Type

subTypes

Collection<? extends Type> subTypes()

Returns:

All the sub classes of this Type

instances

Collection<? extends Instance> instances()

Returns:

All the instances of this type.

isAbstract

Boolean isAbstract()

Return if the type is set to abstract. By default, types are not abstract.

Returns:

returns true if the type is set to be abstract.

isImplicit

Boolean isImplicit()

Return whether the Type was created implicitly. By default, types are not implicit.

Returns:

returns true if the type was created implicitly through hasResource(ai.grakn.concept.ResourceType)

getRulesOfHypothesis

Collection<Rule> getRulesOfHypothesis()

Return the collection of Rules for which this Type serves as a hypothesis.

Returns:

A collection of Rules for which this Type serves as a hypothesis

See Also:

Rule

getRulesOfConclusion

Collection<Rule> getRulesOfConclusion()

Return the collection of Rules for which this Type serves as a conclusion.

Returns:

A collection of Rules for which this Type serves as a conclusion

See Also:

Rule

deletePlaysRole

Type deletePlaysRole(RoleType roleType)

Parameters:

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

Returns:

The Type itself.