Package nz.org.riskscape.engine.function

Interface RiskscapeFunction

All Superinterfaces:

AutoCloseable, UntypedFunction

All Known Subinterfaces:

IdentifiedFunction

All Known Implementing Classes:

AddAggregationFunction, AggregationFunctionAdapter, BinaryFunction, BinaryOperatorFunction, BinaryPredicateFunction, ConstantFunction, IdentifiedFunction.Wrapping, JavaFunction, MetadataBasedFunction, NullSafeFunction, RealizableFunction.MetadataIdentifiedRealizableFunction, UnaryFunction

public interface RiskscapeFunction
extends UntypedFunction

General interface for any kind of function that accepts and returns riskscape types values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUILT_IN

Method Summary

Modifier and Type	Method	Description
default IdentifiedFunction	builtin(String id, IdentifiedFunction.Category category)
static RiskscapeFunction	create(Object source, List<Type> argumentTypes, Type returnType, UntypedFunction function)	Create a RiskscapeFunction from the given types and untyped function.
default Optional<AggregationFunction>	getAggregationFunction()
default ArgumentList	getArguments()
List<Type>	getArgumentTypes()
default Optional<OverloadedFunction>	getOverloaded()
default Optional<RealizableFunction>	getRealizable()
Type	getReturnType()
default List<Type>	getTypesFromArguments()
default IdentifiedFunction	identified(String id)
default IdentifiedFunction	identified(String id, String description, String source, IdentifiedFunction.Category category)
default <T extends RiskscapeFunction> Optional<T>	isA(Class<T> type)
default void	setProblemReporter(Consumer<Problem> problemReporter)	Set a problem report that this function may use to issue Problems to if any are encountered whilst the function is being called.
default ResultOrProblems<Boolean>	validate(RealizationContext context)	Validate that the function can be run.

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

call, close

Field Details

BUILT_IN

static final String BUILT_IN

See Also:

• Constant Field Values

Method Details

create

static RiskscapeFunction create(Object source,
 List<Type> argumentTypes,
 Type returnType,
 UntypedFunction function)

Create a RiskscapeFunction from the given types and untyped function. Note that this won't add any type checking or coercion around the function call, it simply serves as a way to add the type metadata to an UntypedFunction to make it fulfill the RiskscapeFunction interface.

Parameters:

source - an object to use in the toString of this function to track where it came from, or null to just use the function as the source

function - a function we are extending with type metadata.

Returns:

a RiskscapeFunction that can be used as part of a RiskScape expression

getArgumentTypes

List<Type> getArgumentTypes()

Returns:

the types that this function expects

getReturnType

Type getReturnType()

Returns:

the type that this function should return

validate

default ResultOrProblems<Boolean> validate(RealizationContext context)

Validate that the function can be run.

To be considered valid there should be no Problems found that are at error or fatal. Finding problems of lower severity should not make a function invalid.

Returns:

ResultOrProblems indicating if function is valid

getRealizable

default Optional<RealizableFunction> getRealizable()

Returns:

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

getOverloaded

default Optional<OverloadedFunction> getOverloaded()

Returns:

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

getAggregationFunction

default Optional<AggregationFunction> getAggregationFunction()

Returns:

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

getArguments

default ArgumentList getArguments()

getTypesFromArguments

default List<Type> getTypesFromArguments()

setProblemReporter

default void setProblemReporter(Consumer<Problem> problemReporter)

Set a problem report that this function may use to issue Problems to if any are encountered whilst the function is being called.

Any Problems sent to the problemReporter should clearly state what function they came from.

Parameters:

problemReporter -

identified

default IdentifiedFunction identified(String id,
 String description,
 String source,
 IdentifiedFunction.Category category)

Returns:

an IdentifiedFunction that wraps this function with the given metadata. Note that for built-in functions, builtin(String, IdentifiedFunction.Category) is probably a better choice to use (i.e. is simpler and encourages i18n description).

builtin

default IdentifiedFunction builtin(String id,
 IdentifiedFunction.Category category)

Returns:

an IdentifiedFunction that wraps this function with the given metadata

identified

default IdentifiedFunction identified(String id)

Returns:

alternative to identified(String, String, String, IdentifiedFunction.Category) that is suitable for test cases

isA

default <T extends RiskscapeFunction> Optional<T> isA(Class<T> type)