Module org.evrete.core

Package org.evrete.util

Class AbstractSessionWrapper<S extends RuleSession<S>>

java.lang.Object

org.evrete.util.AbstractSessionWrapper<S>

Type Parameters:

S - the type of the RuleSession delegate object

All Implemented Interfaces:

Environment, EvaluationListeners, EvaluatorsContext, FluentEnvironment<S>, FluentImports<S>, RuleSession<S>, RuleSet<RuntimeRule>, RuleSetContext<S,RuntimeRule>, RuntimeContext<S>

public abstract class AbstractSessionWrapper<S extends RuleSession<S>>
extends Object
implements RuleSession<S>

This class provides an abstract implementation of the RuleSession interface, delegating the session's methods to a provided delegate object.

Field Summary

Fields

Modifier and Type	Field	Description
protected final S	delegate

Fields inherited from interface org.evrete.api.RuntimeContext

SALIENCE_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSessionWrapper(S delegate)

Method Summary

Modifier and Type	Method	Description
EvaluatorHandle	addEvaluator(Evaluator evaluator, double complexity)	Registers new condition evaluator and returns its handle.
S	addEventListener(SessionLifecycleListener listener)	Adds a session lifecycle listener to receive session lifecycle events.
S	addImport(String imp)	Adds an import statement using its string representation.
void	addListener(EvaluationListener listener)	Adds a listener to be notified of evaluation events.
<T> Collector<T,?,S>	asCollector()	A convenience method that returns an instance of Collector for inserting streams of facts.
RuleSetBuilder<S>	builder()	Returns an instance of RuleSetBuilder for building and appending rules to the current context.
Collection<LiteralEvaluator>	compile(Collection<LiteralExpression> expressions)	A convenience method for compiling literal expressions.
S	configureTypes(Consumer<TypeResolver> action)	Configures the TypeResolver by applying the given action.
<T> T	get(String property)	Retrieves the value of a property by its name.
ActivationManager	getActivationManager()	Retrieves the activation manager associated with this session.
Class<? extends ActivationManager>	getActivationManagerFactory()	Returns the Activation Manager factory class for this RuntimeContext.
ClassLoader	getClassLoader()	Retrieves the ClassLoader used by the current context.
Configuration	getConfiguration()	Retrieves the Configuration object associated with this RuntimeContext.
Evaluator	getEvaluator(EvaluatorHandle handle)	Returns evaluator by its handle.
ExpressionResolver	getExpressionResolver()	Retrieves the expression resolver for parsing string expressions.
Imports	getImports()	Retrieves the current set of import statements.
Knowledge	getParentContext()	Retrieves the parent context of this session instance.
Collection<String>	getPropertyNames()	Retrieves a collection of all property names in the environment.
final RuntimeRule	getRule(String name)	Retrieves a rule based on its name.
Comparator<Rule>	getRuleComparator()	Retrieves the comparator used for ordering rules.
final List<RuntimeRule>	getRules()	Method returns a list of rules created so far.
KnowledgeService	getService()	Returns the KnowledgeService instance.
JavaSourceCompiler	getSourceCompiler()	Creates and returns a new instance of JavaSourceCompiler.
TypeResolver	getTypeResolver()	Retrieves the TypeResolver instance associated with this RuntimeContext.
FactHandle	insert0(Object fact, boolean resolveCollections)	Inserts a fact in working memory and returns a serializable fact handle.
FactHandle	insert0(String type, Object fact, boolean resolveCollections)	Inserts a fact and explicitly specifies its Type name.
RuleBuilder<S>	newRule()	Deprecated.
RuleBuilder<S>	newRule(String name)	Deprecated.
S	removeEventListener(SessionLifecycleListener listener)	Removes a SessionLifecycleListener from the session.
void	removeListener(EvaluationListener listener)	Removes a previously added listener.
void	replaceEvaluator(EvaluatorHandle handle, Evaluator newEvaluator)	Replaces existing condition with a new one.
void	replaceEvaluator(EvaluatorHandle handle, ValuesPredicate predicate)	Replaces existing condition with a new one.
final FieldReference[]	resolveFieldReferences(String[] args, NamedType.Resolver typeMapper)
protected S	self()
S	set(String property, Object value)	Sets the specified property to the given value.
S	setActivationManager(ActivationManager activationManager)	Sets the activation manager for the session.
<A extends ActivationManager> void	setActivationManagerFactory(Class<A> managerClass)	Sets the Activation Manager factory class for this RuntimeContext.
void	setActivationManagerFactory(String managerClass)	Sets the Activation Manager factory class name for this RuntimeContext.
S	setActivationMode(ActivationMode activationMode)	Sets the activation mode for the session.
void	setClassLoader(ClassLoader classLoader)	Sets new parent classloader for this context's internal classloader.
S	setExecutionPredicate(BooleanSupplier criteria)	Session call's the supplier's BooleanSupplier.getAsBoolean() method prior to each activation cycle.
void	setRuleComparator(Comparator<Rule> comparator)	Sets the comparator used for ordering rules.
void	wrapTypeResolver(TypeResolverWrapper wrapper)	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.evrete.api.Environment

