java.lang.Object

nz.org.riskscape.engine.function.IdentifiedFunction.Wrapping

All Implemented Interfaces:: AutoCloseable, IdentifiedFunction, RiskscapeFunction, UntypedFunction, Identified

Enclosing interface:: IdentifiedFunction

public static class IdentifiedFunction.Wrapping extends Object implements IdentifiedFunction

Nested Class Summary

Nested classes/interfaces inherited from interface nz.org.riskscape.engine.function.IdentifiedFunction
IdentifiedFunction.Category, IdentifiedFunction.Wrapping
Field Summary

Fields

Modifier and Type

Field

Description

protected final RiskscapeFunction

wrapped

Fields inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction
BUILT_IN
Constructor Summary

Constructors

Constructor

Description

Wrapping(RiskscapeFunction wrapped, String id, String description, String source, IdentifiedFunction.Category category)
Method Summary

Modifier and Type

Method

Description

Object

call(List<Object> args)

Execute the function with the given arguments.

void

close()

Clean up any resources that were allocated with this function.

Optional<AggregationFunction>

getAggregationFunction()

ArgumentList

getArguments()

List<Type>

getArgumentTypes()

IdentifiedFunction.Category

getCategory()

String

getDescription()

String

getId()

Optional<OverloadedFunction>

getOverloaded()

Optional<RealizableFunction>

getRealizable()

Type

getReturnType()

String

getSource()

String

toString()

ResultOrProblems<Boolean>

validate(RealizationContext context)

Validate that the function can be run.

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
infoOutput, isBuiltin, toEntity

Methods inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction
builtin, getTypesFromArguments, identified, identified, isA, setProblemReporter

Field Details
- wrapped
  
  protected final RiskscapeFunction wrapped
Constructor Details
- Wrapping
  
  public Wrapping(RiskscapeFunction wrapped, String id, String description, String source, IdentifiedFunction.Category category)
Method Details
- 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()
- 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
- getRealizable
  
  public Optional<RealizableFunction> getRealizable()
  
  Specified by:
  
  getRealizable in interface RiskscapeFunction
  
  Returns:
  
  a RealizableFunction that can realize this RiskscapeFunction against a type, or empty if this function does not support realization.
- getOverloaded
  
  public Optional<OverloadedFunction> getOverloaded()
  
  Specified by:
  
  getOverloaded in interface RiskscapeFunction
  
  Returns:
  
  an OverloadedFunction that offers alternative input types for use within an expression, or empty if this function does not support overloading
- getAggregationFunction
  
  public Optional<AggregationFunction> getAggregationFunction()
  
  Specified by:
  
  getAggregationFunction in interface RiskscapeFunction
  
  Returns:
  
  An AggregationFunction that is functionally the same operation as this, but works with a RealizedAggregateExpression, rather than against a RealizedExpression with an RSList.
- 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
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- close
  
  public void close()
  
  Description copied from interface: UntypedFunction
  
  Clean up any resources that were allocated with this function. This can include large objects, so that any memory used can be reclaimed.
  
  See Realized for more information on the life-cycle of executable pipeline objects.
  
  Note that there is no standard mechanism for cleaning up resources allocated to functions that realize lambda expressions - the closing of any RealizedExpressions or related objects must be done by the function when it's closed. This is probably something that should be addressed once some standard patterns have been established for the implementation of lambda-accepting functions.
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface UntypedFunction
- 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

Class IdentifiedFunction.Wrapping

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

Field Details

wrapped

Constructor Details

Wrapping

Method Details

call

getArgumentTypes

getArguments

getReturnType

getRealizable

getOverloaded

getAggregationFunction

validate

toString

close

getId

getDescription

getSource

getCategory