Package org.drools.core.base.accumulators

Class CollectAccumulator

java.lang.Object

org.drools.core.base.accumulators.CollectAccumulator

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, Accumulator, Invoker, RuleComponent

public class CollectAccumulator
extends java.lang.Object
implements Accumulator, java.io.Externalizable

An accumulator to execute "collect" CEs

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CollectAccumulator()
CollectAccumulator(Collect collect, boolean unwrapHandle)

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
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
void	readExternal(java.io.ObjectInput in)
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
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getRequiredDeclarations, replaceDeclaration

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

wrapsCompiledInvoker

Constructor Detail

CollectAccumulator

public CollectAccumulator()

CollectAccumulator

public CollectAccumulator(Collect collect,
                          boolean unwrapHandle)

Method Detail

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

createContext

public java.lang.Object createContext()

Description copied from interface: Accumulator

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.

Specified by:

createContext in interface Accumulator

Returns:

init

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

Description copied from interface: Accumulator

Executes the initialization block of code

Specified by:

init in interface Accumulator

leftTuple - tuple causing the rule fire

declarations - previous declarations

accumulate

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

Description copied from interface: Accumulator

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

Specified by:

accumulate in interface Accumulator

tryReverse

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

Description copied from interface: Accumulator

Reverses the accumulate action for the given fact handle

Specified by:

tryReverse in interface Accumulator

getResult

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

Description copied from interface: Accumulator

Gets the result of the accummulation

Specified by:

getResult in interface Accumulator

Returns:

supportsReverse

public boolean supportsReverse()

Description copied from interface: Accumulator

Returns true if this accumulator supports operation reversal

Specified by:

supportsReverse in interface Accumulator

Returns:

createWorkingMemoryContext

public java.lang.Object createWorkingMemoryContext()

Description copied from interface: Accumulator

Creates and return a context object for each working memory instance

Specified by:

createWorkingMemoryContext in interface Accumulator

Returns: