java.lang.Object

nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction

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

Enclosing interface:: RealizableFunction

public static class RealizableFunction.MetadataIdentifiedRealizableFunction 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 inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction
BUILT_IN
Constructor Summary

Constructors

Constructor

Description

MetadataIdentifiedRealizableFunction(RealizableFunction function, FunctionMetadata metadata)
Method Summary

Modifier and Type

Method

Description

Object

call(List<Object> args)

Execute the function with the given arguments.

protected boolean

canEqual(Object other)

boolean

equals(Object o)

ArgumentList

getArguments()

List<Type>

getArgumentTypes()

IdentifiedFunction.Category

getCategory()

String

getDescription()

RealizableFunction

getFunction()

String

getId()

FunctionMetadata

getMetadata()

Optional<RealizableFunction>

getRealizable()

Type

getReturnType()

String

getSource()

int

hashCode()

String

toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, 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, getAggregationFunction, getOverloaded, getTypesFromArguments, identified, identified, isA, setProblemReporter, validate

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

Constructor Details
- MetadataIdentifiedRealizableFunction
  
  public MetadataIdentifiedRealizableFunction(RealizableFunction function, 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
- 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()
- 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
- 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.
- getFunction
  
  public RealizableFunction getFunction()
- getMetadata
  
  public FunctionMetadata getMetadata()
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- canEqual
  
  protected boolean canEqual(Object other)
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class RealizableFunction.MetadataIdentifiedRealizableFunction

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

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

Constructor Details

MetadataIdentifiedRealizableFunction

Method Details

getArgumentTypes

getArguments

getReturnType

call

getId

getDescription

getSource

getCategory

getRealizable

getFunction

getMetadata

equals

canEqual

hashCode

toString