Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Interface IIndexHasKeyConstraint

All Superinterfaces:

IAttributable, IConfigurableMessageConstraint, IConstraint, IDescribable, IKeyConstraint

public interface IIndexHasKeyConstraint
extends IKeyConstraint

Represents a rule that checks that a key generated for a Metaschema data object exists in a named index that was generated using an IIndexConstraint.

Nested Class Summary

Nested Classes

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

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 IIndexHasKeyConstraint.Builder	builder(String useIndex)	Create a new constraint builder.
String	getIndexName()	The name of the index used to verify cross references.
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

getIndexName

@NonNull
String getIndexName()

The name of the index used to verify cross references.

Returns:

the name of the index this constraint uses for lookups

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 IIndexHasKeyConstraint.Builder builder(@NonNull
 String useIndex)

Create a new constraint builder.

Parameters:

useIndex - the index name

Returns:

the builder