nz.org.riskscape.engine.function.FunctionMetadata

All Implemented Interfaces:: Identified

public class FunctionMetadata extends Object implements Identified

Holds the common details about a RiskScape function, such as its argument-types and return-type. This allows users to supply this information separately to the python/classifier code that they are actually trying to compile/run.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

NO_DESCRIPTION

static final IdentifiedFunction.Category

UNCATEGORIZED
Constructor Summary

Constructors

Constructor

Description

FunctionMetadata(String id, List<Type> argumentTypes, Type returnType, String source)

This constructor is useful for testing

FunctionMetadata(String id, List<Type> argumentTypes, Type returnType, String description, IdentifiedFunction.Category category, String source)

Note that in general you would want to use the constructor FunctionMetadata(String, ArgumentList, Type, String, IdentifiedFunction.Category, String) instead, but in some cases providing a List may be simpler than an ArgumentList, i.e.

FunctionMetadata(String id, ArgumentList arguments, Type returnType, String description, IdentifiedFunction.Category category, String source)
Method Summary

Modifier and Type

Method

Description

ArgumentList

getArguments()

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

Field Details
- NO_DESCRIPTION
  
  public static final String NO_DESCRIPTION
  See Also:
  
  Constant Field Values
- UNCATEGORIZED
  
  public static final IdentifiedFunction.Category UNCATEGORIZED
Constructor Details
- FunctionMetadata
  
  public FunctionMetadata(String id, List<Type> argumentTypes, Type returnType, String source)
  
  This constructor is useful for testing
- FunctionMetadata
  
  public FunctionMetadata(String id, List<Type> argumentTypes, Type returnType, String description, IdentifiedFunction.Category category, String source)
  
  Note that in general you would want to use the constructor FunctionMetadata(String, ArgumentList, Type, String, IdentifiedFunction.Category, String) instead, but in some cases providing a List may be simpler than an ArgumentList, i.e. when the arguments don't have any keywords.
- FunctionMetadata
  
  public FunctionMetadata(String id, ArgumentList arguments, Type returnType, String description, IdentifiedFunction.Category category, String source)
Method Details
- getId
  
  public String getId()
  
  Specified by:
  
  getId in interface Identified
  
  Returns:
  
  id
- getArguments
  
  public ArgumentList getArguments()
- getReturnType
  
  public Type getReturnType()
- getDescription
  
  public String getDescription()
- getCategory
  
  public IdentifiedFunction.Category getCategory()
- getSource
  
  public String getSource()

Class FunctionMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

NO_DESCRIPTION

UNCATEGORIZED

Constructor Details

FunctionMetadata

FunctionMetadata

FunctionMetadata

Method Details

getId

getArguments

getReturnType

getDescription

getCategory

getSource