Package org.evrete.api

Interface StatefulSession

All Superinterfaces:

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

public interface StatefulSession
extends RuleSession<StatefulSession>, AutoCloseable

Field Summary

Fields inherited from interface org.evrete.api.RuntimeContext

SALIENCE_COMPARATOR

Method Summary

Modifier and Type	Method	Description
void	clear()	This method clears session's working memory and its beta-memory nodes as if the session had never been used.
void	close()	Closes the session and destroys its memory.
StatefulSession	delete(FactHandle handle)	Deletes a fact from working memory.
StatefulSession	fire()	Fire all rules.
default Future<StatefulSession>	fireAsync()	Same as fireAsync(Object), with the Future's get method will returning the session itself.
<T> Future<T>	fireAsync(T result)	Fires session asynchronously and returns a Future representing the session execution status.
default <T> StatefulSession	forEachFact(Class<T> type, Consumer<T> consumer)	A memory inspection method that accepts fact type as an argument.
default <T> StatefulSession	forEachFact(Class<T> type, Predicate<T> filter, Consumer<T> consumer)	A filtering version of the forEachFact(Class, Consumer) method.
<T> StatefulSession	forEachFact(String type, Consumer<T> consumer)	A memory inspection method that accepts fact type as an argument.
default <T> StatefulSession	forEachFact(String type, Predicate<T> filter, Consumer<T> consumer)	A filtering version of the forEachFact(String, Consumer) method.
StatefulSession	forEachFact(BiConsumer<FactHandle,Object> consumer)	A full-scan memory inspection method.
default StatefulSession	forEachFact(BiPredicate<FactHandle,Object> filter, BiConsumer<FactHandle,Object> consumer)
default StatefulSession	forEachFact(Consumer<Object> consumer)
<T> T	getFact(FactHandle handle)	Returns fact by its handle.
default StatefulSession	insertAndFire(Iterable<?> objects)
default StatefulSession	insertAndFire(Object... objects)
StatefulSession	update(FactHandle handle, Object newValue)	Updates a fact that already exists in the working memory

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

addEventListener, asCollector, getActivationManager, getParentContext, insert, insert, insert, insert0, insert0, insertAs, insertAs, insertAs, removeEventListener, setActivationManager, setExecutionPredicate

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, getActivationManagerFactory, getClassLoader, getConfiguration, getExpressionResolver, getRuleComparator, getService, getSourceCompiler, getTypeResolver, newRule, newRule, setActivationManagerFactory, setActivationManagerFactory, setActivationMode, setClassLoader, setRuleComparator, wrapTypeResolver

Method Detail

fire

StatefulSession fire()

Fire all rules.

Specified by:

fire in interface RuleSession<StatefulSession>

update

StatefulSession update(FactHandle handle,
                       Object newValue)

Updates a fact that already exists in the working memory

Parameters:

handle - fact handle, previously assigned to original fact

newValue - an updated version of the fact

delete

StatefulSession delete(FactHandle handle)

Deletes a fact from working memory.

Parameters:

handle - fact handle

getFact

<T> T getFact(FactHandle handle)

Returns fact by its handle.

Type Parameters:

T - type of the fact (use Object or wildcard if type is unknown)

Parameters:

handle - fact handle

Returns:

fact or null if fact is not found

fireAsync

<T> Future<T> fireAsync(T result)

Fires session asynchronously and returns a Future representing the session execution status.

Type Parameters:

T - result type parameter

Parameters:

result - the result to return by the Future

Returns:

a Future representing pending completion of the fire() command

Throws:

RejectedExecutionException - if the task cannot be scheduled for execution

fireAsync

default Future<StatefulSession> fireAsync()

Same as fireAsync(Object), with the Future's get method will returning the session itself.

Returns:

a Future representing pending completion of the fire() command.

Throws:

RejectedExecutionException - if the task cannot be scheduled for execution

See Also:

fireAsync(Object)

close

void close()

Closes the session and destroys its memory. A closed session can not be reused.

Specified by:

close in interface AutoCloseable

clear

void clear()

This method clears session's working memory and its beta-memory nodes as if the session had never been used.

forEachFact

StatefulSession forEachFact(BiConsumer<FactHandle,Object> consumer)

A full-scan memory inspection method.

Parameters:

consumer - consumer for the facts

forEachFact

default StatefulSession forEachFact(BiPredicate<FactHandle,Object> filter,
                                    BiConsumer<FactHandle,Object> consumer)

forEachFact

default StatefulSession forEachFact(Consumer<Object> consumer)

forEachFact

default <T> StatefulSession forEachFact(Class<T> type,
                                        Consumer<T> consumer)

A memory inspection method that accepts fact type as an argument.

Type Parameters:

T - expected java type for the provided type name

Parameters:

type - expected fact type

consumer - consumer for the facts

Throws:

ClassCastException - if a working memory object can not be cast to the specified type

IllegalArgumentException - if no such type exists

See Also:

TypeResolver

forEachFact

<T> StatefulSession forEachFact(String type,
                                Consumer<T> consumer)

A memory inspection method that accepts fact type as an argument. Type name can be either a class name or a name of explicitly declared type. In the latter case, the generic type parameter T must match the declared type's Java type (see Type.getJavaType())

Type Parameters:

T - expected java type for the provided type name

Parameters:

type - type name

consumer - consumer for the facts

Throws:

ClassCastException - if a working memory object can not be cast to the specified type

IllegalArgumentException - if no such type exists

See Also:

TypeResolver

forEachFact

default <T> StatefulSession forEachFact(Class<T> type,
                                        Predicate<T> filter,
                                        Consumer<T> consumer)

A filtering version of the forEachFact(Class, Consumer) method.

Type Parameters:

T - expected java type for the provided type name

Parameters:

type - expected fact type

consumer - consumer for the facts

filter - filtering predicate

See Also:

forEachFact(Class, Consumer)

forEachFact

default <T> StatefulSession forEachFact(String type,
                                        Predicate<T> filter,
                                        Consumer<T> consumer)

A filtering version of the forEachFact(String, Consumer) method.

Type Parameters:

T - expected java type for the provided type name

Parameters:

type - expected fact type

consumer - consumer for the facts

filter - filtering predicate

See Also:

forEachFact(String, Consumer)

insertAndFire

default StatefulSession insertAndFire(Iterable<?> objects)

insertAndFire

default StatefulSession insertAndFire(Object... objects)