Module org.evrete.core

Package org.evrete.util

Class KnowledgeWrapper

java.lang.Object

org.evrete.util.KnowledgeWrapper

All Implemented Interfaces:

Environment, EvaluationListeners, EvaluatorsContext, FluentEnvironment<Knowledge>, FluentImports<Knowledge>, Knowledge, RuleSet<RuleDescriptor>, RuleSetContext<Knowledge,RuleDescriptor>, RuntimeContext<Knowledge>

public abstract class KnowledgeWrapper
extends Object
implements Knowledge

KnowledgeWrapper is an abstract class that delegates the knowledge's methods to a provided delegate object.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Knowledge	delegate

Fields inherited from interface org.evrete.api.RuntimeContext

SALIENCE_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KnowledgeWrapper(Knowledge delegate)

Method Summary

Modifier and Type	Method	Description
EvaluatorHandle	addEvaluator(Evaluator evaluator, double complexity)	Registers new condition evaluator and returns its handle.
Knowledge	addImport(String imp)	Adds an import statement using its string representation.
void	addListener(EvaluationListener listener)	Adds a listener to be notified of evaluation events.
RuleSetBuilder<Knowledge>	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.
Knowledge	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.
Class<? extends ActivationManager>	getActivationManagerFactory()
ClassLoader	getClassLoader()
Configuration	getConfiguration()
Evaluator	getEvaluator(EvaluatorHandle handle)	Returns evaluator by its handle.
ExpressionResolver	getExpressionResolver()
Imports	getImports()	Retrieves the current set of import statements.
Collection<String>	getPropertyNames()	Retrieves a collection of all property names in the environment.
final RuleDescriptor	getRule(String name)
Comparator<Rule>	getRuleComparator()
final List<RuleDescriptor>	getRules()	Method returns a list of rules created so far.
KnowledgeService	getService()
Collection<RuleSession<?>>	getSessions()
JavaSourceCompiler	getSourceCompiler()
TypeResolver	getTypeResolver()
RuleBuilder<Knowledge>	newRule()	Deprecated.
RuleBuilder<Knowledge>	newRule(String name)	Deprecated.
StatefulSession	newStatefulSession()
StatelessSession	newStatelessSession()
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 Knowledge	self()
Knowledge	set(String property, Object value)	Sets the specified property to the given value.
<A extends ActivationManager> void	setActivationManagerFactory(Class<A> managerClass)
void	setActivationManagerFactory(String managerClass)
Knowledge	setActivationMode(ActivationMode activationMode)
void	setClassLoader(ClassLoader classLoader)	Sets new parent classloader for this context's internal classloader.
void	setRuleComparator(Comparator<Rule> comparator)
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.Knowledge

activationManager, newStatefulSession, newStatelessSession

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 Knowledge delegate

Constructor Details

KnowledgeWrapper

protected KnowledgeWrapper(Knowledge delegate)

Method Details

getSessions

public Collection<RuleSession<?>> getSessions()

Specified by:

getSessions in interface Knowledge

newStatefulSession

public StatefulSession newStatefulSession()

Specified by:

newStatefulSession in interface Knowledge

Returns:

new stateful session

newStatelessSession

public StatelessSession newStatelessSession()

Specified by:

newStatelessSession in interface Knowledge

Returns:

new stateless session

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 RuleDescriptor getRule(String name)

Specified by:

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

set

public Knowledge 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 Knowledge 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 Knowledge self()

addImport

public Knowledge 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<RuleDescriptor> 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()

Specified by:

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

setRuleComparator

public void setRuleComparator(Comparator<Rule> comparator)

Specified by:

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

newRule

@Deprecated
public RuleBuilder<Knowledge> 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<Knowledge> 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<Knowledge> 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 Knowledge setActivationMode(ActivationMode activationMode)

Specified by:

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

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()

Specified by:

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

getClassLoader

public ClassLoader getClassLoader()

Specified by:

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

getService

public KnowledgeService getService()

Specified by:

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

getActivationManagerFactory

public Class<? extends ActivationManager> getActivationManagerFactory()

Specified by:

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

setActivationManagerFactory

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

Specified by:

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

setActivationManagerFactory

public void setActivationManagerFactory(String managerClass)

Specified by:

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

getTypeResolver

public TypeResolver getTypeResolver()

Specified by:

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

getConfiguration

public Configuration getConfiguration()

Specified by:

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

getSourceCompiler

public JavaSourceCompiler getSourceCompiler()

Specified by:

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