ai.grakn.concept

Interface Rule

All Superinterfaces:

Comparable<Concept>, Concept, Instance

public interface Rule
extends Instance

A Rule represents an instance of a Rule-Type, which is used to make inferences over the data.

Method Summary

Modifier and Type	Method and Description
Rule	addConclusion(Type type) Add a conclusion of the specified Type to the Rule.
Rule	addHypothesis(Type type) Add a hypothesis of the specified Type to the Rule.
Collection<Type>	getConclusionTypes() Retrieve a set of Types that constitue a part of the conclusion of the Rule.
Boolean	getExpectation() Returns a boolean representing the expectation setting of this Rule.
Collection<Type>	getHypothesisTypes() Retrieve a set of Types that constitute a part of the hypothesis of this Rule.
Pattern	getLHS() Retrieves the Left Hand Side of a Graql query.
Pattern	getRHS() Retrieves the Right Hand Side of a Graql query.
Boolean	isMaterialise() Returns whether the Rule is materialised.
Rule	setExpectation(boolean expectation) Set the expectation of this Rule to be true or false.
Rule	setMaterialise(boolean materialise) Sets whether the Rule should be materialised.
RuleType	type() Return the Type of the Concept.

Methods inherited from interface ai.grakn.concept.Instance

hasResource, playsRoles, relations, resources

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

setExpectation

Rule setExpectation(boolean expectation)

Set the expectation of this Rule to be true or false.

Parameters:

expectation - A boolean parameter representing the expectation setting.

Returns:

The Rule itself

setMaterialise

Rule setMaterialise(boolean materialise)

Sets whether the Rule should be materialised.

Parameters:

materialise - A boolean representing whether the Rule should be materialised.

Returns:

The Rule itself

getLHS

Pattern getLHS()

Retrieves the Left Hand Side of a Graql query.

Returns:

A string representing the left hand side Graql query.

getRHS

Pattern getRHS()

Retrieves the Right Hand Side of a Graql query.

Returns:

A string representing the right hand side Graql query.

getExpectation

Boolean getExpectation()

Returns a boolean representing the expectation setting of this Rule.

Returns:

a boolean representing the expectation setting.

isMaterialise

Boolean isMaterialise()

Returns whether the Rule is materialised.

Returns:

boolean value representing the materialisation setting.

addHypothesis

Rule addHypothesis(Type type)

Add a hypothesis of the specified Type to the Rule.

Parameters:

type - The Type which this Rule applies to.

Returns:

The Rule itself

addConclusion

Rule addConclusion(Type type)

Add a conclusion of the specified Type to the Rule.

Parameters:

type - The Type which is the conclusion of this Rule.

Returns:

The Rule itself

getHypothesisTypes

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

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: Instance

Return the Type of the Concept.

Specified by:

type in interface Instance

Returns:

The type of this Graql