Type (Grakn 0.12.0 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Type`	`copy()`
`Type`	`deletePlays(RoleType roleType)`
`Type`	`deleteScope(Instance scope)` Delete the scope specified.
`TypeLabel`	`getLabel()` Returns the unique label 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.
`Collection<? extends Instance>`	`instances()` Get all indirect instances of this type.
`Boolean`	`isAbstract()` Return if the type is set to abstract.
`Boolean`	`isImplicit()` Return whether the Type was created implicitly.
`Type`	`key(ResourceType resourceType)` Creates a RelationType which allows this type and a resource type to be linked in a strictly one-to-one mapping.
`Collection<ResourceType>`	`keys()`
`Collection<RoleType>`	`plays()`
`Type`	`plays(RoleType roleType)`
`Type`	`resource(ResourceType resourceType)` Creates a RelationType which allows this type and a resource type to be linked.
`Collection<ResourceType>`	`resources()`
`Type`	`scope(Instance scope)` Classifies the type to a specific scope.
`Collection<Instance>`	`scopes()` Retrieve a list of the Instances that scope this Type.
`Type`	`setAbstract(Boolean isAbstract)` Sets the Entity Type to be abstract - which prevents it from having any instances.
`Collection<? extends Type>`	`subTypes()` Get all indirect sub-types of this type.
`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)
          throws ConceptException
```
    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
    
    Throws:
    
    ConceptException - if this is a meta-type
  - plays
```
Type plays(RoleType roleType)
    throws ConceptException
```
    Parameters:
    
    roleType - The Role Type which the instances of this Type are allowed to play.
    
    Returns:
    
    The Type itself.
    
    Throws:
    
    ConceptException - if this is a meta-type
  - key
```
Type key(ResourceType resourceType)
  throws ConceptException
```
    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 Type itself.
    
    Throws:
    
    ConceptException - if this is a meta-type
  - resource
```
Type resource(ResourceType resourceType)
       throws ConceptException
```
    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 Type itself.
    
    Throws:
    
    ConceptException - if this is a meta-type
  - scope
```
Type scope(Instance scope)
```
    Classifies the type to a specific scope. This allows you to optionally categorise types.
    
    Parameters:
    
    scope - The category of this Type
    
    Returns:
    
    The Type itself.
  - deleteScope
```
Type deleteScope(Instance scope)
```
    Delete the scope specified.
    
    Parameters:
    
    scope - The Instances that is currently scoping this Type.
    
    Returns:
    
    The Type itself
  - getLabel
```
TypeLabel getLabel()
```
    Returns the unique label of this Type.
    
    Returns:
    
    The unique label of this type
  - plays
```
Collection<RoleType> plays()
```
    Returns:
    
    A list of Role Types which instances of this Type can indirectly play.
  - resources
```
Collection<ResourceType> resources()
```
    Returns:
    
    The resource types which this type is linked with.
  - keys
```
Collection<ResourceType> keys()
```
    Returns:
    
    The resource types which this type is linked with as a key.
  - superType
```
Type superType()
```
    Returns:
    
    The direct super of this Type
  - subTypes
```
Collection<? extends Type> subTypes()
```
    Get all indirect sub-types of this type. The indirect sub-types are the type itself and all indirect sub-types of direct sub-types.
    
    Returns:
    
    All the indirect sub-types of this Type
  - instances
```
Collection<? extends Instance> instances()
```
    Get all indirect instances of this type. The indirect instances are the direct instances and all indirect instances of direct sub-types.
    
    Returns:
    
    All the indirect 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 resource(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
  - scopes
```
Collection<Instance> scopes()
```
    Retrieve a list of the Instances that scope this Type.
    
    Returns:
    
    A list of the Instances that scope this Type.
  - deletePlays
```
Type deletePlays(RoleType roleType)
```
    Parameters:
    
    roleType - The Role Type which the instances of this Type should no longer be allowed to play.
    
    Returns:
    
    The Type itself.
  - copy
```
Type copy()
```
    Returns:
    
    a deep copy of this concept.

Interface Type

Method Summary

Methods inherited from interface ai.grakn.concept.Concept

Methods inherited from interface java.lang.Comparable

Method Detail

setAbstract

plays

key

resource

scope

deleteScope

getLabel

plays

resources

keys

superType

subTypes

instances

isAbstract

isImplicit

getRulesOfHypothesis

getRulesOfConclusion

scopes

deletePlays

copy