Package nz.org.riskscape.engine.function

Class JavaFunction

java.lang.Object

nz.org.riskscape.engine.function.JavaFunction

All Implemented Interfaces:

AutoCloseable, IdentifiedFunction, RiskscapeFunction, UntypedFunction, Identified

public class JavaFunction
extends Object
implements IdentifiedFunction

Immutable prototype-builder implementation of IdentifiedFunction TODO given the use of this an all sorts of other implementations, the name of this needs to change to be more like 'BaseFunction' or 'ImmutableFunction'

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JavaFunction.Delegate

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

IdentifiedFunction.Category, IdentifiedFunction.Wrapping

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	ID_PATTERN	REGEX pattern for valid ID's.

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

BUILT_IN, LOG

Constructor Summary

Constructors

Constructor	Description
JavaFunction(String id, URI sourceURI, String description, List<Type> argumentTypes, Type returnType, JavaFunction.Delegate delegate, IdentifiedFunction.Category category)
JavaFunction(FunctionMetadata metadata, JavaFunction.Delegate delegate)

Method Summary

Modifier and Type	Method	Description
static JavaFunction	asBuiltin(String id, IdentifiedFunction.Category category)
Object	call(List<Object> args)	Execute the function with the given arguments.
JavaFunction	calling(JavaFunction.Delegate newDelegate)
ArgumentList	getArguments()	Returns the argument list from JavaFunction.Delegate.getArguments() if this is not null else defers to RiskscapeFunction.getArguments().
List<Type>	getArgumentTypes()
IdentifiedFunction.Category	getCategory()
JavaFunction.Delegate	getDelegate()
String	getDescription()
String	getId()
Type	getReturnType()
URI	getSourceURI()
void	setSourceURI(URI sourceURI)
String	toString()
ResultOrProblems<Boolean>	validate(RealizationContext context)	Validate that the function can be run.
JavaFunction	withArgumentTypes(List<Type> newArgumentTypes)
JavaFunction	withArgumentTypes(Type... newArgumentTypes)
static JavaFunction	withId(String id)
static JavaFunction	withIdAndSource(String id, String source)	Deprecated.
static JavaFunction	withIdAndSource(String id, URI source)
JavaFunction	withReturnType(Type newReturnType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getIdentifiedClass

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

getSource, infoOutput, isBuiltin, toEntity

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

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

Field Details

ID_PATTERN

public static final Pattern ID_PATTERN

REGEX pattern for valid ID's.

ID's may only contain alpha numeric characters, ':', '_' and '-',

Constructor Details

JavaFunction

public JavaFunction(FunctionMetadata metadata,
 JavaFunction.Delegate delegate)

JavaFunction

public JavaFunction(String id,
 URI sourceURI,
 String description,
 List<Type> argumentTypes,
 Type returnType,
 JavaFunction.Delegate delegate,
 IdentifiedFunction.Category category)

Method Details

asBuiltin

public static JavaFunction asBuiltin(String id,
 IdentifiedFunction.Category category)

withId

public static JavaFunction withId(String id)

withIdAndSource

@Deprecated
public static JavaFunction withIdAndSource(String id,
 String source)

Deprecated.

withIdAndSource

public static JavaFunction withIdAndSource(String id,
 URI source)

Parameters:

id - of the function

source - identifies where the function came from. Used when reporting Problems

Returns:

the function

call

public Object call(List<Object> args)

Description copied from interface: UntypedFunction

Execute the function with the given arguments.

Specified by:

call in interface UntypedFunction

Parameters:

args - list of arguments to the function that should conform to the types in ArgumentList.getArgumentTypes()

validate

public ResultOrProblems<Boolean> validate(RealizationContext context)

Description copied from interface: RiskscapeFunction

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.

Specified by:

validate in interface RiskscapeFunction

Returns:

ResultOrProblems indicating if function is valid

getArguments

public ArgumentList getArguments()

Returns the argument list from JavaFunction.Delegate.getArguments() if this is not null else defers to RiskscapeFunction.getArguments().

Specified by:

getArguments in interface RiskscapeFunction

Returns:

argument list

withArgumentTypes

public JavaFunction withArgumentTypes(Type... newArgumentTypes)

withArgumentTypes

public JavaFunction withArgumentTypes(List<Type> newArgumentTypes)

withReturnType

public JavaFunction withReturnType(Type newReturnType)

calling

public JavaFunction calling(JavaFunction.Delegate newDelegate)

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

Specified by:

getId in interface Identified

Returns:

id

getSourceURI

public URI getSourceURI()

Specified by:

getSourceURI in interface IdentifiedFunction

Returns:

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

setSourceURI

public void setSourceURI(URI sourceURI)

getDescription

public String getDescription()

Specified by:

getDescription in interface IdentifiedFunction

Returns:

a human readable description of the function

getArgumentTypes

public List<Type> getArgumentTypes()

Specified by:

getArgumentTypes in interface RiskscapeFunction

Returns:

the types that this function expects

getReturnType

public Type getReturnType()

Specified by:

getReturnType in interface RiskscapeFunction

Returns:

the type that this function should return

getDelegate

public JavaFunction.Delegate getDelegate()

getCategory

public IdentifiedFunction.Category getCategory()

Specified by:

getCategory in interface IdentifiedFunction

Returns:

the category that this function belongs to