Module org.evrete.core

Package org.evrete.api

Interface StatefulSession

All Superinterfaces:

AutoCloseable, Environment, EventBus, FluentEnvironment<StatefulSession>, FluentImports<StatefulSession>, MemoryStreaming, Named, RuleSession<StatefulSession>, RuleSet<RuntimeRule>, RuleSetContext<StatefulSession,RuntimeRule>, RuntimeContext<StatefulSession>, SessionOps

public interface StatefulSession
extends RuleSession<StatefulSession>, AutoCloseable

The StatefulSession interface represents a stateful rule session.

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	fire()	Fire all rules.
default Future<StatefulSession>	fireAsync()	Deprecated. Use external tools like ExecutorService.submit(Runnable, Object).
default <T> Future<T>	fireAsync(T result)	Deprecated. Use external tools like ExecutorService.submit(Runnable, Object).
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.
default <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.
default 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)
default StatefulSession	insertAndFire(Iterable<?> objects)
default StatefulSession	insertAndFire(Object... objects)

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

streamFactEntries, streamFactEntries, streamFactEntries, streamFacts, streamFacts, streamFacts

Methods inherited from interface org.evrete.api.Named

getName

Methods inherited from interface org.evrete.api.RuleSession

addEventListener, asCollector, getActivationManager, getFact, getParentContext, insert, insert, insertAs, insertAs, removeEventListener, setActivationManager

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

Methods inherited from interface org.evrete.api.SessionOps

delete, insert, insert0, insert0, insertAs, update

Method Details

fire

StatefulSession fire()

Fire all rules.

Specified by:

fire in interface RuleSession<StatefulSession>

Returns:

an object representing the result of the rule session execution.

fireAsync

@Deprecated
default <T> Future<T> fireAsync(T result)

Deprecated.

Use external tools like ExecutorService.submit(Runnable, Object).

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

Type Parameters:

T - the result type parameter

Parameters:

result - the result to return by the Future

Returns:

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

fireAsync

@Deprecated
default Future<StatefulSession> fireAsync()

Deprecated.

Use external tools like ExecutorService.submit(Runnable, Object).

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

Returns:

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

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

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

A full-scan memory inspection method.

Parameters:

consumer - consumer for the facts

Returns:

this instance

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

Returns:

this instance

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

Type Parameters:

T - expected java type for the provided type name

Parameters:

type - type name

consumer - consumer for the facts

Returns:

this instance

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

Returns:

this instance

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

Returns:

new stateful session instance

See Also:

• forEachFact(String, Consumer)

insertAndFire

default StatefulSession insertAndFire(Iterable<?> objects)

insertAndFire

default StatefulSession insertAndFire(Object... objects)