Module dev.metaschema.core

Package dev.metaschema.core.metapath.item.node

Class AllowedValueCollectingNodeItemVisitor

java.lang.Object

dev.metaschema.core.metapath.item.node.AbstractNodeItemVisitor<CONTEXT,RESULT>

dev.metaschema.core.metapath.item.node.AbstractRecursionPreventingNodeItemVisitor<DynamicContext,Void>

dev.metaschema.core.metapath.item.node.AllowedValueCollectingNodeItemVisitor

All Implemented Interfaces:

INodeItemVisitor<DynamicContext,Void>

public class AllowedValueCollectingNodeItemVisitor
extends AbstractRecursionPreventingNodeItemVisitor<DynamicContext,Void>

A visitor that traverses a Metaschema module's node items and collects all allowed-values constraints, organized by the target node they apply to.

This visitor extends AbstractRecursionPreventingNodeItemVisitor to safely handle recursive assembly definitions without infinite looping.

Usage example:

 AllowedValueCollectingNodeItemVisitor visitor
     = new AllowedValueCollectingNodeItemVisitor();
 visitor.visit(module);
 Collection<NodeItemRecord> locations = visitor.getAllowedValueLocations();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AllowedValueCollectingNodeItemVisitor.AllowedValuesRecord	A record capturing the relationship between an allowed-values constraint, the definition where it is declared, and the target node it applies to.
static final class	AllowedValueCollectingNodeItemVisitor.NodeItemRecord	A record that associates a definition node item with all the allowed-values constraints that target it.

Constructor Summary

Constructors

Constructor	Description
AllowedValueCollectingNodeItemVisitor()

Method Summary

Modifier and Type	Method	Description
protected Void	defaultResult()	The initial, default visitation result, which will be used as the basis for aggregating results produced when visiting.
Collection<AllowedValueCollectingNodeItemVisitor.NodeItemRecord>	getAllowedValueLocations()	Get the collected allowed-values constraint locations found during visitation.
void	visit(IModuleNodeItem module, DynamicContext context)	Visit all definitions in the provided module node item using the given dynamic context.
void	visit(IModule module)	Visit all definitions in the provided module to collect allowed-values constraints.
Void	visitAssembly(IAssemblyInstanceGroupedNodeItem item, DynamicContext context)	This callback is called when an IAssemblyInstanceGroupedNodeItem is visited.
Void	visitAssembly(IAssemblyNodeItem item, DynamicContext context)	This callback is called when an IAssemblyNodeItem is visited.
Void	visitField(IFieldNodeItem item, DynamicContext context)	This callback is called when an IFieldNodeItem is visited.
Void	visitFlag(IFlagNodeItem item, DynamicContext context)	This callback is called when an IFlagNodeItem is visited.

Methods inherited from class dev.metaschema.core.metapath.item.node.AbstractRecursionPreventingNodeItemVisitor

isDecendant

Methods inherited from class dev.metaschema.core.metapath.item.node.AbstractNodeItemVisitor

aggregateResult, shouldVisitNextChild, shouldVisitNextChild, visit, visitDocument, visitFlags, visitMetaschema, visitModelChildren

Methods inherited from class java.lang.Object

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

Constructor Details

AllowedValueCollectingNodeItemVisitor

public AllowedValueCollectingNodeItemVisitor()

Method Details

getAllowedValueLocations

@NonNull
public Collection<AllowedValueCollectingNodeItemVisitor.NodeItemRecord> getAllowedValueLocations()

Get the collected allowed-values constraint locations found during visitation.

Returns:

a collection of records, each containing a definition node item and the allowed-values constraints that target it

visit

public void visit(@NonNull
 IModule module)

Visit all definitions in the provided module to collect allowed-values constraints.

This method creates a new DynamicContext configured with the module's default namespace.

Parameters:

module - the Metaschema module to visit

visit

public void visit(@NonNull
 IModuleNodeItem module,
 @NonNull
 DynamicContext context)

Visit all definitions in the provided module node item using the given dynamic context.

The provided context is configured for module-definition walking: predicate evaluation is disabled and no-data atomization is treated as empty. These settings are applied regardless of their state on the incoming context so that expressions which reach instance-only functions (for example, fn:doc via oscal:resolve-reference(@href)) degrade to empty sequences rather than raising InvalidTypeFunctionException and predicates on definitional targets do not attempt evaluation that requires instance data.

Parameters:

module - the module node item to visit

context - the dynamic context to use for constraint evaluation

visitFlag

public Void visitFlag(IFlagNodeItem item,
 DynamicContext context)

Description copied from interface: INodeItemVisitor

This callback is called when an IFlagNodeItem is visited.

Specified by:

visitFlag in interface INodeItemVisitor<DynamicContext,Void>

Overrides:

visitFlag in class AbstractNodeItemVisitor<DynamicContext,Void>

Parameters:

item - the visited item

context - provides contextual information for use by the visitor

Returns:

the visitation result

visitField

public Void visitField(IFieldNodeItem item,
 DynamicContext context)

Description copied from interface: INodeItemVisitor

This callback is called when an IFieldNodeItem is visited.

Specified by:

visitField in interface INodeItemVisitor<DynamicContext,Void>

Overrides:

visitField in class AbstractNodeItemVisitor<DynamicContext,Void>

Parameters:

item - the visited item

context - provides contextual information for use by the visitor

Returns:

the visitation result

visitAssembly

public Void visitAssembly(IAssemblyNodeItem item,
 DynamicContext context)

Description copied from interface: INodeItemVisitor

This callback is called when an IAssemblyNodeItem is visited.

Specified by:

visitAssembly in interface INodeItemVisitor<DynamicContext,Void>

Overrides:

visitAssembly in class AbstractRecursionPreventingNodeItemVisitor<DynamicContext,Void>

Parameters:

item - the visited item

context - provides contextual information for use by the visitor

Returns:

the visitation result

visitAssembly

public Void visitAssembly(IAssemblyInstanceGroupedNodeItem item,
 DynamicContext context)

Description copied from interface: INodeItemVisitor

This callback is called when an IAssemblyInstanceGroupedNodeItem is visited.

Specified by:

visitAssembly in interface INodeItemVisitor<DynamicContext,Void>

Overrides:

visitAssembly in class AbstractNodeItemVisitor<DynamicContext,Void>

Parameters:

item - the visited item

context - provides contextual information for use by the visitor

Returns:

the visitation result

defaultResult

protected Void defaultResult()

Description copied from class: AbstractNodeItemVisitor

The initial, default visitation result, which will be used as the basis for aggregating results produced when visiting.

Specified by:

defaultResult in class AbstractNodeItemVisitor<DynamicContext,Void>

Returns:

the default result

See Also:

• AbstractNodeItemVisitor.aggregateResult(Object, Object, Object)