Package tools.refinery.interpreter.rete.aggregation.timely

Class FaithfulTimelyColumnAggregatorNode<Domain,Accumulator,AggregateResult,CumulativeAggregate,FoldingState extends FaithfulTimelyColumnAggregatorNode.MergeableFoldingState<FoldingState>>

java.lang.Object

tools.refinery.interpreter.rete.network.BaseNode

tools.refinery.interpreter.rete.network.StandardNode

tools.refinery.interpreter.rete.single.SingleInputNode

tools.refinery.interpreter.rete.aggregation.AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>

tools.refinery.interpreter.rete.aggregation.timely.FaithfulTimelyColumnAggregatorNode<Domain,Accumulator,AggregateResult,CumulativeAggregate,FoldingState>

All Implemented Interfaces:

Clearable, IAggregatorNode, ResumableNode, IGroupable, NetworkStructureChangeSensitiveNode, Node, Receiver, Supplier, Tunnel

Direct Known Subclasses:

FaithfulParallelTimelyColumnAggregatorNode, FaithfulSequentialTimelyColumnAggregatorNode

public abstract class FaithfulTimelyColumnAggregatorNode<Domain,Accumulator,AggregateResult,CumulativeAggregate,FoldingState extends FaithfulTimelyColumnAggregatorNode.MergeableFoldingState<FoldingState>>
extends AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>
implements ResumableNode

Faithful timely implementation of the column aggregator node. Complete timelines (series of appearance invalid input: '&' disappearance) are maintained for tuples.

Subclasses are responsible for implementing the aggregator architecture, and they must use the CumulativeAggregate type parameter for that.

This node supports recursive aggregation.

Since:

2.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	FaithfulTimelyColumnAggregatorNode.MergeableFoldingState<T>

Nested classes/interfaces inherited from class tools.refinery.interpreter.rete.aggregation.AbstractColumnAggregatorNode

AbstractColumnAggregatorNode.AggregatorOuterIdentityIndexer, AbstractColumnAggregatorNode.AggregatorOuterIndexer, AbstractColumnAggregatorNode.NetworkStructureChangeSensitiveLogic

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<Tuple,TreeMap<Timestamp,CumulativeAggregate>>	aggregates
protected CommunicationGroup	communicationGroup
protected final TreeMap<Timestamp,Map<Tuple,FoldingState>>	foldingState
protected static final Timeline<Timestamp>	NEUTRAL_INITIAL_TIMELINE
protected static final Timeline<Timestamp>	NON_NEUTRAL_INITIAL_TIMELINE
protected final Map<Tuple,Map<AggregateResult,Timeline<Timestamp>>>	timelines

Fields inherited from class tools.refinery.interpreter.rete.aggregation.AbstractColumnAggregatorNode

aggregatorOuterIdentityIndexers, aggregatorOuterIndexer, columnMask, groupMask, NEUTRAL, operator, runtimeContext, sourceWidth

Fields inherited from class tools.refinery.interpreter.rete.single.SingleInputNode

mailbox, parent

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
FaithfulTimelyColumnAggregatorNode(ReteContainer reteContainer, IMultisetAggregationOperator<Domain,Accumulator,AggregateResult> operator, TupleMask groupMask, TupleMask columnMask)

Method Summary

Modifier and Type	Method	Description
protected void	addFoldingState(Tuple group, FoldingState state, Timestamp timestamp)	Registers the given folding state for the specified timestamp and tuple.
protected static <AggregateResult> void	appendDiff(AggregateResult result, Signed<Timestamp> diff, Map<AggregateResult,Diff<Timestamp>> diffs)
void	clear()
protected abstract Map<AggregateResult,Diff<Timestamp>>	doFoldingStep(Tuple group, FoldingState state, Timestamp timestamp)
protected abstract void	gcAggregates(CumulativeAggregate aggregate, Tuple group, Timestamp timestamp)	Garbage collects the counter of the given group and timestamp if the bag of aggregands is empty.
protected abstract CumulativeAggregate	getAggregate(Tuple group, Timestamp timestamp)	On-demand initializes and returns the aggregate for the given group and timestamp.
Map<AggregateResult,Timeline<Timestamp>>	getAggregateResultTimeline(Tuple group)
Tuple	getAggregateTuple(Tuple group)
Map<Tuple,Timeline<Timestamp>>	getAggregateTupleTimeline(Tuple group)
CommunicationGroup	getCurrentGroup()
protected Timeline<Timestamp>	getInitialTimeline(AggregateResult result)
Timestamp	getResumableTimestamp()	Returns the smallest timestamp where lazy folding shall be resumed, or null if there is no more folding to do in this resumable.
protected Mailbox	instantiateMailbox()	Instantiates the Mailbox of this receiver.
void	resumeAt(Timestamp timestamp)	When called, the folding of the state shall be resumed at the given timestamp.
void	setCurrentGroup(CommunicationGroup currentGroup)	Sets the current group of the mailbox
protected void	updateTimeline(Tuple group, Map<AggregateResult,Diff<Timestamp>> diffs)	Updates and garbage collects the timeline of the given tuple based on the given diffs.

