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

Class AggregationFunctionAdapter

java.lang.Object

nz.org.riskscape.engine.function.agg.AggregationFunctionAdapter

All Implemented Interfaces:

AutoCloseable, RiskscapeFunction, UntypedFunction, RealizableFunction

public class AggregationFunctionAdapter
extends Object
implements RiskscapeFunction, RealizableFunction

Adapts an AggregationFunction so that it can be called in a standard RealizedExpression.

Supports only single argument functions, but could be extended to support more complex configurations

Nested Class Summary

Nested classes/interfaces inherited from interface nz.org.riskscape.engine.rl.RealizableFunction

RealizableFunction.MetadataIdentifiedRealizableFunction

Field Summary

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

BUILT_IN, LOG

Constructor Summary

Constructors

Constructor	Description
AggregationFunctionAdapter(AggregationFunction aggfunction)

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()
Type	getReturnType()
ResultOrProblems<RiskscapeFunction>	realize(RealizationContext context, FunctionCall functionCall, List<Type> argumentTypes)	Attempt to adapt a function call to the given types.

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.rl.RealizableFunction

isDoTypeAdaptation

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

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

Constructor Details

AggregationFunctionAdapter

public AggregationFunctionAdapter(AggregationFunction aggfunction)

Method Details

getReturnType

public Type getReturnType()

Specified by:

getReturnType in interface RiskscapeFunction

Returns:

the type that this function should return

getArguments

public ArgumentList getArguments()

Specified by:

getArguments in interface RiskscapeFunction

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()

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.

realize

public ResultOrProblems<RiskscapeFunction> realize(RealizationContext context,
 FunctionCall functionCall,
 List<Type> argumentTypes)

Description copied from interface: RealizableFunction

Attempt to adapt a function call to the given types. This can also be used to do constant optimizations etc or anything else.

Specified by:

realize in interface RealizableFunction

functionCall - the part of the abstract syntax tree for the function call

argumentTypes - the types of the arguments that have been supplied to the function

Returns:

the adapted function, or some problems if it couldn't be adapted.