Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Interface IIndexConstraint

All Superinterfaces:

IAttributable, IConfigurableMessageConstraint, IConstraint, IDescribable, IKeyConstraint

public interface IIndexConstraint
extends IKeyConstraint

Represents a rule that generates a key-based index containing references to data items found in a Metaschema data instance.

The generated index can be used to check cross-references between Metaschema data objects using the IIndexHasKeyConstraint.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IIndexConstraint.Builder	Provides a builder pattern for constructing a new IIndexConstraint.

Nested classes/interfaces inherited from interface dev.metaschema.core.model.IAttributable

IAttributable.Key

Nested classes/interfaces inherited from interface dev.metaschema.core.model.constraint.IConstraint

IConstraint.Level, IConstraint.Type

Field Summary

Fields inherited from interface dev.metaschema.core.model.IAttributable

DEFAULT_PROPERY_NAMESPACE

Method Summary

Modifier and Type	Method	Description
default <T, R> R	accept(IConstraintVisitor<T,R> visitor, T state)	Used for double dispatch supporting the visitor pattern provided by implementations of IConstraintVisitor.
static IIndexConstraint.Builder	builder(String name)	Create a new constraint builder.
String	getName()	Get the identifying name of the index, which is used to refer to the index by an IIndexHasKeyConstraint.
default IConstraint.Type	getType()	Get the constraint type.

Methods inherited from interface dev.metaschema.core.model.IAttributable

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

generateMessage, getMessage

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

getId, getLevel, getRemarks, getSource, getTarget, matchTargets

Methods inherited from interface dev.metaschema.core.model.IDescribable

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

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

getKeyFields

Method Details

getType

default IConstraint.Type getType()

Description copied from interface: IConstraint

Get the constraint type.

Specified by:

getType in interface IConstraint

Returns:

the constraint type

getName

@NonNull
String getName()

Get the identifying name of the index, which is used to refer to the index by an IIndexHasKeyConstraint.

Returns:

the name of the index

accept

default <T,
R> R accept(IConstraintVisitor<T,R> visitor,
 T state)

Description copied from interface: IConstraint

Used for double dispatch supporting the visitor pattern provided by implementations of IConstraintVisitor.

Specified by:

accept in interface IConstraint

Type Parameters:

T - the Java type of a state object passed to the visitor

R - the Java type of the result returned by the visitor methods

Parameters:

visitor - the visitor implementation

state - the state object passed to the visitor

Returns:

the visitation result

See Also:

• IConstraintVisitor

builder

@NonNull
static IIndexConstraint.Builder builder(@NonNull
 String name)

Create a new constraint builder.

Parameters:

name - the identifier for the index

Returns:

the builder