Module org.evrete.core

Package org.evrete.util

Class KnowledgeWrapper

java.lang.Object

org.evrete.util.KnowledgeWrapper

All Implemented Interfaces:

Environment, EventBus, FluentEnvironment<Knowledge>, FluentImports<Knowledge>, Knowledge, Named, 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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KnowledgeWrapper(Knowledge delegate)

Method Summary

Modifier and Type	Method	Description
Knowledge	addImport(String imp)	Adds an import statement using its string representation.
RuleSetBuilder<Knowledge>	builder(ClassLoader classLoader)	Returns an instance of RuleSetBuilder for building and appending rules to the current context.
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()	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.
EvaluatorsContext	getEvaluatorsContext()	Return the condition manager associated with this context.
Imports	getImports()	Retrieves the current set of import statements.
String	getName()	Returns the name of the object.
Collection<String>	getPropertyNames()	Retrieves a collection of all property names in the environment.
<E extends ContextEvent> Events.Publisher<E>	getPublisher(Class<E> eventClass)	Returns a publisher for a specific event class type.
final RuleDescriptor	getRule(String name)	Retrieves a rule based on its name.
Comparator<Rule>	getRuleComparator()	Retrieves the comparator used for ordering rules.
final List<RuleDescriptor>	getRules()	Method returns a list of rules created so far.
KnowledgeService	getService()	Returns the KnowledgeService instance.
Collection<RuleSession<?>>	getSessions()	Retrieves a collection of active RuleSessions associated with the Knowledge.
TypeResolver	getTypeResolver()	Retrieves the TypeResolver instance associated with this RuntimeContext.
StatefulSession	newStatefulSession()
StatelessSession	newStatelessSession()
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)	Sets the Activation Manager factory class for this RuntimeContext.
void	setActivationManagerFactory(String managerClass)	Sets the Activation Manager factory class name for this RuntimeContext.
Knowledge	setActivationMode(ActivationMode activationMode)	Sets the activation mode for the session.
void	setRuleComparator(Comparator<Rule> comparator)	Sets the comparator used for ordering rules.

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.events.EventBus

getPublisher, subscribe, subscribe, subscribeAsync

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.Named

getName

Methods inherited from interface org.evrete.api.RuleSet

getRule, getRule, getRules, ruleExists

Methods inherited from interface org.evrete.api.RuntimeContext

builder, builder, configureTypes, getActivationManagerFactory, getClassLoader, getConfiguration, getEvaluatorsContext, getRuleComparator, getService, getTypeResolver, importRules, importRules, setActivationManagerFactory, setActivationManagerFactory, setActivationMode, setRuleComparator

Field Details

delegate

protected final Knowledge delegate

Constructor Details

KnowledgeWrapper

protected KnowledgeWrapper(Knowledge delegate)

Method Details

getSessions

public Collection<RuleSession<?>> getSessions()

Description copied from interface: Knowledge

Retrieves a collection of active RuleSessions associated with the Knowledge.

Specified by:

getSessions in interface Knowledge

Returns:

a collection of RuleSessions

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.

getName

public String getName()

Description copied from interface: Named

Returns the name of the object.

Specified by:

getName in interface Named

Returns:

the name of the object as a String

getRule

public final RuleDescriptor 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 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.

getPublisher

public <E extends ContextEvent> Events.Publisher<E> getPublisher(Class<E> eventClass)

Description copied from interface: EventBus

Returns a publisher for a specific event class type.

Specified by:

getPublisher in interface EventBus

Type Parameters:

E - the type of the event to publish

Parameters:

eventClass - the class object of the event type

Returns:

an Events.Publisher for the specified event class type

See Also:

• ContextEvent
• Events.Publisher

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

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

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.

builder

public RuleSetBuilder<Knowledge> builder(ClassLoader classLoader)

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

Parameters:

classLoader - the classloader to use.

Returns:

new instance of RuleSetBuilder.

setActivationMode

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

getEvaluatorsContext

public EvaluatorsContext getEvaluatorsContext()

Description copied from interface: RuntimeContext

Return the condition manager associated with this context.

Specified by:

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

Returns:

the evaluator context

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