ai.grakn.concept

Interface RuleType

All Superinterfaces:

Comparable<Concept>, Concept, Type

public interface RuleType
extends Type

An ontological element used to model and categorise different types of Rule.

An ontological element used to define different types of Rule. Currently supported rules include GraknAdmin.getMetaRuleInference() and GraknAdmin.getMetaRuleConstraint()

Author:

fppt

Method Summary

Modifier and Type	Method and Description
RuleType	copy()
RuleType	deletePlays(RoleType roleType)
RuleType	deleteScope(Instance scope) Delete the scope specified.
Collection<Rule>	instances() Get all indirect instances of this type.
RuleType	key(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked in a strictly one-to-one mapping.
RuleType	plays(RoleType roleType)
Rule	putRule(Pattern lhs, Pattern rhs) Adds a new Rule if it does not exist otherwise returns the existing rule.
RuleType	resource(ResourceType resourceType) Creates a RelationType which allows this type and a resource type to be linked.
RuleType	scope(Instance scope) Classifies the type to a specific scope.
RuleType	setAbstract(Boolean isAbstract) Sets the Entity Type to be abstract - which prevents it from having any instances.
RuleType	subType(RuleType type) Adds another subtype to this type
Collection<RuleType>	subTypes() Get all indirect sub-types of this type.
RuleType	superType()
RuleType	superType(RuleType type)

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

putRule

Rule putRule(Pattern lhs,
             Pattern rhs)

Adds a new Rule if it does not exist otherwise returns the existing rule.

Parameters:

lhs - A string representing the left hand side Graql query.

rhs - A string representing the right hand side Graql query.

Returns:

a new Rule

See Also:

Pattern

scope

RuleType 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

RuleType 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

RuleType 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

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

setAbstract

RuleType setAbstract(Boolean isAbstract)

Description copied from interface: Type

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

Specified by:

setAbstract in interface Type

Parameters:

isAbstract - Specifies if the concept is abstract (true) or not (false). If the concept type is abstract it is not allowed to have any instances.

Returns:

The Rule Type itself

superType

RuleType superType()

Specified by:

superType in interface Type

Returns:

The super type of this Rule Type

superType

RuleType superType(RuleType type)

Parameters:

type - The super type of this Rule Type

Returns:

The Rule Type itself

subType

RuleType subType(RuleType type)

Adds another subtype to this type

Parameters:

type - The sub type of this rule type

Returns:

The RuleType itself

subTypes

Collection<RuleType> subTypes()

Description copied from interface: Type

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.

Specified by:

subTypes in interface Type

Returns:

All the sub types of this rule type

plays

RuleType plays(RoleType roleType)

Specified by:

plays in interface Type

Parameters:

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

Returns:

The Rule Type itself

deletePlays

RuleType deletePlays(RoleType roleType)

Specified by:

deletePlays in interface Type

Parameters:

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

Returns:

The Rule Type itself

instances

Collection<Rule> instances()

Description copied from interface: Type

Get all indirect instances of this type. The indirect instances are the direct instances and all indirect instances of direct sub-types.

Specified by:

instances in interface Type

Returns:

All the rule instances of this Rule Type.

copy

RuleType copy()

Specified by:

copy in interface Type

Returns:

a deep copy of this concept.