get, get, getPropertyNames

Methods inherited from interface org.evrete.api.EvaluationListeners

addListener, removeListener

Methods inherited from interface org.evrete.api.EvaluatorsContext

addEvaluator, addEvaluator, getEvaluator, replaceEvaluator, replaceEvaluator

Methods inherited from interface org.evrete.api.FluentEnvironment

set

Methods inherited from interface org.evrete.api.FluentImports

addImport, addImport, getImports, getJavaImports

Methods inherited from interface org.evrete.api.RuleSession

fire, insert, insert, insert, insertAs, insertAs, insertAs

Methods inherited from interface org.evrete.api.RuleSet

getRule, getRule, getRules, resolveFieldReferences, ruleExists, setRuleBuilderExceptionHandler

Methods inherited from interface org.evrete.api.RuntimeContext

builder, compile, compile, configureTypes, getActivationManagerFactory, getClassLoader, getConfiguration, getExpressionResolver, getRuleComparator, getService, getSourceCompiler, getTypeResolver, newRule, newRule, setActivationManagerFactory, setActivationManagerFactory, setActivationMode, setClassLoader, setRuleComparator, wrapTypeResolver

Field Details

delegate

protected final S extends RuleSession<S> delegate

Constructor Details

AbstractSessionWrapper

protected AbstractSessionWrapper(S delegate)

Method Details

getActivationManager

public ActivationManager getActivationManager()

Description copied from interface: RuleSession

Retrieves the activation manager associated with this session.

Specified by:

getActivationManager in interface RuleSession<S extends RuleSession<S>>

Returns:

the activation manager for this session

asCollector

public <T> Collector<T,?,S> asCollector()

Description copied from interface: RuleSession

A convenience method that returns an instance of Collector for inserting streams of facts.

Specified by:

asCollector in interface RuleSession<S extends RuleSession<S>>

Type Parameters:

T - the type of input elements to the reduction operation

Returns:

collector

setActivationManager

public S setActivationManager(ActivationManager activationManager)

Description copied from interface: RuleSession

Sets the activation manager for the session.

Specified by:

setActivationManager in interface RuleSession<S extends RuleSession<S>>

Parameters:

activationManager - the activation manager to set

Returns:

the current session instance

setExecutionPredicate

public S setExecutionPredicate(BooleanSupplier criteria)

Description copied from interface: RuleSession

Session call's the supplier's BooleanSupplier.getAsBoolean() method prior to each activation cycle. If the provided value is false then the cycle gets interrupted and session exits its fire(...) method.

Along with the ActivationManager, this method can be used to debug rules, to avoid infinite activation loops, or to prevent excessive consumption of computer resources.

Specified by:

setExecutionPredicate in interface RuleSession<S extends RuleSession<S>>

Parameters:

criteria - - boolean value supplier

Returns:

this session

addEventListener

public S addEventListener(SessionLifecycleListener listener)

Description copied from interface: RuleSession

Adds a session lifecycle listener to receive session lifecycle events.

Specified by:

