ai.grakn.concept

Interface Rule

All Superinterfaces:

Comparable<Concept>, Concept, Thing

public interface Rule
extends Thing

A rule which defines how implicit knowledge can extracted.

It can behave like any other Thing but primarily serves as a way of extracting implicit data from the graph. By defining the LHS (if statment) and RHS (then conclusion) it is possible to automatically materialise new concepts based on these rules.

Author:

fppt

Method Summary

Modifier and Type	Method and Description
default Rule	asRule() Deprecated.
Collection<Type>	getConclusionTypes() Retrieve a set of Types that constitue a part of the conclusion of the Rule.
Collection<Type>	getHypothesisTypes() Retrieve a set of Types that constitute a part of the hypothesis of this Rule.
Pattern	getThen() Retrieves the Right Hand Side of the rule.
Pattern	getWhen() Retrieves the Left Hand Side of the rule.
default boolean	isRule() Deprecated.
Rule	resource(Resource resource) Creates a relation from this instance to the provided resource.
RuleType	type() Return the Type of the Concept.

Methods inherited from interface ai.grakn.concept.Thing

asThing, isThing, plays, relations, resources

Methods inherited from interface ai.grakn.concept.Concept

asEntity, asEntityType, asOntologyConcept, asRelation, asRelationType, asResource, asResourceType, asRole, asRuleType, asType, delete, getId, isEntity, isEntityType, isOntologyConcept, isRelation, isRelationType, isResource, isResourceType, isRole, isRuleType, isType

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

resource

Rule resource(Resource resource)

Creates a relation from this instance to the provided resource.

Specified by:

resource in interface Thing

Parameters:

resource - The resource to which a relationship is created

Returns:

The instance itself

getWhen

@CheckReturnValue
Pattern getWhen()

Retrieves the Left Hand Side of the rule. When this query is satisfied the "then" part of the rule is executed.

Returns:

A string representing the left hand side Graql query.

getThen

@CheckReturnValue
Pattern getThen()

Retrieves the Right Hand Side of the rule. This query is executed when the "when" part of the rule is satisfied

Returns:

A string representing the right hand side Graql query.

getHypothesisTypes

@CheckReturnValue
Collection<Type> getHypothesisTypes()

Retrieve a set of Types that constitute a part of the hypothesis of this Rule.

Returns:

A collection of Concept Types that constitute a part of the hypothesis of the Rule

getConclusionTypes

@CheckReturnValue
Collection<Type> getConclusionTypes()

Retrieve a set of Types that constitue a part of the conclusion of the Rule.

Returns:

A collection of Concept Types that constitute a part of the conclusion of the Rule

type

RuleType type()

Description copied from interface: Thing

Return the Type of the Concept.

Specified by:

type in interface Thing

Returns:

The type of this Graql

asRule

@Deprecated
 @CheckReturnValue
default Rule asRule()

Deprecated.

Description copied from interface: Concept

Return as a Rule if the Concept is a Rule Thing.

Specified by:

asRule in interface Concept

Returns:

A Rule if the Concept is a Rule

isRule

@Deprecated
 @CheckReturnValue
default boolean isRule()

Deprecated.

Description copied from interface: Concept

Determine if the Concept is a Rule.

Specified by:

isRule in interface Concept

Returns:

true if the Concept is a Rule