ai.grakn.concept

Interface EntityType

All Superinterfaces:

Comparable<Concept>, Concept, Type

public interface EntityType
extends Type

Ontology element used to represent categories.

An ontological element which represents categories instances can fall within. Any instance of a Entity Type is called an Entity.

Author:

fppt

Method Summary

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

setAbstract

EntityType setAbstract(Boolean isAbstract)

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

Specified by:

setAbstract in interface Type

Parameters:

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

Returns:

The EntityType itself

superType

EntityType superType(EntityType type)

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

Parameters:

type - The supertype of this EntityType

Returns:

The EntityType itself

Throws:

ConceptException - if this is a meta type

ConceptException - if the given supertype is already an indirect subtype of this type

subType

EntityType subType(EntityType type)

Adds another subtype to this type

Parameters:

type - The sub type of this entity type

Returns:

The EntityType itself

Throws:

ConceptException - if the sub type is a meta type

ConceptException - if the given subtype is already an indirect supertype of this type

plays

EntityType plays(RoleType roleType)

Sets the RoleType which instances of this EntityType may play.

Specified by:

plays in interface Type

Parameters:

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

Returns:

The EntityType itself

deletePlays

EntityType deletePlays(RoleType roleType)

Removes the RoleType to prevent instances of this EntityType from playing it.

Specified by:

deletePlays in interface Type

Parameters:

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

Returns:

The EntityType itself

addEntity

Entity addEntity()

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

Returns:

a new empty entity.

Throws:

ConceptException - if this is a meta type

See Also:

Entity

scope

EntityType 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

EntityType 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

EntityType 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

EntityType 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

EntityType superType()

Returns the supertype of this EntityType.

Specified by:

superType in interface Type

Returns:

The supertype of this EntityType

subTypes

Collection<EntityType> subTypes()

Returns a collection of subtypes of this EntityType.

Specified by:

subTypes in interface Type

Returns:

All the sub classes of this EntityType

instances

Collection<Entity> instances()

Returns a collection of all Entity instances for this EntityType.

Specified by:

instances in interface Type

Returns:

All the instances of this EntityType.

See Also:

Entity

copy

EntityType copy()

Specified by:

copy in interface Type

Returns:

a deep copy of this concept.