Package tools.refinery.interpreter.rete.aggregation

Class IndexerBasedAggregatorNode

java.lang.Object

tools.refinery.interpreter.rete.network.BaseNode

tools.refinery.interpreter.rete.network.StandardNode

tools.refinery.interpreter.rete.aggregation.IndexerBasedAggregatorNode

All Implemented Interfaces:

IAggregatorNode, NetworkStructureChangeSensitiveNode, Node, Supplier

Direct Known Subclasses:

CountNode

public abstract class IndexerBasedAggregatorNode
extends StandardNode
implements IAggregatorNode

A special node depending on a projection indexer to aggregate tuple groups with the same projection. Only propagates the aggregates of non-empty groups. Use the outer indexers to circumvent.

This node cannot be used in recursive differential dataflow evaluation.

Since:

1.4

Field Summary

Fields inherited from class tools.refinery.interpreter.rete.network.StandardNode

childMailboxes, children

Fields inherited from class tools.refinery.interpreter.rete.network.BaseNode

nodeId, reteContainer, tag, traceInfos

Constructor Summary

Constructors

Constructor	Description
IndexerBasedAggregatorNode(ReteContainer reteContainer)	MUST call initializeWith() afterwards!

Method Summary

Modifier and Type	Method	Description
protected Tuple	aggregateAndPack(Tuple signature, Collection<Tuple> group)
abstract Object	aggregateGroup(Tuple signature, Collection<Tuple> group)	Aggregates (reduces) a group of tuples.
Object	aggregateGroupAfterUpdate(Tuple signature, Collection<Tuple> currentGroup, Object oldAggregate, Direction direction, Tuple updateElement, boolean change)	Aggregates (reduces) a group of tuples, having access to the previous aggregated value (before the update) and the update definition.
protected void	aggregateUpdate(Direction direction, Tuple updateElement, Tuple signature, boolean change)
void	assignTraceInfo(TraceInfo traceInfo)	assigns new traceability info to this node
Indexer	getAggregatorOuterIdentityIndexer(int resultPositionInSignature)
Indexer	getAggregatorOuterIndexer()
void	initializeWith(ProjectionIndexer projection)
void	networkStructureChanged()	At the time of the invocation, the dependency graph has already been updated.
protected Tuple	packResult(Tuple signature, Object result)
void	pullInto(Collection<Tuple> collector, boolean flush)	Pulls the contents of this object in this particular moment into a target collection.
void	pullIntoWithTimeline(Map<Tuple,Timeline<Timestamp>> collector, boolean flush)

Methods inherited from class tools.refinery.interpreter.rete.network.StandardNode

appendChild, constructIndex, getChildMailboxes, getPulledContents, getReceivers, issueError, propagateUpdate, removeChild

Methods inherited from class tools.refinery.interpreter.rete.network.BaseNode

acceptPropagatedTraceInfo, getContainer, getNodeId, getTag, getTraceInfoPatternsEnumerated, getTraceInfos, setTag, toString, toStringCore

Methods inherited from class java.lang.Object

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

Methods inherited from interface tools.refinery.interpreter.rete.network.Node

acceptPropagatedTraceInfo, getCommunicationTracker, getContainer, getNodeId, getTag, getTraceInfos, setTag

Methods inherited from interface tools.refinery.interpreter.rete.network.Supplier

getPulledContents

Constructor Details

IndexerBasedAggregatorNode

public IndexerBasedAggregatorNode(ReteContainer reteContainer)

MUST call initializeWith() afterwards!

Method Details

networkStructureChanged

public void networkStructureChanged()

Description copied from interface: NetworkStructureChangeSensitiveNode

At the time of the invocation, the dependency graph has already been updated.

Specified by:

networkStructureChanged in interface NetworkStructureChangeSensitiveNode

Overrides:

networkStructureChanged in class StandardNode

initializeWith

public void initializeWith(ProjectionIndexer projection)

Parameters:

projection - the projection indexer whose tuple groups should be aggregated

aggregateGroup

public abstract Object aggregateGroup(Tuple signature,
 Collection<Tuple> group)

Aggregates (reduces) a group of tuples. The group can be null.

aggregateGroupAfterUpdate

public Object aggregateGroupAfterUpdate(Tuple signature,
 Collection<Tuple> currentGroup,
 Object oldAggregate,
 Direction direction,
 Tuple updateElement,
 boolean change)

Aggregates (reduces) a group of tuples, having access to the previous aggregated value (before the update) and the update definition. Defaults to aggregateGroup(). Override to increase performance.

Since:

2.4

aggregateAndPack

protected Tuple aggregateAndPack(Tuple signature,
 Collection<Tuple> group)

getAggregatorOuterIndexer

public Indexer getAggregatorOuterIndexer()

Specified by:

getAggregatorOuterIndexer in interface IAggregatorNode

getAggregatorOuterIdentityIndexer

public Indexer getAggregatorOuterIdentityIndexer(int resultPositionInSignature)

Specified by:

getAggregatorOuterIdentityIndexer in interface IAggregatorNode

pullInto

public void pullInto(Collection<Tuple> collector,
 boolean flush)

Description copied from interface: Supplier

Pulls the contents of this object in this particular moment into a target collection.

Specified by:

pullInto in interface Supplier

Parameters:

flush - if true, flushing of messages is allowed during the pull, otherwise flushing is not allowed

pullIntoWithTimeline

public void pullIntoWithTimeline(Map<Tuple,Timeline<Timestamp>> collector,
 boolean flush)

Specified by:

pullIntoWithTimeline in interface Supplier

packResult

protected Tuple packResult(Tuple signature,
 Object result)

aggregateUpdate

protected void aggregateUpdate(Direction direction,
 Tuple updateElement,
 Tuple signature,
 boolean change)

Since:

2.4

assignTraceInfo

public void assignTraceInfo(TraceInfo traceInfo)

Description copied from interface: Node

assigns new traceability info to this node

Specified by:

assignTraceInfo in interface Node

Overrides:

assignTraceInfo in class BaseNode