Methods inherited from class tools.refinery.interpreter.rete.aggregation.AbstractColumnAggregatorNode

appendChild, getAggregateResult, getAggregatorOuterIdentityIndexer, getAggregatorOuterIndexer, getCommunicationTracker, propagate, propagateAggregateResultUpdate, pullInto, pullIntoWithTimeline, tupleFromAggregateResult

Methods inherited from class tools.refinery.interpreter.rete.single.SingleInputNode

appendParent, assignTraceInfo, getMailbox, getParents, propagatePullInto, propagatePullIntoWithTimestamp, removeParent

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

constructIndex, getChildMailboxes, getPulledContents, getReceivers, issueError, networkStructureChanged, 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, assignTraceInfo, getCommunicationTracker, getContainer, getNodeId, getTag, getTraceInfos, setTag

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

batchUpdate, update

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

constructIndex, getPulledContents, getPulledContents, getReceivers, removeChild

Field Details

aggregates

protected final Map<Tuple,TreeMap<Timestamp,CumulativeAggregate>> aggregates

timelines

protected final Map<Tuple,Map<AggregateResult,Timeline<Timestamp>>> timelines

foldingState

protected final TreeMap<Timestamp,Map<Tuple,FoldingState extends FaithfulTimelyColumnAggregatorNode.MergeableFoldingState<FoldingState>>> foldingState

communicationGroup

protected CommunicationGroup communicationGroup

NEUTRAL_INITIAL_TIMELINE

protected static final Timeline<Timestamp> NEUTRAL_INITIAL_TIMELINE

NON_NEUTRAL_INITIAL_TIMELINE

protected static final Timeline<Timestamp> NON_NEUTRAL_INITIAL_TIMELINE

Constructor Details

FaithfulTimelyColumnAggregatorNode

public FaithfulTimelyColumnAggregatorNode(ReteContainer reteContainer,
 IMultisetAggregationOperator<Domain,Accumulator,AggregateResult> operator,
 TupleMask groupMask,
 TupleMask columnMask)

Method Details

instantiateMailbox

protected Mailbox instantiateMailbox()

Description copied from class: SingleInputNode

Instantiates the Mailbox of this receiver. Subclasses may override this method to provide their own mailbox implementation.

Overrides:

instantiateMailbox in class SingleInputNode

Returns:

the mailbox

clear

public void clear()

Specified by:

clear in interface Clearable

addFoldingState

protected void addFoldingState(Tuple group,
 FoldingState state,
 Timestamp timestamp)

Registers the given folding state for the specified timestamp and tuple. If there is already a state stored, the two states will be merged together.

getResumableTimestamp

public Timestamp getResumableTimestamp()

Description copied from interface: ResumableNode

Returns the smallest timestamp where lazy folding shall be resumed, or null if there is no more folding to do in this resumable.

Specified by:

getResumableTimestamp in interface ResumableNode

resumeAt

public void resumeAt(Timestamp timestamp)

Description copied from interface: ResumableNode

When called, the folding of the state shall be resumed at the given timestamp. The resumable is expected to do a folding step at the given timestamp only. Afterwards, folding shall be interrupted, even if there is more folding to do towards higher timestamps.

Specified by:

resumeAt in interface ResumableNode

doFoldingStep

protected abstract Map<AggregateResult,Diff<Timestamp>> doFoldingStep(Tuple group,
 FoldingState state,
 Timestamp timestamp)

updateTimeline

protected void updateTimeline(Tuple group,
 Map<AggregateResult,Diff<Timestamp>> diffs)

Updates and garbage collects the timeline of the given tuple based on the given diffs.

gcAggregates

protected abstract void gcAggregates(CumulativeAggregate aggregate,
 Tuple group,
 Timestamp timestamp)

Garbage collects the counter of the given group and timestamp if the bag of aggregands is empty.

getAggregate

protected abstract CumulativeAggregate getAggregate(Tuple group,
 Timestamp timestamp)

On-demand initializes and returns the aggregate for the given group and timestamp.

getInitialTimeline

protected Timeline<Timestamp> getInitialTimeline(AggregateResult result)

appendDiff

protected static <AggregateResult> void appendDiff(AggregateResult result,
 Signed<Timestamp> diff,
 Map<AggregateResult,Diff<Timestamp>> diffs)

getAggregateTuple

public Tuple getAggregateTuple(Tuple group)

Specified by:

getAggregateTuple in class AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>

getAggregateResultTimeline

public Map<AggregateResult,Timeline<Timestamp>> getAggregateResultTimeline(Tuple group)

Specified by:

getAggregateResultTimeline in class AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>

getAggregateTupleTimeline

public Map<Tuple,Timeline<Timestamp>> getAggregateTupleTimeline(Tuple group)

Specified by:

getAggregateTupleTimeline in class AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>

getCurrentGroup

public CommunicationGroup getCurrentGroup()

Specified by:

getCurrentGroup in interface IGroupable

Returns:

the current group of the mailbox

setCurrentGroup

public void setCurrentGroup(CommunicationGroup currentGroup)

Description copied from interface: IGroupable

Sets the current group of the mailbox

Specified by:

setCurrentGroup in interface IGroupable