Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Class ValueConstraintSet

java.lang.Object

dev.metaschema.core.model.constraint.ValueConstraintSet

All Implemented Interfaces:

IValueConstrained

Direct Known Subclasses:

AssemblyConstraintSet

public class ValueConstraintSet
extends Object
implements IValueConstrained

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

Constructor Summary

Constructors

Constructor	Description
ValueConstraintSet(ISource source)	Construct a new constraint set.

Method Summary

Modifier and Type	Method	Description
final void	addConstraint(IAllowedValuesConstraint constraint)	Add a new constraint.
final void	addConstraint(IExpectConstraint constraint)	Add a new constraint.
final void	addConstraint(IIndexHasKeyConstraint constraint)	Add a new constraint.
final void	addConstraint(IMatchesConstraint constraint)	Add a new constraint.
final void	addConstraint(IReportConstraint constraint)	Add a new constraint.
ILet	addLetExpression(ILet let)	Add a new let expression.
List<IAllowedValuesConstraint>	getAllowedValuesConstraints()	Get the collection of allowed value constraints, if any.
List<IConstraint>	getConstraints()	Retrieve the ordered collection of constraints.
protected List<IConstraint>	getConstraintsInternal()	Get the underlying constraint collection.
List<IExpectConstraint>	getExpectConstraints()	Get the collection of expect constraints, if any.
List<IIndexHasKeyConstraint>	getIndexHasKeyConstraints()	Get the collection of index key reference constraints, if any.
Map<IEnhancedQName,ILet>	getLetExpressions()	Get the collection of let expressions, if any.
protected ReadWriteLock	getLock()	Get the read-write lock used to manage access to the underlying constraint collections.
List<IMatchesConstraint>	getMatchesConstraints()	Get the collection of matches constraints, if any.
List<IReportConstraint>	getReportConstraints()	Get the collection of report constraints, if any.
ISource	getSource()	Get information about the resource the constraints were loaded from.

Methods inherited from class java.lang.Object

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

Constructor Details

ValueConstraintSet

public ValueConstraintSet(@NonNull
 ISource source)

Construct a new constraint set.

Parameters:

source - information about the resource the constraints were loaded from

Method Details

getSource

public ISource getSource()

Description copied from interface: IValueConstrained

Get information about the resource the constraints were loaded from.

Specified by:

getSource in interface IValueConstrained

Returns:

the source information

getLock

@NonNull
protected ReadWriteLock getLock()

Get the read-write lock used to manage access to the underlying constraint collections.

This can be used by extending classes to control read/write access to constraint data, supporting multi-threaded access.

Returns:

the lock

getConstraintsInternal

@NonNull
protected List<IConstraint> getConstraintsInternal()

Get the underlying constraint collection.

Access to the returned collection is not thread safe. Callers should use getLock() to get the read/write lock for managing access.

Returns:

the constraint collection

getLetExpressions

public 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

addLetExpression

public 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

getConstraints

public List<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

public List<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

public List<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

public List<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

public List<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

public List<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

public final void addConstraint(@NonNull
 IAllowedValuesConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add

addConstraint

public final void addConstraint(@NonNull
 IMatchesConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add

addConstraint

public final void addConstraint(@NonNull
 IIndexHasKeyConstraint constraint)

Description copied from interface: IValueConstrained

Add a new constraint.

Specified by:

addConstraint in interface IValueConstrained

Parameters:

constraint - the constraint to add

addConstraint

public final 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

public final 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