Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Interface IFeatureValueConstrained

All Superinterfaces:

IValueConstrained

All Known Subinterfaces:

IAssemblyDefinition, IDefinition, IFeatureContainerFlag<FI>, IFeatureDefinitionInstanceInlined<DEFINITION,INSTANCE>, IFeatureModelConstrained, IFieldDefinition, IFlagDefinition, IModelDefinition, IValuedDefinition

All Known Implementing Classes:

AbstractGlobalAssemblyDefinition, AbstractGlobalDefinition, AbstractGlobalFieldDefinition, AbstractGlobalFlagDefinition, AbstractInlineAssemblyDefinition, AbstractInlineFieldDefinition, AbstractInlineFlagDefinition, AbstractTargetedConstraints, AssemblyTargetedConstraints, FieldTargetedConstraints, FlagTargetedConstraints, ModelTargetedConstraints

public interface IFeatureValueConstrained
extends IValueConstrained

A marker interface for a Metaschema valued construct (i.e. flag, field) that can be constrained using Metaschema constraints.

Method Summary

Modifier and Type	Method	Description
default void	addConstraint(IAllowedValuesConstraint constraint)	Add a new constraint.
default void	addConstraint(IExpectConstraint constraint)	Add a new constraint.
default void	addConstraint(IIndexHasKeyConstraint constraint)	Add a new constraint.
default void	addConstraint(IMatchesConstraint constraint)	Add a new constraint.
default void	addConstraint(IReportConstraint constraint)	Add a new constraint.
default ILet	addLetExpression(ILet let)	Add a new let expression.
default List<? extends IAllowedValuesConstraint>	getAllowedValuesConstraints()	Get the collection of allowed value constraints, if any.
default List<? extends IConstraint>	getConstraints()	Retrieve the ordered collection of constraints.
IValueConstrained	getConstraintSupport()	Lazy initialize the instances for the constraints when the constraints are first accessed.
default List<? extends IExpectConstraint>	getExpectConstraints()	Get the collection of expect constraints, if any.
default List<? extends IIndexHasKeyConstraint>	getIndexHasKeyConstraints()	Get the collection of index key reference constraints, if any.
default Map<IEnhancedQName,ILet>	getLetExpressions()	Get the collection of let expressions, if any.
default List<? extends IMatchesConstraint>	getMatchesConstraints()	Get the collection of matches constraints, if any.
default List<? extends IReportConstraint>	getReportConstraints()	Get the collection of report constraints, if any.

Methods inherited from interface dev.metaschema.core.model.constraint.IValueConstrained

getSource

Method Details

getConstraintSupport

@NonNull
IValueConstrained getConstraintSupport()

Lazy initialize the instances for the constraints when the constraints are first accessed.

Returns:

the constraints instance

addLetExpression

default ILet addLetExpression(ILet let)

Description copied from interface: IValueConstrained

Add a new let expression.

Specified by:

addLetExpression in interface IValueConstrained

Parameters:

let - the let statement to add

Returns:

the original let with the same name or null if no let existed with the same name

getLetExpressions

default Map<IEnhancedQName,ILet> getLetExpressions()

Description copied from interface: IValueConstrained

Get the collection of let expressions, if any.

Specified by:

getLetExpressions in interface IValueConstrained

Returns:

the constraints or an empty list

getConstraints

default List<? extends IConstraint> getConstraints()

Description copied from interface: IValueConstrained

Retrieve the ordered collection of constraints.

Specified by:

getConstraints in interface IValueConstrained

Returns:

the constraints or an empty list

getAllowedValuesConstraints

default List<? extends IAllowedValuesConstraint> getAllowedValuesConstraints()

Description copied from interface: IValueConstrained

Get the collection of allowed value constraints, if any.

Specified by:

getAllowedValuesConstraints in interface IValueConstrained

Returns:

the constraints or an empty list

getMatchesConstraints

default List<? extends IMatchesConstraint> getMatchesConstraints()

Description copied from interface: IValueConstrained

Get the collection of matches constraints, if any.

Specified by:

getMatchesConstraints in interface IValueConstrained

Returns:

the constraints or an empty list

getIndexHasKeyConstraints

default List<? extends IIndexHasKeyConstraint> getIndexHasKeyConstraints()

Description copied from interface: IValueConstrained

Get the collection of index key reference constraints, if any.

Specified by:

getIndexHasKeyConstraints in interface IValueConstrained

Returns:

the constraints or an empty list

getExpectConstraints

default List<? extends IExpectConstraint> getExpectConstraints()

Description copied from interface: IValueConstrained

Get the collection of expect constraints, if any.

Specified by:

getExpectConstraints in interface IValueConstrained

Returns:

the constraints or an empty list

getReportConstraints

default List<? extends IReportConstraint> getReportConstraints()

Description copied from interface: IValueConstrained

Get the collection of report constraints, if any.

Specified by:

getReportConstraints in interface IValueConstrained

Returns:

the constraints or an empty list

addConstraint

default void addConstraint(IAllowedValuesConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add

addConstraint

default void addConstraint(IMatchesConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add

addConstraint

default void addConstraint(IIndexHasKeyConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add

addConstraint

default void addConstraint(@NonNull
 IExpectConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add

addConstraint

default void addConstraint(@NonNull
 IReportConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add