addEventListener in interface RuleSession<S extends RuleSession<S>>

Parameters:

listener - the session lifecycle listener to add

Returns:

the current instance of the session

removeEventListener

public S removeEventListener(SessionLifecycleListener listener)

Description copied from interface: RuleSession

Removes a SessionLifecycleListener from the session.

Specified by:

removeEventListener in interface RuleSession<S extends RuleSession<S>>

Parameters:

listener - the SessionLifecycleListener to be removed

Returns:

the current instance of the session

getParentContext

public Knowledge getParentContext()

Description copied from interface: RuleSession

Retrieves the parent context of this session instance.

Specified by:

getParentContext in interface RuleSession<S extends RuleSession<S>>

Returns:

the parent context of this Knowledge instance

insert0

public FactHandle insert0(Object fact,
 boolean resolveCollections)

Description copied from interface: RuleSession

Inserts a fact in working memory and returns a serializable fact handle. When resolveCollections is set to true, and the fact is an Iterable or an Array, the engine will instead insert its components and return a null FactHandle.

Together with the RuleSession.insert0(String, Object, boolean) method, this operation constitutes the core insert operations that are actually implemented by the engine. The other insert methods are just convenience wrappers of the two.

Specified by:

insert0 in interface RuleSession<S extends RuleSession<S>>

Parameters:

fact - object to insert

resolveCollections - collection/array inspection flag

Returns:

fact handle assigned to the fact, or null if multiple facts were inserted

See Also:

• FactHandle

insert0

public FactHandle insert0(String type,
 Object fact,
 boolean resolveCollections)

Description copied from interface: RuleSession

Inserts a fact and explicitly specifies its Type name. When resolveCollections is set to true, and the fact is an Iterable or an Array, the engine will instead insert its components, and return a null FactHandle.

Together with the RuleSession.insert0(Object, boolean) method, this operation constitutes the core insert operations that are actually implemented by the engine. The other insert methods are just convenience wrappers of the two.

Specified by:

insert0 in interface RuleSession<S extends RuleSession<S>>

Parameters:

type - type name

fact - object to insert

resolveCollections - collection/array inspection flag

Returns:

fact handle assigned to the fact, or null if multiple facts were inserted

See Also:

• FactHandle

get

public <T> T get(String property)

Description copied from interface: Environment

Retrieves the value of a property by its name.

Specified by:

get in interface Environment

Type Parameters:

T - The expected type of the property value.

Parameters:

property - The name of the property to retrieve.

Returns:

The value of the property as type T, or null if it does not exist.

getPropertyNames

public Collection<String> getPropertyNames()

Description copied from interface: Environment

Retrieves a collection of all property names in the environment.

Specified by:

getPropertyNames in interface Environment

Returns:

A collection of strings representing all property names in the environment.

addListener

public void addListener(EvaluationListener listener)

Description copied from interface: EvaluationListeners

Adds a listener to be notified of evaluation events. If the listener is already added, behavior depends on the implementation.

Specified by:

addListener in interface EvaluationListeners

Parameters:

listener - the listener to add, not null.

removeListener

public void removeListener(EvaluationListener listener)

Description copied from interface: EvaluationListeners

Removes a previously added listener. If the listener is not registered, this method has no effect.

Specified by:

removeListener in interface EvaluationListeners

Parameters:

listener - the listener to remove, not null.

compile

public Collection<LiteralEvaluator> compile(Collection<LiteralExpression> expressions)
                                     throws CompilationException

Description copied from interface: RuntimeContext

A convenience method for compiling literal expressions.

Specified by:

compile in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

expressions - literal conditions and their context

Returns:

compiled literal conditions

Throws:

CompilationException - if the expression failed to compile

resolveFieldReferences

public final FieldReference[] resolveFieldReferences(String[] args,
 NamedType.Resolver typeMapper)

Specified by:

resolveFieldReferences in interface RuleSet<D extends RuleSetContext<C,R>>

getRule

public final RuntimeRule getRule(String name)

Description copied from interface: RuleSet

Retrieves a rule based on its name.

Specified by:

