Package nz.org.riskscape.defaults.function.csv

Class CsvFunctionFramework.CsvMetadataParams

java.lang.Object

nz.org.riskscape.engine.function.BaseMetadataParams

nz.org.riskscape.defaults.function.csv.CsvFunctionFramework.CsvMetadataParams

Enclosing class:

CsvFunctionFramework

public static class CsvFunctionFramework.CsvMetadataParams
extends nz.org.riskscape.engine.function.BaseMetadataParams

The metadata parameters for a CSV function.

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	defaultExposureValue
Optional<String>	exposureAttribute
String	hazardColumn
URI	location	The location of a file containing the CSV data used by this function.
Optional<nz.org.riskscape.rl.ast.Expression>	mapValue	An expression to map the resulting value.
List<String>	returnColumn

Fields inherited from class nz.org.riskscape.engine.function.BaseMetadataParams

category, description, framework

Constructor Summary

Constructors

Constructor	Description
CsvMetadataParams()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

location

public URI location

The location of a file containing the CSV data used by this function.

hazardColumn

public String hazardColumn

returnColumn

public List<String> returnColumn

exposureAttribute

public Optional<String> exposureAttribute

defaultExposureValue

public Optional<String> defaultExposureValue

mapValue

public Optional<nz.org.riskscape.rl.ast.Expression> mapValue

An expression to map the resulting value.

As well as having access to the value, the exposure and hazard will also be available to use in the expression.

Internally the expression will be a lambda but users can enter it as a regular expression as a convenience.

Constructor Details

CsvMetadataParams

public CsvMetadataParams()