Package nz.org.riskscape.engine.function

Interface IdentifiedFunction

All Superinterfaces:

AutoCloseable, Identified, RiskscapeFunction, UntypedFunction

All Known Implementing Classes:

IdentifiedFunction.Wrapping, JavaFunction, MetadataBasedFunction, RealizableFunction.MetadataIdentifiedRealizableFunction

public interface IdentifiedFunction
extends RiskscapeFunction, Identified

A RiskscapeFunction that is identified by its Identified.getId().

Being identified by the ID is required for the function to be called from other contexts.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IdentifiedFunction.Category
static class	IdentifiedFunction.Wrapping

Field Summary

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

BUILT_IN

Method Summary

Modifier and Type	Method	Description
IdentifiedFunction.Category	getCategory()
String	getDescription()
String	getSource()
default String	infoOutput()	Get information about this function.
default boolean	isBuiltin()
default Map<String,Object>	toEntity()	Returns a map-view of this fragility function

Methods inherited from interface nz.org.riskscape.engine.Identified

getId, getIdentifiedClass

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

builtin, getAggregationFunction, getArguments, getArgumentTypes, getOverloaded, getRealizable, getReturnType, getTypesFromArguments, identified, identified, isA, setProblemReporter, validate

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

call, close

Method Details

getDescription

String getDescription()

Returns:

a human readable description of the function

getSource

String getSource()

Returns:

a string indicating the source of function. file/uri etc.

getCategory

IdentifiedFunction.Category getCategory()

Returns:

the category that this function belongs to

infoOutput

default String infoOutput()

Get information about this function.

toEntity

default Map<String,Object> toEntity()

Returns a map-view of this fragility function

isBuiltin

default boolean isBuiltin()

Returns:

true if this is a built-in function provided by RiskScape