getRule in interface RuleSet<D extends RuleSetContext<C,R>>

Parameters:

name - the name of the rule to retrieve

Returns:

the rule with the specified name, or null if no rule with that name exists

set

public S set(String property,
 Object value)

Description copied from interface: FluentEnvironment

Sets the specified property to the given value.

Specified by:

set in interface Environment

Specified by:

set in interface FluentEnvironment<D extends RuleSetContext<C,R>>

Parameters:

property - the name of the property to set; should not be null.

value - the new value for the property; the actual type is determined by the implementation and the property being set.

Returns:

the current instance of X to allow for method chaining.

configureTypes

public S configureTypes(Consumer<TypeResolver> action)

Description copied from interface: RuntimeContext

Configures the TypeResolver by applying the given action.

Specified by:

configureTypes in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

action - the action to configure the TypeResolver

Returns:

this context

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Description copied from interface: RuntimeContext

Sets new parent classloader for this context's internal classloader.

Specified by:

setClassLoader in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

classLoader - this context's new parent classloader

self

protected S self()

addImport

public S addImport(String imp)

Description copied from interface: FluentImports

Adds an import statement using its string representation.

Specified by:

addImport in interface FluentImports<D extends RuleSetContext<C,R>>

Parameters:

imp - the full canonical name of the class or package to be imported

Returns:

this instance to allow for method chaining

getRules

public final List<RuntimeRule> getRules()

Description copied from interface: RuleSet

Method returns a list of rules created so far.

Specified by:

getRules in interface RuleSet<D extends RuleSetContext<C,R>>

Returns:

list of currently known rules

getImports

public Imports getImports()

Description copied from interface: FluentImports

Retrieves the current set of import statements.

Specified by:

getImports in interface FluentImports<D extends RuleSetContext<C,R>>

Returns:

an Imports object containing the current set of import statements

getRuleComparator

public Comparator<Rule> getRuleComparator()

Description copied from interface: RuntimeContext

Retrieves the comparator used for ordering rules.

Specified by:

getRuleComparator in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

the comparator for Rule objects.

setRuleComparator

public void setRuleComparator(Comparator<Rule> comparator)

Description copied from interface: RuntimeContext

Sets the comparator used for ordering rules.

Specified by:

setRuleComparator in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

comparator - the comparator for Rule objects.

newRule

@Deprecated
public RuleBuilder<S> newRule(String name)

Deprecated.

Description copied from interface: RuntimeContext

Creates a new rule with the provided name.

Specified by:

newRule in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

name - rule name

Returns:

a new rule builder

newRule

@Deprecated
public RuleBuilder<S> newRule()

Deprecated.

Description copied from interface: RuntimeContext

Creates a new unnamed rule.

Specified by:

newRule in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

a new rule builder

builder

public RuleSetBuilder<S> builder()

Description copied from interface: RuntimeContext

Returns an instance of RuleSetBuilder for building and appending rules to the current context.

Builder MUST be terminated with the RuleSetBuilder.build() call for changes to take effect.

Usage BEFORE 3.1.00:

 
 service
      .newKnowledge()
      .newRule()
      .forEach("$a", A.class)
      .where("$a.active")
      .execute();
 
 

Usage AFTER 3.1.00:

 
 service
      .newKnowledge()
      .builder()       // !! important
      .newRule()
      .forEach("$a", A.class)
      .where("$a.active")
      .execute()
      .build();        // !! important
 
 

Specified by:

builder in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

new instance of RuleSetBuilder.

wrapTypeResolver

@Deprecated
public void wrapTypeResolver(TypeResolverWrapper wrapper)

Deprecated.

Description copied from interface: RuntimeContext

Wraps the provided TypeResolver with a TypeResolverWrapper instance.

Specified by:

wrapTypeResolver in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

wrapper - the TypeResolverWrapper instance used to wrap the TypeResolver

setActivationMode

public S setActivationMode(ActivationMode activationMode)

Description copied from interface: RuntimeContext

Sets the activation mode for the session.

Specified by:

setActivationMode in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

activationMode - the activation mode to set

Returns:

the updated instance of the class

