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
Rule	addRule(Pattern lhs, Pattern rhs) Add a new Rule, given Patterns for the Left Hand Side and Right Hand Side.
RuleType	deletePlaysRole(RoleType roleType)
Collection<Rule>	instances()
RuleType	playsRole(RoleType roleType)
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()
RuleType	superType()
RuleType	superType(RuleType type)

Methods inherited from interface ai.grakn.concept.Type

getName, getRulesOfConclusion, getRulesOfHypothesis, hasResource, isAbstract, isImplicit, key, playsRoles

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

addRule

Rule addRule(Pattern lhs,
             Pattern rhs)

Add a new Rule, given Patterns for the Left Hand Side and Right Hand Side.

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

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()

Specified by:

subTypes in interface Type

Returns:

All the sub types of this rule type

playsRole

RuleType playsRole(RoleType roleType)

Specified by:

playsRole in interface Type

Parameters:

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

Returns:

The Rule Type itself

deletePlaysRole

RuleType deletePlaysRole(RoleType roleType)

Specified by:

deletePlaysRole 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()

Specified by:

instances in interface Type

Returns:

All the rule instances of this Rule Type.