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

Class PipeParameterValidator

java.lang.Object

org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator

public class PipeParameterValidator
extends Object

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
PipeParameterValidator(PipeParameters parameters)

Method Summary

Modifier and Type	Method	Description
PipeParameters	getParameters()
PipeParameterValidator	validate(PipeParameterValidator.MultipleObjectsValidationRule validationRule, String messageToThrow, Object... arguments)	Validates the input parameters according to the validation rule given by the user.
PipeParameterValidator	validate(PipeParameterValidator.SingleObjectValidationRule validationRule, String messageToThrow, Object argument)	Validates the input parameters according to the validation rule given by the user.
PipeParameterValidator	validateAttributeValueRange(String key, boolean canBeOptional, String... optionalValues)
PipeParameterValidator	validateRequiredAttribute(String key)	Validates whether the attributes entered by the user contain an attribute whose key is attributeKey.
PipeParameterValidator	validateSynonymAttributes(List<String> lhsAttributes, List<String> rhsAttributes, boolean isRequired)	Validates whether the attributes entered by the user contain at least one attribute from lhsAttributes or rhsAttributes (if required), but not both.

Methods inherited from class java.lang.Object

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

Constructor Details

PipeParameterValidator

public PipeParameterValidator(PipeParameters parameters)

Method Details

getParameters

public PipeParameters getParameters()

validateSynonymAttributes

public PipeParameterValidator validateSynonymAttributes(List<String> lhsAttributes,
 List<String> rhsAttributes,
 boolean isRequired)

Validates whether the attributes entered by the user contain at least one attribute from lhsAttributes or rhsAttributes (if required), but not both.

Parameters:

lhsAttributes - list of left-hand side synonym attributes

rhsAttributes - list of right-hand side synonym attributes

isRequired - specifies whether at least one attribute from lhsAttributes or rhsAttributes must be provided

Returns:

the instance of PipeParameterValidator for method chaining

Throws:

PipeParameterNotValidException - if both lhsAttributes and rhsAttributes are provided

PipeAttributeNotProvidedException - if isRequired is true and neither lhsAttributes nor rhsAttributes are provided

validateRequiredAttribute

public PipeParameterValidator validateRequiredAttribute(String key)
                                                 throws PipeAttributeNotProvidedException

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

Parameters:

key - key of the attribute

Throws:

PipeAttributeNotProvidedException - if the attribute is not provided

validateAttributeValueRange

public PipeParameterValidator validateAttributeValueRange(String key,
 boolean canBeOptional,
 String... optionalValues)
                                                   throws PipeAttributeNotProvidedException

Throws:

PipeAttributeNotProvidedException

validate

public PipeParameterValidator validate(PipeParameterValidator.SingleObjectValidationRule validationRule,
 String messageToThrow,
 Object argument)
                                throws PipeParameterNotValidException

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:

PipeParameterNotValidException - if the given argument is not valid

validate

public PipeParameterValidator validate(PipeParameterValidator.MultipleObjectsValidationRule validationRule,
 String messageToThrow,
 Object... arguments)
                                throws PipeParameterNotValidException

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:

PipeParameterNotValidException - if the given arguments are not valid