addEvaluator

public EvaluatorHandle addEvaluator(Evaluator evaluator,
 double complexity)

Description copied from interface: EvaluatorsContext

Registers new condition evaluator and returns its handle. If an existing Evaluator matches the argument (Evaluator.compare(Evaluator) returns Evaluator.RELATION_EQUALS), the existing evaluator handle will be returned instead and no changes will be made in the context.

Specified by:

addEvaluator in interface EvaluatorsContext

Parameters:

evaluator - condition to add

complexity - condition's relative complexity

Returns:

new EvaluatorHandle or the one of an existing condition.

replaceEvaluator

public void replaceEvaluator(EvaluatorHandle handle,
 Evaluator newEvaluator)

Description copied from interface: EvaluatorsContext

Replaces existing condition with a new one. New condition must have the same Evaluator.descriptor(), otherwise IllegalArgumentException will be thrown.

Specified by:

replaceEvaluator in interface EvaluatorsContext

Parameters:

handle - handle of an existing condition

newEvaluator - new condition

getEvaluator

public Evaluator getEvaluator(EvaluatorHandle handle)

Description copied from interface: EvaluatorsContext

Returns evaluator by its handle.

Specified by:

getEvaluator in interface EvaluatorsContext

Parameters:

handle - evaluator handle

Returns:

existing condition evaluator or null if such condition does not exist

replaceEvaluator

public void replaceEvaluator(EvaluatorHandle handle,
 ValuesPredicate predicate)

Description copied from interface: EvaluatorsContext

Replaces existing condition with a new one.

Specified by:

replaceEvaluator in interface EvaluatorsContext

Parameters:

handle - handle of an existing condition

predicate - new condition in a form if ValuesPredicate

getExpressionResolver

public ExpressionResolver getExpressionResolver()

Description copied from interface: RuntimeContext

Retrieves the expression resolver for parsing string expressions.

Specified by:

getExpressionResolver in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

the expression resolver

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: RuntimeContext

Retrieves the ClassLoader used by the current context.

Specified by:

getClassLoader in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

the ClassLoader used by the object.

getService

public KnowledgeService getService()

Description copied from interface: RuntimeContext

Returns the KnowledgeService instance.

Specified by:

getService in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

the KnowledgeService instance

getActivationManagerFactory

public Class<? extends ActivationManager> getActivationManagerFactory()

Description copied from interface: RuntimeContext

Returns the Activation Manager factory class for this RuntimeContext.

Specified by:

getActivationManagerFactory in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

the Activation Manager factory class

setActivationManagerFactory

public <A extends ActivationManager> void setActivationManagerFactory(Class<A> managerClass)

Description copied from interface: RuntimeContext

Sets the Activation Manager factory class for this RuntimeContext.

Specified by:

setActivationManagerFactory in interface RuntimeContext<D extends RuleSetContext<C,R>>

Type Parameters:

A - the type of Activation Manager

Parameters:

managerClass - the Activation Manager factory class

setActivationManagerFactory

public void setActivationManagerFactory(String managerClass)

Description copied from interface: RuntimeContext

Sets the Activation Manager factory class name for this RuntimeContext.

Specified by:

setActivationManagerFactory in interface RuntimeContext<D extends RuleSetContext<C,R>>

Parameters:

managerClass - the Activation Manager factory class name

getTypeResolver

public TypeResolver getTypeResolver()

Description copied from interface: RuntimeContext

Retrieves the TypeResolver instance associated with this RuntimeContext.

Specified by:

getTypeResolver in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

the TypeResolver instance

getConfiguration

public Configuration getConfiguration()

Description copied from interface: RuntimeContext

Retrieves the Configuration object associated with this RuntimeContext.

Specified by:

getConfiguration in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

the Configuration object

getSourceCompiler

public JavaSourceCompiler getSourceCompiler()

Description copied from interface: RuntimeContext

Creates and returns a new instance of JavaSourceCompiler.

Specified by:

getSourceCompiler in interface RuntimeContext<D extends RuleSetContext<C,R>>

Returns:

A new JavaSourceCompiler instance.