Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Class DefaultConstraintValidator

java.lang.Object

dev.metaschema.core.model.constraint.DefaultConstraintValidator

All Implemented Interfaces:

IConfiguration<ValidationFeature<?>>, IMutableConfiguration<ValidationFeature<?>>, IConstraintValidator, AutoCloseable

public class DefaultConstraintValidator
extends Object
implements IConstraintValidator, IMutableConfiguration<ValidationFeature<?>>

Used to perform constraint validation over one or more node items.

This class is thread-safe and can be used with parallel constraint validation.

Constructor Summary

Constructors

Constructor	Description
DefaultConstraintValidator(IConstraintValidationHandler handler)	Construct a new constraint validation instance with sequential execution.
DefaultConstraintValidator(IConstraintValidationHandler handler, ParallelValidationConfig parallelConfig)	Construct a new constraint validation instance with configurable parallelism.

Method Summary

Modifier and Type	Method	Description
@Owning DefaultConstraintValidator	applyConfiguration(IConfiguration<ValidationFeature<?>> other)	Replace this configuration with the other configuration.
void	close()	Release any resources held by this validator.
@Owning DefaultConstraintValidator	disableFeature(ValidationFeature<?> feature)	Turn off the provided feature.
@Owning DefaultConstraintValidator	enableFeature(ValidationFeature<?> feature)	Turn on the provided feature.
void	finalizeValidation(DynamicContext dynamicContext)	Complete any validations that require full analysis of the content model.
protected IMutableConfiguration<ValidationFeature<?>>	getConfiguration()	Get the current configuration of the serializer/deserializer.
protected IConstraintValidationHandler	getConstraintValidationHandler()	Get the validation handler to use for handling constraint violations.
Map<ValidationFeature<?>,Object>	getFeatureValues()	Get the mapping of each feature mapped to its value.
protected void	handleAllowedValues(INodeItem targetItem, DynamicContext dynamicContext)	Evaluate the value associated with the targetItem and update the status tracker.
boolean	isFeatureEnabled(ValidationFeature<?> feature)	Determines if a specific feature is enabled.
@Owning DefaultConstraintValidator	set(ValidationFeature<?> feature, Object value)	Set the value of the provided feature to the provided value.
protected void	updateValueStatus(INodeItem targetItem, IAllowedValuesConstraint allowedValues, IDefinitionNodeItem<?,?> node)	Add a new allowed value to the value status tracker.
void	validate(INodeItem item, DynamicContext dynamicContext)	Validate the provided item against any associated constraints.
protected void	validateAssembly(IAssemblyNodeItem item, DynamicContext dynamicContext)	Validate the provided assembly item against any associated constraints.
protected void	validateField(IFieldNodeItem item, DynamicContext dynamicContext)	Validate the provided field item against any associated constraints.
protected void	validateFlag(IFlagNodeItem item, DynamicContext dynamicContext)	Validate the provided flag item against any associated constraints.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.metaschema.core.configuration.IConfiguration

get

Constructor Details

DefaultConstraintValidator

public DefaultConstraintValidator(@NonNull
 IConstraintValidationHandler handler)

Construct a new constraint validation instance with sequential execution.

Parameters:

handler - the validation handler to use for handling constraint violations

DefaultConstraintValidator

public DefaultConstraintValidator(@NonNull
 IConstraintValidationHandler handler,
 @NonNull
 ParallelValidationConfig parallelConfig)

Construct a new constraint validation instance with configurable parallelism.

Parameters:

handler - the validation handler to use for handling constraint violations

parallelConfig - the parallel execution configuration

Method Details

getConfiguration

@NonNull
protected IMutableConfiguration<ValidationFeature<?>> getConfiguration()

Get the current configuration of the serializer/deserializer.

Returns:

the configuration

enableFeature

@Owning
public @Owning DefaultConstraintValidator enableFeature(ValidationFeature<?> feature)

Description copied from interface: IMutableConfiguration

Turn on the provided feature.

Specified by:

enableFeature in interface IMutableConfiguration<ValidationFeature<?>>

Parameters:

feature - the feature to turn on

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

disableFeature

@Owning
public @Owning DefaultConstraintValidator disableFeature(ValidationFeature<?> feature)

Description copied from interface: IMutableConfiguration

Turn off the provided feature.

Specified by:

disableFeature in interface IMutableConfiguration<ValidationFeature<?>>

Parameters:

feature - the feature to turn off

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

applyConfiguration

@Owning
public @Owning DefaultConstraintValidator applyConfiguration(@NonNull
 IConfiguration<ValidationFeature<?>> other)

Description copied from interface: IMutableConfiguration

