Package tools.refinery.interpreter.rete.aggregation

Class AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>

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>

All Implemented Interfaces:

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

Direct Known Subclasses:

ColumnAggregatorNode, FaithfulTimelyColumnAggregatorNode, FirstOnlyTimelyColumnAggregatorNode

public abstract class AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>
extends SingleInputNode
implements Clearable, IAggregatorNode

Groups incoming tuples by the given mask, and aggregates values at a specific index in each group.

Direct children are not supported, use via outer join indexers instead.

There are both timeless and timely implementations.

Since:

2.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractColumnAggregatorNode.AggregatorOuterIdentityIndexer	A special non-iterable index that checks a suspected aggregate value for a given signature.
protected class	AbstractColumnAggregatorNode.AggregatorOuterIndexer	A special non-iterable index that retrieves the aggregated, packed result (signature+aggregate) for the original signature.
protected static class	AbstractColumnAggregatorNode.NetworkStructureChangeSensitiveLogic

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractColumnAggregatorNode.AggregatorOuterIdentityIndexer[]	aggregatorOuterIdentityIndexers
protected AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>.AggregatorOuterIndexer	aggregatorOuterIndexer
protected final TupleMask	columnMask
protected final TupleMask	groupMask
protected final AggregateResult	NEUTRAL
protected final IMultisetAggregationOperator<Domain,Accumulator,AggregateResult>	operator
protected final IQueryRuntimeContext	runtimeContext
protected final int	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
AbstractColumnAggregatorNode(ReteContainer reteContainer, IMultisetAggregationOperator<Domain,Accumulator,AggregateResult> operator, TupleMask groupMask, int aggregatedColumn)	Creates a new column aggregator node.
AbstractColumnAggregatorNode(ReteContainer reteContainer, IMultisetAggregationOperator<Domain,Accumulator,AggregateResult> operator, TupleMask groupMask, TupleMask columnMask)	Creates a new column aggregator node.

Method Summary

Modifier and Type	Method	Description
void	appendChild(Receiver receiver)	appends a receiver that will continously receive insert and revoke updates from this supplier
abstract AggregateResult	getAggregateResult(Tuple key)
abstract Map<AggregateResult,Timeline<Timestamp>>	getAggregateResultTimeline(Tuple key)
abstract Tuple	getAggregateTuple(Tuple key)
abstract Map<Tuple,Timeline<Timestamp>>	getAggregateTupleTimeline(Tuple key)
Indexer	getAggregatorOuterIdentityIndexer(int resultPositionInSignature)
Indexer	getAggregatorOuterIndexer()
CommunicationTracker	getCommunicationTracker()
void	propagate(Direction direction, Tuple group, AggregateResult value, Timestamp timestamp)
void	propagateAggregateResultUpdate(Tuple group, AggregateResult oldValue, AggregateResult newValue, Timestamp timestamp)
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)
protected Tuple	tupleFromAggregateResult(Tuple groupTuple, AggregateResult aggregateResult)

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

appendParent, assignTraceInfo, getMailbox, getParents, instantiateMailbox, 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.matchers.util.Clearable

clear

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

acceptPropagatedTraceInfo, 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

operator

protected final IMultisetAggregationOperator<Domain,Accumulator,AggregateResult> operator

Since:

1.6

groupMask

protected final TupleMask groupMask

Since:

1.6

columnMask

protected final TupleMask columnMask

Since:

1.6

sourceWidth

protected final int sourceWidth

Since:

1.6

runtimeContext

protected final IQueryRuntimeContext runtimeContext

Since:

1.6

NEUTRAL

protected final AggregateResult NEUTRAL

aggregatorOuterIndexer

protected AbstractColumnAggregatorNode<Domain,Accumulator,AggregateResult>.AggregatorOuterIndexer aggregatorOuterIndexer

aggregatorOuterIdentityIndexers

protected AbstractColumnAggregatorNode.AggregatorOuterIdentityIndexer[] aggregatorOuterIdentityIndexers

Constructor Details

AbstractColumnAggregatorNode

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

Creates a new column aggregator node.

Parameters:

reteContainer - the RETE container of the node

operator - the aggregation operator

groupMask - the mask that masks a tuple to obtain the key that we are grouping-by

columnMask - the mask that masks a tuple to obtain the tuple element(s) that we are aggregating over

deleteRederiveEvaluation - true if the node should run in DRED mode, false otherwise

posetComparator - the poset comparator for the column, if known, otherwise it can be null

Since:

1.6

AbstractColumnAggregatorNode

public AbstractColumnAggregatorNode(ReteContainer reteContainer,
 IMultisetAggregationOperator<Domain,Accumulator,AggregateResult> operator,
 TupleMask groupMask,
 int aggregatedColumn)

Creates a new column aggregator node.

Parameters:

reteContainer - the RETE container of the node

operator - the aggregation operator

groupMask - the mask that masks a tuple to obtain the key that we are grouping-by

aggregatedColumn - the index of the column that the aggregator node is aggregating over

Method Details

getCommunicationTracker

public CommunicationTracker getCommunicationTracker()

Specified by:

getCommunicationTracker in interface Node

Overrides:

getCommunicationTracker in class SingleInputNode

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

appendChild

public void appendChild(Receiver receiver)

Description copied from interface: Supplier

appends a receiver that will continously receive insert and revoke updates from this supplier

Specified by:

appendChild in interface Supplier

Overrides:

appendChild in class StandardNode

getAggregatorOuterIndexer

public Indexer getAggregatorOuterIndexer()

Specified by:

getAggregatorOuterIndexer in interface IAggregatorNode

getAggregatorOuterIdentityIndexer

public Indexer getAggregatorOuterIdentityIndexer(int resultPositionInSignature)

Specified by:

getAggregatorOuterIdentityIndexer in interface IAggregatorNode

propagateAggregateResultUpdate

public void propagateAggregateResultUpdate(Tuple group,
 AggregateResult oldValue,
 AggregateResult newValue,
 Timestamp timestamp)

Since:

2.4

propagate

public void propagate(Direction direction,
 Tuple group,
 AggregateResult value,
 Timestamp timestamp)

Since:

2.4

getAggregateTuple

public abstract Tuple getAggregateTuple(Tuple key)

getAggregateTupleTimeline

public abstract Map<Tuple,Timeline<Timestamp>> getAggregateTupleTimeline(Tuple key)

Since:

2.4

getAggregateResult

public abstract AggregateResult getAggregateResult(Tuple key)

getAggregateResultTimeline

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

Since:

2.4

tupleFromAggregateResult

protected Tuple tupleFromAggregateResult(Tuple groupTuple,
 AggregateResult aggregateResult)