Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Interface IValueConstrained

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface IValueConstrained

Represents a container of rules constraining the effective model of a Metaschema field or flag data instance.

Method Summary

Modifier and Type	Method	Description
void	addConstraint(IAllowedValuesConstraint constraint)	Add a new constraint.
void	addConstraint(IExpectConstraint constraint)	Add a new constraint.
void	addConstraint(IIndexHasKeyConstraint constraint)	Add a new constraint.
void	addConstraint(IMatchesConstraint constraint)	Add a new constraint.
void	addConstraint(IReportConstraint constraint)	Add a new constraint.
ILet	addLetExpression(ILet let)	Add a new let expression.
List<? extends IAllowedValuesConstraint>	getAllowedValuesConstraints()	Get the collection of allowed value constraints, if any.
List<? extends IConstraint>	getConstraints()	Retrieve the ordered collection of constraints.
List<? extends IExpectConstraint>	getExpectConstraints()	Get the collection of expect constraints, if any.
List<? extends IIndexHasKeyConstraint>	getIndexHasKeyConstraints()	Get the collection of index key reference constraints, if any.
Map<IEnhancedQName,ILet>	getLetExpressions()	Get the collection of let expressions, if any.
List<? extends IMatchesConstraint>	getMatchesConstraints()	Get the collection of matches constraints, if any.
List<? extends IReportConstraint>	getReportConstraints()	Get the collection of report constraints, if any.
ISource	getSource()	Get information about the resource the constraints were loaded from.

Method Details

getSource

@NonNull
ISource getSource()

Get information about the resource the constraints were loaded from.

Returns:

the source information

getConstraints

@NonNull
List<? extends IConstraint> getConstraints()

Retrieve the ordered collection of constraints.

Returns:

the constraints or an empty list

getLetExpressions

@NonNull
Map<IEnhancedQName,ILet> getLetExpressions()

Get the collection of let expressions, if any.

Returns:

the constraints or an empty list

getAllowedValuesConstraints

@NonNull
List<? extends IAllowedValuesConstraint> getAllowedValuesConstraints()

Get the collection of allowed value constraints, if any.

Returns:

the constraints or an empty list

getMatchesConstraints

@NonNull
List<? extends IMatchesConstraint> getMatchesConstraints()

Get the collection of matches constraints, if any.

Returns:

the constraints or an empty list

getIndexHasKeyConstraints

@NonNull
List<? extends IIndexHasKeyConstraint> getIndexHasKeyConstraints()

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

Returns:

the constraints or an empty list

getExpectConstraints

@NonNull
List<? extends IExpectConstraint> getExpectConstraints()

Get the collection of expect constraints, if any.

Returns:

the constraints or an empty list

getReportConstraints

@NonNull
List<? extends IReportConstraint> getReportConstraints()

Get the collection of report constraints, if any.

Returns:

the constraints or an empty list

addLetExpression

ILet addLetExpression(@NonNull
 ILet let)

Add a new let expression.

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

addConstraint

void addConstraint(@NonNull
 IAllowedValuesConstraint constraint)

Add a new constraint.

Parameters:

constraint - the constraint to add

addConstraint

void addConstraint(@NonNull
 IMatchesConstraint constraint)

Add a new constraint.

Parameters:

constraint - the constraint to add

addConstraint

void addConstraint(@NonNull
 IIndexHasKeyConstraint constraint)

Add a new constraint.

Parameters:

constraint - the constraint to add

addConstraint

void addConstraint(@NonNull
 IExpectConstraint constraint)

Add a new constraint.

Parameters:

constraint - the constraint to add

addConstraint

void addConstraint(@NonNull
 IReportConstraint constraint)

Add a new constraint.

Parameters:

constraint - the constraint to add