Replace this configuration with the other configuration.

Specified by:

applyConfiguration in interface IMutableConfiguration<ValidationFeature<?>>

Parameters:

other - the new configuration

Returns:

the updated configuration

set

@Owning
public @Owning DefaultConstraintValidator set(ValidationFeature<?> feature,
 Object value)

Description copied from interface: IMutableConfiguration

Set the value of the provided feature to the provided value.

Specified by:

set in interface IMutableConfiguration<ValidationFeature<?>>

Parameters:

feature - the feature to set

value - the value to set

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

isFeatureEnabled

public boolean isFeatureEnabled(ValidationFeature<?> feature)

Description copied from interface: IConfiguration

Determines if a specific feature is enabled.

Specified by:

isFeatureEnabled in interface IConfiguration<ValidationFeature<?>>

Parameters:

feature - the feature to check for

Returns:

true if the feature is enabled, or false otherwise

See Also:

• IConfigurationFeature.getValueClass()

getFeatureValues

public Map<ValidationFeature<?>,Object> getFeatureValues()

Description copied from interface: IConfiguration

Get the mapping of each feature mapped to its value.

Specified by:

getFeatureValues in interface IConfiguration<ValidationFeature<?>>

Returns:

the mapping

getConstraintValidationHandler

@NonNull
protected IConstraintValidationHandler getConstraintValidationHandler()

Get the validation handler to use for handling constraint violations.

Returns:

the handler

close

public void close()

Description copied from interface: IConstraintValidator

Release any resources held by this validator.

This method should be called when the validator is no longer needed to release resources such as thread pools. For validators using sequential execution, this method does nothing.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IConstraintValidator

validate

public void validate(@NonNull
 INodeItem item,
 @NonNull
 DynamicContext dynamicContext)
              throws ConstraintValidationException

Description copied from interface: IConstraintValidator

Validate the provided item against any associated constraints.

Specified by:

validate in interface IConstraintValidator

Parameters:

item - the item to validate

dynamicContext - the Metapath dynamic execution context to use for Metapath evaluation

Throws:

ConstraintValidationException - if a constraint violation is detected

validateFlag

protected void validateFlag(@NonNull
 IFlagNodeItem item,
 @NonNull
 DynamicContext dynamicContext)

Validate the provided flag item against any associated constraints.

Parameters:

item - the flag item to validate

dynamicContext - the Metapath dynamic execution context to use for Metapath evaluation

Throws:

MetapathException - if an error occurred while evaluating a Metapath used in a constraint

validateField

protected void validateField(@NonNull
 IFieldNodeItem item,
 @NonNull
 DynamicContext dynamicContext)

Validate the provided field item against any associated constraints.

Parameters:

item - the field item to validate

dynamicContext - the Metapath dynamic execution context to use for Metapath evaluation

Throws:

MetapathException - if an error occurred while evaluating a Metapath used in a constraint

validateAssembly

protected void validateAssembly(@NonNull
 IAssemblyNodeItem item,
 @NonNull
 DynamicContext dynamicContext)
                         throws ConstraintValidationException

Validate the provided assembly item against any associated constraints.

Parameters:

item - the assembly item to validate

dynamicContext - the Metapath dynamic execution context to use for Metapath evaluation

Throws:

ConstraintValidationException - if an unexpected error occurred while validating a constraint

updateValueStatus

protected void updateValueStatus(@NonNull
 INodeItem targetItem,
 @NonNull
 IAllowedValuesConstraint allowedValues,
 @NonNull
 IDefinitionNodeItem<?,?> node)
                          throws ConstraintValidationException

Add a new allowed value to the value status tracker.

Parameters:

targetItem - the item whose value is targeted by the constraint

allowedValues - the allowed values constraint

node - the original focus of Metapath evaluation for identifying the targets

Throws:

ConstraintValidationException - if an unexpected error occurred while registering the allowed values

handleAllowedValues

protected void handleAllowedValues(@NonNull
 INodeItem targetItem,
 @NonNull
 DynamicContext dynamicContext)

Evaluate the value associated with the targetItem and update the status tracker.

Parameters:

targetItem - the item whose value will be validated

dynamicContext - the Metapath dynamic execution context to use for Metapath evaluation

finalizeValidation

public void finalizeValidation(DynamicContext dynamicContext)
                        throws ConstraintValidationException

Description copied from interface: IConstraintValidator

Complete any validations that require full analysis of the content model.

Specified by:

finalizeValidation in interface IConstraintValidator

Parameters:

dynamicContext - the Metapath dynamic execution context to use for Metapath evaluation

Throws:

ConstraintValidationException - if a constraint violation is detected during finalization