Package org.apache.iotdb.udf.api.customizer.parameter

Class UDFParameters

java.lang.Object

org.apache.iotdb.udf.api.customizer.parameter.UDFParameters

public class UDFParameters
extends java.lang.Object

Used in UDTF.beforeStart(UDFParameters, UDTFConfigurations).

This class is used to parse the parameters in the UDF entered by the user.

The input parameters of UDF have two parts. The first part is the paths (measurements) of the time series that the UDF needs to process, and the second part is the key-value pair attributes for customization. Only the second part can be empty.

Note that the user must enter the paths (measurements) part before entering the attributes part.

Constructor Summary

Constructors

Constructor	Description
UDFParameters(java.util.List<java.lang.String> childExpressions, java.util.List<Type> childExpressionDataTypes, java.util.Map<java.lang.String,java.lang.String> attributes)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.lang.Boolean	getBoolean(java.lang.String key)
boolean	getBooleanOrDefault(java.lang.String key, boolean defaultValue)
java.util.List<java.lang.String>	getChildExpressions()
int	getChildExpressionsSize()
Type	getDataType(int index)
java.util.List<Type>	getDataTypes()
java.lang.Double	getDouble(java.lang.String key)
double	getDoubleOrDefault(java.lang.String key, double defaultValue)
java.lang.Float	getFloat(java.lang.String key)
float	getFloatOrDefault(java.lang.String key, float defaultValue)
java.lang.Integer	getInt(java.lang.String key)
int	getIntOrDefault(java.lang.String key, int defaultValue)
java.lang.Long	getLong(java.lang.String key)
long	getLongOrDefault(java.lang.String key, long defaultValue)
java.lang.String	getString(java.lang.String key)
java.lang.String	getStringOrDefault(java.lang.String key, java.lang.String defaultValue)
boolean	hasAttribute(java.lang.String attributeKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

UDFParameters

public UDFParameters(java.util.List<java.lang.String> childExpressions,
                     java.util.List<Type> childExpressionDataTypes,
                     java.util.Map<java.lang.String,java.lang.String> attributes)

Method Detail

getChildExpressions

public java.util.List<java.lang.String> getChildExpressions()

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

getDataTypes

public java.util.List<Type> getDataTypes()

getChildExpressionsSize

public int getChildExpressionsSize()

getDataType

public Type getDataType(int index)

hasAttribute

public boolean hasAttribute(java.lang.String attributeKey)

getString

public java.lang.String getString(java.lang.String key)

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

getInt

public java.lang.Integer getInt(java.lang.String key)

getLong

public java.lang.Long getLong(java.lang.String key)

getFloat

public java.lang.Float getFloat(java.lang.String key)

getDouble

public java.lang.Double getDouble(java.lang.String key)

getStringOrDefault

public java.lang.String getStringOrDefault(java.lang.String key,
                                           java.lang.String defaultValue)

getBooleanOrDefault

public boolean getBooleanOrDefault(java.lang.String key,
                                   boolean defaultValue)

getIntOrDefault

public int getIntOrDefault(java.lang.String key,
                           int defaultValue)

getLongOrDefault

public long getLongOrDefault(java.lang.String key,
                             long defaultValue)

getFloatOrDefault

public float getFloatOrDefault(java.lang.String key,
                               float defaultValue)

getDoubleOrDefault

public double getDoubleOrDefault(java.lang.String key,
                                 double defaultValue)