Package nz.org.riskscape.engine.rl.agg

Class PercentileAggregationFunction

java.lang.Object

nz.org.riskscape.engine.rl.agg.ListCollecting

nz.org.riskscape.engine.rl.agg.PercentileAggregationFunction

All Implemented Interfaces:

nz.org.riskscape.engine.rl.agg.AggregationFunction

Direct Known Subclasses:

PercentileAggregationFunction.Single, PercentileAggregationFunction.SingleFixed

public class PercentileAggregationFunction
extends ListCollecting

Calculates percentiles using the nearest-rank method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PercentileAggregationFunction.LocalProblems
static class	PercentileAggregationFunction.Single	A PercentileAggregationFunction that returns a single percentile.
static class	PercentileAggregationFunction.SingleFixed	A PercentileAggregationFunction that returns a single predefined percentile.

Nested classes/interfaces inherited from class nz.org.riskscape.engine.rl.agg.ListCollecting

ListCollecting.ListProcessor

Field Summary

Fields

Modifier and Type	Field	Description
static final nz.org.riskscape.engine.types.Type	PERCENTILE_TYPE
static final nz.org.riskscape.engine.types.RSList	PERCENTILES_TYPE

Constructor Summary

Constructors

Constructor	Description
PercentileAggregationFunction()

Method Summary

Modifier and Type	Method	Description
protected ListCollecting.ListProcessor	buildProcessor(nz.org.riskscape.engine.types.RSList listType, nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.engine.types.Type inputType, nz.org.riskscape.rl.ast.FunctionCall fc)	Build a ListCollecting.ListProcessor that can produce the aggregated result.
protected Object	buildResult(Object[] results, nz.org.riskscape.engine.types.Type resultType)
nz.org.riskscape.engine.function.ArgumentList	getArguments()
protected List<Long>	getPercentiles(nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.rl.ast.FunctionCall fc)
protected nz.org.riskscape.engine.types.Type	getResultTypeFor(nz.org.riskscape.engine.types.Type internalType, List<Long> percentiles)

Methods inherited from class nz.org.riskscape.engine.rl.agg.ListCollecting

realize

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.agg.AggregationFunction

getReturnType

Field Details

PERCENTILE_TYPE

public static final nz.org.riskscape.engine.types.Type PERCENTILE_TYPE

PERCENTILES_TYPE

public static final nz.org.riskscape.engine.types.RSList PERCENTILES_TYPE

Constructor Details

PercentileAggregationFunction

public PercentileAggregationFunction()

Method Details

getArguments

public nz.org.riskscape.engine.function.ArgumentList getArguments()

buildProcessor

protected ListCollecting.ListProcessor buildProcessor(nz.org.riskscape.engine.types.RSList listType,
 nz.org.riskscape.engine.rl.RealizationContext context,
 nz.org.riskscape.engine.types.Type inputType,
 nz.org.riskscape.rl.ast.FunctionCall fc)
                                               throws nz.org.riskscape.problem.ProblemException

Description copied from class: ListCollecting

Build a ListCollecting.ListProcessor that can produce the aggregated result.

Specified by:

buildProcessor in class ListCollecting

Parameters:

listType - type of the list that will be passed to built processor

context - context to realize any other expressions with

Returns:

list processor to capable of producing aggregated result

Throws:

nz.org.riskscape.problem.ProblemException - with any problems encountered

getPercentiles

protected List<Long> getPercentiles(nz.org.riskscape.engine.rl.RealizationContext context,
 nz.org.riskscape.rl.ast.FunctionCall fc)
                             throws nz.org.riskscape.problem.ProblemException

Returns:

list of percentiles that need to be found.

Throws:

nz.org.riskscape.problem.ProblemException

buildResult

protected Object buildResult(Object[] results,
 nz.org.riskscape.engine.types.Type resultType)

getResultTypeFor

protected nz.org.riskscape.engine.types.Type getResultTypeFor(nz.org.riskscape.engine.types.Type internalType,
 List<Long> percentiles)
                                                       throws nz.org.riskscape.problem.ProblemException

Throws:

nz.org.riskscape.problem.ProblemException