Package com.flowable.platform.engine.impl.datadictionary.validation

Class DataDictionaryValidatorImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<PlatformEngineConfiguration>

com.flowable.platform.engine.impl.datadictionary.validation.DataDictionaryValidatorImpl

All Implemented Interfaces:

DataDictionaryValidator

public class DataDictionaryValidatorImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<PlatformEngineConfiguration>
implements DataDictionaryValidator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DataDictionaryValidatorImpl.DataDictionaryValidationBuilderImpl
protected static class	DataDictionaryValidatorImpl.ErrorProblem
protected static enum	DataDictionaryValidatorImpl.TypeCompatibility
protected static class	DataDictionaryValidatorImpl.ValidationContext
protected static enum	DataDictionaryValidatorImpl.ValidationMode

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<String,String>	IN_WORD_TRANSLATIONS

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor	Description
DataDictionaryValidatorImpl(PlatformEngineConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected static Map<String,String>	appendIndexToTranslations(Map<String,String> translations, int index)
protected static String	buildDisplayLabel(TypeProperty property, String propertyName, String parentDisplayLabel)
protected static Map<String,String>	buildDisplayLabelTranslations(TypeProperty property, String propertyName, String parentDisplayLabel, Map<String,String> parentDisplayLabelTranslations)
DataDictionaryValidationBuilder	createBuilder()	Creates and returns a new instance of DataDictionaryValidationBuilder.
protected DataDictionaryValidatorImpl.ValidationContext	createValidationContext(String variableName, String customTypeName, String type, Object value)
protected static String	extractBaseDisplayLabel(String displayLabel)
protected static Map<String,String>	extractLabelTranslations(TypeProperty property)
protected static Map<String,String>	extractLabelTranslationsFromDictionaryType(DictionaryType dictionaryType)
protected static Map<String,String>	extractLabelTranslationsFromI18n(Map<String,Map<String,String>> i18n)
protected static Object	extractValue(Object object)
protected DataDictionaryValidatorImpl.ValidationContext	internalValidate(String variableName, DictionaryType type, Object value, DataDictionaryValidatorImpl.ValidationMode validationMode)
protected ValidationResult	internalValidate(String variableName, TypeProperty typeProperty, Object value, DataDictionaryValidatorImpl.ValidationMode validationMode)
protected boolean	isCollectionWithMap(Object object)
protected Object	unwrapValueToValidate(Object value, String type)
protected ValidationResult	validate(DataDictionaryValidatorImpl.DataDictionaryValidationBuilderImpl builder)
protected void	validate(DataDictionaryValidatorImpl.ValidationContext context, DictionaryType dictionaryType, Object value, DataDictionaryValidatorImpl.ValidationMode validationMode)
protected void	validate(DataDictionaryValidatorImpl.ValidationContext context, TypeProperty typeProperty, Object value, DataDictionaryValidatorImpl.ValidationMode validationMode)
protected DataDictionaryValidatorImpl.TypeCompatibility	validate(DataDictionaryValidatorImpl.ValidationContext context, Collection<Constraint> constraints, DataDictionaryValidatorImpl.ValidationMode validationMode)
ValidationResult	validate(String variableName, DictionaryType type, Object value)	Validates if the specified value is compatible with the defined DictionaryType.
ValidationResult	validate(String variableName, TypeProperty typeProperty, Object value)	Validates if the specified value adheres to the constraints and specifications of the given TypeProperty.
protected void	validateProperties(DataDictionaryValidatorImpl.ValidationContext context, Map<String,TypeProperty> properties, tools.jackson.databind.JsonNode currentObject, DataDictionaryValidatorImpl.ValidationMode validationMode)
protected boolean	validateTypeCompatibility(DataDictionaryValidatorImpl.ValidationContext context)

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Field Details

IN_WORD_TRANSLATIONS

protected static final Map<String,String> IN_WORD_TRANSLATIONS

Constructor Details

DataDictionaryValidatorImpl

public DataDictionaryValidatorImpl(PlatformEngineConfiguration configuration)

Method Details

validate

public ValidationResult validate(String variableName,
 DictionaryType type,
 Object value)

Description copied from interface: DataDictionaryValidator

Validates if the specified value is compatible with the defined DictionaryType. This method checks whether the value adheres to the type specifications, including any constraints and flags associated with the type, such as the 'required' flag. The validation process includes type compatibility and constraint checking.

Specified by:

validate in interface DataDictionaryValidator

Parameters:

variableName - The name of the variable being validated. This is used for identification purposes in the validation process.

type - The DictionaryType against which the value is to be validated.

value - The value to be validated.

Returns:

ValidationResult An object encapsulating the result of the validation.

validate

public ValidationResult validate(String variableName,
 TypeProperty typeProperty,
 Object value)

Description copied from interface: DataDictionaryValidator

Validates if the specified value adheres to the constraints and specifications of the given TypeProperty. This method is responsible for ensuring that the provided value aligns with the expected characteristics defined by the TypeProperty, such as data type, format, range, or any other custom constraints. It is particularly useful for validating individual properties of a complex type or structure.

Specified by:

validate in interface DataDictionaryValidator

Parameters:

variableName - The name of the variable being validated. This name is used primarily for identification and reporting purposes.

typeProperty - The TypeProperty to validate against.

value - The value to be validated against the TypeProperty.

Returns:

ValidationResult An object encapsulating the result of the validation.

createBuilder

public DataDictionaryValidationBuilder createBuilder()

Description copied from interface: DataDictionaryValidator

Creates and returns a new instance of DataDictionaryValidationBuilder. This builder is used to configure a validation for data against a defined data dictionary type. It is used to set up various aspects of validation such as the type or type property to validate against, the value to validate, and the level of validation (type check only or full validation).

Specified by:

createBuilder in interface DataDictionaryValidator

Returns:

A new instance of DataDictionaryValidationBuilder.

internalValidate

protected DataDictionaryValidatorImpl.ValidationContext internalValidate(String variableName,
 DictionaryType type,
 Object value,
 DataDictionaryValidatorImpl.ValidationMode validationMode)

internalValidate

protected ValidationResult internalValidate(String variableName,
 TypeProperty typeProperty,
 Object value,
 DataDictionaryValidatorImpl.ValidationMode validationMode)

isCollectionWithMap

protected boolean isCollectionWithMap(Object object)

createValidationContext

protected DataDictionaryValidatorImpl.ValidationContext createValidationContext(String variableName,
 String customTypeName,
 String type,
 Object value)

validate

protected DataDictionaryValidatorImpl.TypeCompatibility validate(DataDictionaryValidatorImpl.ValidationContext context,
 Collection<Constraint> constraints,
 DataDictionaryValidatorImpl.ValidationMode validationMode)

unwrapValueToValidate

protected Object unwrapValueToValidate(Object value,
 String type)

validate

protected void validate(DataDictionaryValidatorImpl.ValidationContext context,
 DictionaryType dictionaryType,
 Object value,
 DataDictionaryValidatorImpl.ValidationMode validationMode)

validate

protected void validate(DataDictionaryValidatorImpl.ValidationContext context,
 TypeProperty typeProperty,
 Object value,
 DataDictionaryValidatorImpl.ValidationMode validationMode)

validateProperties

protected void validateProperties(DataDictionaryValidatorImpl.ValidationContext context,
 Map<String,TypeProperty> properties,
 tools.jackson.databind.JsonNode currentObject,
 DataDictionaryValidatorImpl.ValidationMode validationMode)

buildDisplayLabel

protected static String buildDisplayLabel(TypeProperty property,
 String propertyName,
 String parentDisplayLabel)

buildDisplayLabelTranslations

protected static Map<String,String> buildDisplayLabelTranslations(TypeProperty property,
 String propertyName,
 String parentDisplayLabel,
 Map<String,String> parentDisplayLabelTranslations)

extractLabelTranslations

protected static Map<String,String> extractLabelTranslations(TypeProperty property)

extractLabelTranslationsFromDictionaryType

protected static Map<String,String> extractLabelTranslationsFromDictionaryType(DictionaryType dictionaryType)

extractLabelTranslationsFromI18n

protected static Map<String,String> extractLabelTranslationsFromI18n(Map<String,Map<String,String>> i18n)

appendIndexToTranslations

protected static Map<String,String> appendIndexToTranslations(Map<String,String> translations,
 int index)

extractBaseDisplayLabel

protected static String extractBaseDisplayLabel(String displayLabel)

validateTypeCompatibility

protected boolean validateTypeCompatibility(DataDictionaryValidatorImpl.ValidationContext context)

Returns:

true in case type is compatible, otherwise returns false and adds validation error to the context

extractValue

protected static Object extractValue(Object object)

validate

protected ValidationResult validate(DataDictionaryValidatorImpl.DataDictionaryValidationBuilderImpl builder)