AggregationFunction (api API)

public interface AggregationFunction

A RiskscapeFunction sub-interface for a function that can be applied across many Tuples as part of a RealizedAggregateExpression.

Method Summary

Modifier and Type

Method

Description

static RiskscapeFunction

addAggregationTo(AggregationFunction setFunction, RiskscapeFunction wrapped)

static RiskscapeFunction

asFunction(AggregationFunction aggregationFunction)

default ArgumentList

getArguments()

Returns the arguments this function expects, used for help and other introspection

default Type

getReturnType()

The return type this function produces, used for help and other introspection

ResultOrProblems<RealizedAggregateExpression>

realize(RealizationContext context, Type inputType, FunctionCall fc)

Realize this function so that it can be called (via an Accumulator)

Method Details
- addAggregationTo
  
  static RiskscapeFunction addAggregationTo(AggregationFunction setFunction, RiskscapeFunction wrapped)
  
  Returns:
  
  a new RiskscapeFunction that returns the given AggregationFunction when RiskscapeFunction.getAggregationFunction() is called. Useful for patching an existing function with an aggregate version.
- asFunction
  
  static RiskscapeFunction asFunction(AggregationFunction aggregationFunction)
  
  Returns:
  
  a RiskscapeFunction that works on a list of the same elements supported by the given aggregation function.
- realize
  
  ResultOrProblems<RealizedAggregateExpression> realize(RealizationContext context, Type inputType, FunctionCall fc)
  
  Realize this function so that it can be called (via an Accumulator)
  
  Parameters:
  
  context - the context it will be used under
  
  fc - the expression being realized
  
  Returns:
  
  either a successfully realized function, or reasons why it could not be realized.
- getArguments
  
  default ArgumentList getArguments()
  
  Returns the arguments this function expects, used for help and other introspection
- getReturnType
  
  default Type getReturnType()
  
  The return type this function produces, used for help and other introspection