Package nz.org.riskscape.engine.function.agg

Class AddAggregationFunction

java.lang.Object

nz.org.riskscape.engine.function.agg.AddAggregationFunction

All Implemented Interfaces:

AutoCloseable, RiskscapeFunction, UntypedFunction

public class AddAggregationFunction
extends Object
implements RiskscapeFunction

Field Summary

Fields inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

BUILT_IN, LOG

Constructor Summary

Constructors

Constructor	Description
AddAggregationFunction(RiskscapeFunction wrappedFunction, AggregationFunction aggregationFunction)

Method Summary

Modifier and Type	Method	Description
Object	call(List<Object> args)	Execute the function with the given arguments.
Optional<AggregationFunction>	getAggregationFunction()
ArgumentList	getArguments()
List<Type>	getArgumentTypes()
Optional<OverloadedFunction>	getOverloaded()
Optional<RealizableFunction>	getRealizable()
Type	getReturnType()
RiskscapeFunction	getWrappedFunction()

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

builtin, close, getTypesFromArguments, identified, identified, isA, setProblemReporter, validate

Constructor Details

AddAggregationFunction

public AddAggregationFunction(RiskscapeFunction wrappedFunction,
 AggregationFunction aggregationFunction)

Method Details

getReturnType

public Type getReturnType()

Specified by:

getReturnType in interface RiskscapeFunction

Returns:

the type that this function should return

getArgumentTypes

public List<Type> getArgumentTypes()

Specified by:

getArgumentTypes in interface RiskscapeFunction

Returns:

the types that this function expects

call

public Object call(List<Object> args)

Description copied from interface: UntypedFunction

Execute the function with the given arguments.

Specified by:

call in interface UntypedFunction

Parameters:

args - list of arguments to the function that should conform to the types in ArgumentList.getArgumentTypes()

getArguments

public ArgumentList getArguments()

Specified by:

getArguments in interface RiskscapeFunction

getOverloaded

public Optional<OverloadedFunction> getOverloaded()

Specified by:

getOverloaded in interface RiskscapeFunction

Returns:

an OverloadedFunction that offers alternative input types for use within an expression, or empty if this function does not support overloading

getRealizable

public Optional<RealizableFunction> getRealizable()

Specified by:

getRealizable in interface RiskscapeFunction

Returns:

a RealizableFunction that can realize this RiskscapeFunction against a type, or empty if this function does not support realization.

getAggregationFunction

public Optional<AggregationFunction> getAggregationFunction()

Specified by:

getAggregationFunction in interface RiskscapeFunction

Returns:

An AggregationFunction that is functionally the same operation as this, but works with a RealizedAggregateExpression, rather than against a RealizedExpression with an RSList.

getWrappedFunction

public RiskscapeFunction getWrappedFunction()