Module org.evrete.core

Package org.evrete.api.builders

Interface RuleBuilder<C extends RuntimeContext<C>>

Type Parameters:

C - the type of the RuntimeContext of the builder

All Superinterfaces:

Environment, FluentEnvironment<Rule>, LhsFactSelector<LhsBuilder<C>>, Named, NamedType.Resolver, Rule

public interface RuleBuilder<C extends RuntimeContext<C>>
extends Rule, LhsFactSelector<LhsBuilder<C>>

The RuleBuilder interface represents a builder for creating rules.

Method Summary

Modifier and Type	Method	Description
default EvaluatorHandle	createCondition(String expression)	Compiles and registers the provided predicate with the current context (a Knowledge or a RuleSession).
EvaluatorHandle	createCondition(String expression, double complexity)	Compiles and registers the provided predicate with the current context (a Knowledge or a RuleSession).
EvaluatorHandle	createCondition(Predicate<Object[]> predicate, double complexity, String... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
EvaluatorHandle	createCondition(Predicate<Object[]> predicate, double complexity, FieldReference... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
default EvaluatorHandle	createCondition(Predicate<Object[]> predicate, String... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
default EvaluatorHandle	createCondition(Predicate<Object[]> predicate, FieldReference... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
EvaluatorHandle	createCondition(ValuesPredicate predicate, double complexity, String... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
EvaluatorHandle	createCondition(ValuesPredicate predicate, double complexity, FieldReference... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
default EvaluatorHandle	createCondition(ValuesPredicate predicate, String... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
default EvaluatorHandle	createCondition(ValuesPredicate predicate, FieldReference... references)	Registers the provided predicate with the current context (a Knowledge or a RuleSession).
LhsBuilder<C>	getLhs()	Returns the LhsBuilder instance.
C	getRuntime()	Returns the runtime context of this rule builder.
<Z> RuleBuilder<C>	property(String property, Z value)	Sets a property of the RuleBuilder instance.
RuleBuilder<C>	salience(int salience)	Sets the salience of the rule.

Methods inherited from interface org.evrete.api.Environment

get, get, getPropertyNames

Methods inherited from interface org.evrete.api.FluentEnvironment

set

Methods inherited from interface org.evrete.api.LhsFactSelector

forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach

Methods inherited from interface org.evrete.api.Named

getName

Methods inherited from interface org.evrete.api.NamedType.Resolver

getDeclaredFactTypes, resolve

Methods inherited from interface org.evrete.api.Rule

chainRhs, getRhs, getSalience, setName, setRhs, setRhs, setSalience

Method Details

getLhs

LhsBuilder<C> getLhs()

Returns the LhsBuilder instance.

Returns:

the LhsBuilder instance

salience

RuleBuilder<C> salience(int salience)

Sets the salience of the rule.

Parameters:

salience - the salience value of the rule

Returns:

a RuleBuilder instance

property

<Z> RuleBuilder<C> property(String property,
 Z value)

Sets a property of the RuleBuilder instance.

Type Parameters:

Z - the type of the property value

Parameters:

property - the name of the property

value - the value of the property

Returns:

a RuleBuilder instance

getRuntime

C getRuntime()

Returns the runtime context of this rule builder.

Returns:

the runtime object

createCondition

default EvaluatorHandle createCondition(ValuesPredicate predicate,
 FieldReference... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

predicate - condition predicate

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

default EvaluatorHandle createCondition(ValuesPredicate predicate,
 String... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

predicate - condition predicate

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

default EvaluatorHandle createCondition(Predicate<Object[]> predicate,
 FieldReference... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or used in the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace existing conditions on the fly.

Parameters:

predicate - condition predicate

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

default EvaluatorHandle createCondition(Predicate<Object[]> predicate,
 String... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

predicate - condition predicate

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

EvaluatorHandle createCondition(String expression,
 double complexity)
                         throws CompilationException

Compiles and registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

expression - literal condition

complexity - condition's relative complexity

Returns:

evaluator handle

Throws:

CompilationException - if the engine fails to compile the expression

See Also:

• WorkUnit

createCondition

EvaluatorHandle createCondition(ValuesPredicate predicate,
 double complexity,
 String... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

predicate - condition predicate

complexity - condition's relative complexity

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

EvaluatorHandle createCondition(Predicate<Object[]> predicate,
 double complexity,
 String... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

predicate - condition predicate

complexity - condition's relative complexity

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

EvaluatorHandle createCondition(ValuesPredicate predicate,
 double complexity,
 FieldReference... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

predicate - condition predicate

complexity - condition's relative complexity

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

EvaluatorHandle createCondition(Predicate<Object[]> predicate,
 double complexity,
 FieldReference... references)

Registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

predicate - condition predicate

complexity - condition's relative complexity

references - field references

Returns:

evaluator handle

See Also:

• FieldReference
• WorkUnit

createCondition

default EvaluatorHandle createCondition(String expression)
                                 throws CompilationException

Compiles and registers the provided predicate with the current context (a Knowledge or a RuleSession). The resulting EvaluatorHandle can later be used in the LhsBuilder.where(EvaluatorHandle...) code blocks, shared among other rules (if appropriate), or provided to the EvaluatorsContext.replaceEvaluator(EvaluatorHandle, Evaluator) and EvaluatorsContext.replaceEvaluator(EvaluatorHandle, ValuesPredicate) methods to replace conditions on the fly.

Parameters:

expression - literal condition

Returns:

evaluator handle

Throws:

CompilationException - if the engine fails to compile the expression

See Also:

• WorkUnit