ai.grakn.concept

Interface EntityType

All Superinterfaces:

Comparable<Concept>, Concept, OntologyConcept, 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.
default EntityType	asEntityType() Deprecated.
EntityType	deletePlays(Role role) Removes the Role to prevent instances of this EntityType from playing it.
EntityType	deleteScope(Thing scope) Delete the scope specified.
Collection<Entity>	instances() Returns a collection of all Entity instances for this EntityType.
default boolean	isEntityType() Deprecated.
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(Role role) Sets the Role 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(Thing 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	setLabel(Label label) Changes the Label of this Concept to a new one.
EntityType	sub(EntityType type) Adds another subtype to this type
Collection<EntityType>	subs() Returns a collection of subtypes of this EntityType.
EntityType	sup() Returns the supertype of this EntityType.
EntityType	sup(EntityType type) Sets the direct supertype of the EntityType to be the EntityType specified.

Methods inherited from interface ai.grakn.concept.Type

asType, isAbstract, isType, keys, plays, resources, scopes

Methods inherited from interface ai.grakn.concept.OntologyConcept

asOntologyConcept, getLabel, getLabelId, getRulesOfConclusion, getRulesOfHypothesis, isImplicit, isOntologyConcept

Methods inherited from interface ai.grakn.concept.Concept

asEntity, asRelation, asRelationType, asResource, asResourceType, asRole, asRule, asRuleType, asThing, delete, getId, isEntity, isRelation, isRelationType, isResource, isResourceType, isRole, isRule, isRuleType, isThing

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setLabel

EntityType setLabel(Label label)

Changes the Label of this Concept to a new one.

Specified by:

setLabel in interface OntologyConcept

Specified by:

setLabel in interface Type

Parameters:

label - The new Label.

Returns:

The Concept itself

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

sup

EntityType sup(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:

GraphOperationException - if this is a meta type

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

sub

EntityType sub(EntityType type)

Adds another subtype to this type

Parameters:

type - The sub type of this entity type

Returns:

The EntityType itself

Throws:

GraphOperationException - if the sub type is a meta type

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

plays

EntityType plays(Role role)

Sets the Role which instances of this EntityType may play.

Specified by:

plays in interface Type

Parameters:

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

Returns:

The EntityType itself

deletePlays

EntityType deletePlays(Role role)

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

Specified by:

deletePlays in interface Type

Parameters:

role - 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:

GraphOperationException - if this is a meta type

See Also:

Entity

scope

EntityType scope(Thing 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(Thing 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.

sup

@Nonnull
EntityType sup()

Returns the supertype of this EntityType.

Specified by:

sup in interface OntologyConcept

Specified by:

sup in interface Type

Returns:

The supertype of this EntityType

subs

Collection<EntityType> subs()

Returns a collection of subtypes of this EntityType.

Specified by:

subs in interface OntologyConcept

Specified by:

subs 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

asEntityType

@Deprecated
 @CheckReturnValue
default EntityType asEntityType()

Deprecated.

Description copied from interface: Concept

Return as an EntityType if the Concept is an EntityType.

Specified by:

asEntityType in interface Concept

Returns:

A EntityType if the Concept is an EntityType

isEntityType

@Deprecated
 @CheckReturnValue
default boolean isEntityType()

Deprecated.

Description copied from interface: Concept

Determine if the Concept is an EntityType.

Specified by:

isEntityType in interface Concept

Returns:

true if the Concept is an EntityType.