Package nz.org.riskscape.engine.function

Class MetadataBasedFunction

java.lang.Object

nz.org.riskscape.engine.function.MetadataBasedFunction

All Implemented Interfaces:

AutoCloseable, IdentifiedFunction, RiskscapeFunction, UntypedFunction, Identified

public abstract class MetadataBasedFunction
extends Object
implements IdentifiedFunction

Convenience class for dealing with the basic metadata-related aspects of a function, i.e. the boiler-plate stuff that every function has to define.

Nested Class Summary

Nested classes/interfaces inherited from interface nz.org.riskscape.engine.function.IdentifiedFunction

IdentifiedFunction.Category, IdentifiedFunction.Wrapping

Field Summary

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

BUILT_IN

Constructor Summary

Constructors

Constructor	Description
MetadataBasedFunction(FunctionMetadata metadata)

Method Summary

Modifier and Type	Method	Description
ArgumentList	getArguments()
List<Type>	getArgumentTypes()
IdentifiedFunction.Category	getCategory()
String	getDescription()
String	getId()
Type	getReturnType()
String	getSource()

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.Identified

getIdentifiedClass

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

infoOutput, isBuiltin, toEntity

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

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

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

call, close

Constructor Details

MetadataBasedFunction

public MetadataBasedFunction(FunctionMetadata metadata)

Method Details

getArgumentTypes

public List<Type> getArgumentTypes()

Specified by:

getArgumentTypes in interface RiskscapeFunction

Returns:

the types that this function expects

getArguments

public ArgumentList getArguments()

Specified by:

getArguments in interface RiskscapeFunction

getReturnType

public Type getReturnType()

Specified by:

getReturnType in interface RiskscapeFunction

Returns:

the type that this function should return

getId

public String getId()

Specified by:

getId in interface Identified

Returns:

id

getDescription

public String getDescription()

Specified by:

getDescription in interface IdentifiedFunction

Returns:

a human readable description of the function

getSource

public String getSource()

Specified by:

getSource in interface IdentifiedFunction

Returns:

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

getCategory

public IdentifiedFunction.Category getCategory()

Specified by:

getCategory in interface IdentifiedFunction

Returns:

the category that this function belongs to