Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Interface ILet

public interface ILet

Represents a variable assignment for use in Metaschema module constraints.

Method Summary

Modifier and Type	Method	Description
IEnhancedQName	getName()	Get the name of the let variable.
MarkupMultiline	getRemarks()	Get the remarks associated with the let statement.
ISource	getSource()	Information about the source resource containing the let statement.
IMetapathExpression	getValueExpression()	Get the Metapath expression to use to query the value.
static ILet	of(IEnhancedQName name, IMetapathExpression valueExpression, ISource source, MarkupMultiline remarks)	Create a new Let expression.
static ILet	of(IEnhancedQName name, String valueExpression, ISource source, MarkupMultiline remarks)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

of

@NonNull
@Deprecated(since="2.2.0",
            forRemoval=true)
static ILet of(@NonNull
 IEnhancedQName name,
 @NonNull
 String valueExpression,
 @NonNull
 ISource source,
 @Nullable
 MarkupMultiline remarks)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new Let expression by compiling the provided Metapath expression string.

This method is deprecated. Callers should use of(IEnhancedQName, IMetapathExpression, ISource, MarkupMultiline) instead.

Parameters:

name - the let expression variable name

valueExpression - a Metapath expression string representing the variable value

source - the source descriptor for the resource containing the constraint

remarks - remarks about the let statement

Returns:

the original let statement with the same name or null

of

@NonNull
static ILet of(@NonNull
 IEnhancedQName name,
 @NonNull
 IMetapathExpression valueExpression,
 @NonNull
 ISource source,
 @Nullable
 MarkupMultiline remarks)

Create a new Let expression.

Parameters:

name - the let expression variable name

valueExpression - a Metapath expression representing the variable value

source - the source descriptor for the resource containing the constraint

remarks - remarks about the let statement

Returns:

the original let statement with the same name or null

getName

@NonNull
IEnhancedQName getName()

Get the name of the let variable.

Returns:

the name

getValueExpression

@NonNull
IMetapathExpression getValueExpression()

Get the Metapath expression to use to query the value.

Returns:

the Metapath expression to use to query the value

getSource

@NonNull
ISource getSource()

Information about the source resource containing the let statement.

Returns:

the source information

getRemarks

@Nullable
MarkupMultiline getRemarks()

Get the remarks associated with the let statement.

Returns:

the remark or null if no remarks are defined