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

Class UDFParameterValidator

java.lang.Object

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

public class UDFParameterValidator
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UDFParameterValidator.MultipleObjectsValidationRule
static interface	UDFParameterValidator.SingleObjectValidationRule

Constructor Summary

Constructors

Constructor	Description
UDFParameterValidator(UDFParameters parameters)

Method Summary

Modifier and Type	Method	Description
UDFParameters	getParameters()
UDFParameterValidator	validate(UDFParameterValidator.MultipleObjectsValidationRule validationRule, java.lang.String messageToThrow, java.lang.Object... arguments)	Validates the input parameters according to the validation rule given by the user.
UDFParameterValidator	validate(UDFParameterValidator.SingleObjectValidationRule validationRule, java.lang.String messageToThrow, java.lang.Object argument)	Validates the input parameters according to the validation rule given by the user.
UDFParameterValidator	validateInputSeriesDataType(int index, Type expectedDataType)	Validates whether the data type of the input series at the specified column is as expected.
UDFParameterValidator	validateInputSeriesDataType(int index, Type... expectedDataTypes)	Validates whether the data type of the input series at the specified column is as expected.
UDFParameterValidator	validateInputSeriesNumber(int expectedSeriesNumber)	Validates whether the number of the input series is as expected.
UDFParameterValidator	validateInputSeriesNumber(int expectedSeriesNumberLowerBound, int expectedSeriesNumberUpperBound)	Validates whether the number of the input series is as expected.
UDFParameterValidator	validateRequiredAttribute(java.lang.String attributeKey)	Validates whether the attributes entered by the user contain an attribute whose key is attributeKey.

Methods inherited from class java.lang.Object

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

Constructor Detail

UDFParameterValidator

public UDFParameterValidator(UDFParameters parameters)

Method Detail

getParameters

public UDFParameters getParameters()

validateRequiredAttribute

public UDFParameterValidator validateRequiredAttribute(java.lang.String attributeKey)
                                                throws UDFAttributeNotProvidedException

Validates whether the attributes entered by the user contain an attribute whose key is attributeKey.

Parameters:

attributeKey - key of the attribute

Throws:

UDFAttributeNotProvidedException - if the attribute is not provided

validateInputSeriesDataType

public UDFParameterValidator validateInputSeriesDataType(int index,
                                                         Type expectedDataType)
                                                  throws UDFException

Validates whether the data type of the input series at the specified column is as expected.

Parameters:

index - index of the specified column

expectedDataType - the expected data type

Throws:

UDFInputSeriesIndexNotValidException - if the index of the specified column is out of bound

UDFInputSeriesDataTypeNotValidException - if the data type of the input series at the specified column is not as expected

UDFException

validateInputSeriesDataType

public UDFParameterValidator validateInputSeriesDataType(int index,
                                                         Type... expectedDataTypes)
                                                  throws UDFException

Validates whether the data type of the input series at the specified column is as expected.

Parameters:

index - index of the specified column

expectedDataTypes - the expected data types

Throws:

UDFInputSeriesIndexNotValidException - if the index of the specified column is out of bound

UDFInputSeriesDataTypeNotValidException - if the data type of the input series at the specified column is not as expected

UDFException

validateInputSeriesNumber

public UDFParameterValidator validateInputSeriesNumber(int expectedSeriesNumber)
                                                throws UDFInputSeriesNumberNotValidException

Validates whether the number of the input series is as expected.

Parameters:

expectedSeriesNumber - the expected number of the input series

Throws:

UDFInputSeriesNumberNotValidException - if the number of the input series is not as expected

validateInputSeriesNumber

public UDFParameterValidator validateInputSeriesNumber(int expectedSeriesNumberLowerBound,
                                                       int expectedSeriesNumberUpperBound)
                                                throws UDFInputSeriesNumberNotValidException

Validates whether the number of the input series is as expected.

Parameters:

expectedSeriesNumberLowerBound - the number of the input series must be greater than or equal to the expectedSeriesNumberLowerBound

expectedSeriesNumberUpperBound - the number of the input series must be less than or equal to the expectedSeriesNumberUpperBound

Throws:

UDFInputSeriesNumberNotValidException - if the number of the input series is not as expected

validate

public UDFParameterValidator validate(UDFParameterValidator.SingleObjectValidationRule validationRule,
                                      java.lang.String messageToThrow,
                                      java.lang.Object argument)
                               throws UDFParameterNotValidException

Validates the input parameters according to the validation rule given by the user.

Parameters:

validationRule - the validation rule, which can be a lambda expression

messageToThrow - the message to throw when the given argument is not valid

argument - the given argument

Throws:

UDFParameterNotValidException - if the given argument is not valid

validate

public UDFParameterValidator validate(UDFParameterValidator.MultipleObjectsValidationRule validationRule,
                                      java.lang.String messageToThrow,
                                      java.lang.Object... arguments)
                               throws UDFParameterNotValidException

Validates the input parameters according to the validation rule given by the user.

Parameters:

validationRule - the validation rule, which can be a lambda expression

messageToThrow - the message to throw when the given arguments are not valid

arguments - the given arguments

Throws:

UDFParameterNotValidException - if the given arguments are not valid