ai.grakn.concept

Interface RuleType

All Superinterfaces:

Comparable<Concept>, Concept, OntologyConcept, 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
default RuleType	asRuleType() Deprecated.
RuleType	deletePlays(Role role)
RuleType	deleteScope(Thing scope) Delete the scope specified.
Collection<Rule>	instances() Get all indirect instances of this type.
default boolean	isRuleType() Deprecated.
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(Role role)
Rule	putRule(Pattern when, Pattern then) 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(Thing 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	setLabel(Label label) Changes the Label of this Concept to a new one.
RuleType	sub(RuleType type) Adds another subtype to this type
Collection<RuleType>	subs() Get all indirect sub-types of this type.
RuleType	sup()
RuleType	sup(RuleType type)

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, asEntityType, asRelation, asRelationType, asResource, asResourceType, asRole, asRule, asThing, delete, getId, isEntity, isEntityType, isRelation, isRelationType, isResource, isResourceType, isRole, isRule, isThing

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setLabel

RuleType 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

putRule

Rule putRule(Pattern when,
             Pattern then)

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

Parameters:

when - A string representing the when part of the Rule

then - A string representing the then part of the Rule

Returns:

a new Rule

See Also:

Pattern

scope

RuleType 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

RuleType 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

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

sup

@Nonnull
RuleType sup()

Specified by:

sup in interface OntologyConcept

Specified by:

sup in interface Type

Returns:

The super type of this Rule Type

sup

RuleType sup(RuleType type)

Parameters:

type - The super type of this Rule Type

Returns:

The Rule Type itself

sub

RuleType sub(RuleType type)

Adds another subtype to this type

Parameters:

type - The sub type of this rule type

Returns:

The RuleType itself

subs

Collection<RuleType> subs()

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:

subs in interface OntologyConcept

Specified by:

subs in interface Type

Returns:

All the sub types of this rule type

plays

RuleType plays(Role role)

Specified by:

plays in interface Type

Parameters:

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

Returns:

The Rule Type itself

deletePlays

RuleType deletePlays(Role role)

Specified by:

deletePlays in interface Type

Parameters:

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

asRuleType

@Deprecated
 @CheckReturnValue
default RuleType asRuleType()

Deprecated.

Description copied from interface: Concept

Return as a RuleType if the Concept is a RuleType.

Specified by:

asRuleType in interface Concept

Returns:

A RuleType if the Concept is a RuleType

isRuleType

@Deprecated
 @CheckReturnValue
default boolean isRuleType()

Deprecated.

Description copied from interface: Concept

Determine if the Concept is a RuleType.

Specified by:

isRuleType in interface Concept

Returns:

true if the Concept is a RuleType