Package org.drools.core.rule.accessor

Interface Accumulator

All Superinterfaces:

Invoker, RuleComponent

All Known Implementing Classes:

CollectAccumulator, JavaAccumulatorFunctionExecutor

public interface Accumulator
extends Invoker

Accumulator Created: 04/06/2006

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accumulate(java.lang.Object workingMemoryContext, java.lang.Object context, Tuple leftTuple, InternalFactHandle handle, Declaration[] declarations, Declaration[] innerDeclarations, ReteEvaluator reteEvaluator)	Executes the accumulate (action) code for the given fact handle
java.lang.Object	createContext()	Creates the context object for an accumulator session.
java.lang.Object	createWorkingMemoryContext()	Creates and return a context object for each working memory instance
default Declaration[]	getRequiredDeclarations()
java.lang.Object	getResult(java.lang.Object workingMemoryContext, java.lang.Object context, Tuple leftTuple, Declaration[] declarations, ReteEvaluator reteEvaluator)	Gets the result of the accummulation
java.lang.Object	init(java.lang.Object workingMemoryContext, java.lang.Object context, Tuple leftTuple, Declaration[] declarations, ReteEvaluator reteEvaluator)	Executes the initialization block of code
default void	replaceDeclaration(Declaration declaration, Declaration resolved)
boolean	supportsReverse()	Returns true if this accumulator supports operation reversal
boolean	tryReverse(java.lang.Object workingMemoryContext, java.lang.Object context, Tuple leftTuple, InternalFactHandle handle, java.lang.Object value, Declaration[] declarations, Declaration[] innerDeclarations, ReteEvaluator reteEvaluator)	Reverses the accumulate action for the given fact handle

Methods inherited from interface org.drools.core.rule.accessor.Invoker

wrapsCompiledInvoker

Method Detail

createWorkingMemoryContext

java.lang.Object createWorkingMemoryContext()

Creates and return a context object for each working memory instance

Returns:

createContext

java.lang.Object createContext()

Creates the context object for an accumulator session. The context is passed as a parameter to every subsequent accumulator method call in the same session.

Returns:

init

java.lang.Object init(java.lang.Object workingMemoryContext,
                      java.lang.Object context,
                      Tuple leftTuple,
                      Declaration[] declarations,
                      ReteEvaluator reteEvaluator)

Executes the initialization block of code

Parameters:

leftTuple - tuple causing the rule fire

declarations - previous declarations

reteEvaluator -

Throws:

java.lang.Exception

accumulate

java.lang.Object accumulate(java.lang.Object workingMemoryContext,
                            java.lang.Object context,
                            Tuple leftTuple,
                            InternalFactHandle handle,
                            Declaration[] declarations,
                            Declaration[] innerDeclarations,
                            ReteEvaluator reteEvaluator)

Executes the accumulate (action) code for the given fact handle

Parameters:

leftTuple -

handle -

declarations -

innerDeclarations -

reteEvaluator -

Throws:

java.lang.Exception

supportsReverse

boolean supportsReverse()

Returns true if this accumulator supports operation reversal

Returns:

tryReverse

boolean tryReverse(java.lang.Object workingMemoryContext,
                   java.lang.Object context,
                   Tuple leftTuple,
                   InternalFactHandle handle,
                   java.lang.Object value,
                   Declaration[] declarations,
                   Declaration[] innerDeclarations,
                   ReteEvaluator reteEvaluator)

Reverses the accumulate action for the given fact handle

Parameters:

context -

leftTuple -

handle -

declarations -

innerDeclarations -

reteEvaluator -

Throws:

java.lang.Exception

getResult

java.lang.Object getResult(java.lang.Object workingMemoryContext,
                           java.lang.Object context,
                           Tuple leftTuple,
                           Declaration[] declarations,
                           ReteEvaluator reteEvaluator)

Gets the result of the accummulation

Parameters:

leftTuple -

declarations -

reteEvaluator -

Returns:

Throws:

java.lang.Exception

replaceDeclaration

default void replaceDeclaration(Declaration declaration,
                                Declaration resolved)

getRequiredDeclarations

default Declaration[] getRequiredDeclarations()