Package tools.refinery.interpreter.matchers.aggregators

Class IntegerSumOperator

java.lang.Object

tools.refinery.interpreter.matchers.psystem.aggregations.AbstractMemorylessAggregationOperator<Integer,Integer>

tools.refinery.interpreter.matchers.aggregators.IntegerSumOperator

All Implemented Interfaces:

IMultisetAggregationOperator<Integer,Integer,Integer>

public class IntegerSumOperator
extends AbstractMemorylessAggregationOperator<Integer,Integer>

Incrementally computes the sum of java.lang.Integer values

Since:

1.4

Field Summary

Fields

Modifier and Type	Field	Description
static final IntegerSumOperator	INSTANCE

Method Summary

Modifier and Type	Method	Description
Integer	aggregateStream(Stream<Integer> stream)	Calculates the aggregate results from a given stream of values; all values are considered as inserted
Integer	createNeutral()
String	getName()	A name or identifier of the operator.
String	getShortDescription()	A textual description of the operator.
boolean	isNeutral(Integer result)
Integer	update(Integer oldResult, Integer updateValue, boolean isInsertion)

Methods inherited from class tools.refinery.interpreter.matchers.psystem.aggregations.AbstractMemorylessAggregationOperator

clone, getAggregate

Methods inherited from class java.lang.Object

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

Methods inherited from interface tools.refinery.interpreter.matchers.psystem.aggregations.IMultisetAggregationOperator

combine, contains, prettyPrint

Field Details

INSTANCE

public static final IntegerSumOperator INSTANCE

Method Details

getShortDescription

public String getShortDescription()

Description copied from interface: IMultisetAggregationOperator

A textual description of the operator.

getName

public String getName()

Description copied from interface: IMultisetAggregationOperator

A name or identifier of the operator.

createNeutral

public Integer createNeutral()

Returns:

the neutral element, i.e. the interim result of aggregating an empty multiset.

isNeutral

public boolean isNeutral(Integer result)

Returns:

true if the interim result is equivalent to the neutral element, as if there are no values in the multiset. Must return true if the multiset is empty.

update

public Integer update(Integer oldResult,
 Integer updateValue,
 boolean isInsertion)

Returns:

an updated intermediate result, changed to reflect that a given object was added to / removed from the multiset (as indicated by the parameter isInsertion)

aggregateStream

public Integer aggregateStream(Stream<Integer> stream)

Description copied from interface: IMultisetAggregationOperator

Calculates the aggregate results from a given stream of values; all values are considered as inserted

Returns:

the aggregate result, or null if no result can be calculated (e.g. because of an empty stream)

Since:

2.0