Uses of Interface
dev.metaschema.core.model.IModule

Packages that use IModule

Package	Description
dev.metaschema.cli.commands	Provides a collection of abstract and concrete command line interface (CLI) commands that process Metaschema module-based information.
dev.metaschema.core.metapath.item.node	Node item types representing structured data in the Metapath type system.
dev.metaschema.core.model	Core Metaschema model interfaces and implementations.
dev.metaschema.core.model.constraint	Metaschema constraint definitions and validation framework.
dev.metaschema.core.model.util	Utility classes for Metaschema model processing and manipulation.
dev.metaschema.databind	Support for parsing Metaschema module-based data using Java class bindings.
dev.metaschema.databind.codegen	Support for generating "plain old Java objects" (POJOs) based on a Module.
dev.metaschema.databind.codegen.config	Support for customizing how Java code is generated for one or more specific Module modules.
dev.metaschema.databind.config.binding	Provides generated Metaschema binding classes for module(s): Metaschema Binding Configuration.
dev.metaschema.databind.model	Provides an overlay of the Metaschema module model (dev.metaschema.core.model) using bound Java class annotations (dev.metaschema.databind.model.annotations) to represent module constructs annotated on Java classes.
dev.metaschema.databind.model.annotations	Provides a set of annotations for associating Module information with a Java class.
dev.metaschema.databind.model.metaschema	Provides an implementation of the Module model (dev.metaschema.core.model) represented by a module-specific set of bound Java classes (dev.metaschema.databind.model.metaschema.binding).
dev.metaschema.databind.model.metaschema.binding	Provides generated Metaschema binding classes for module(s): Metaschema Model.
dev.metaschema.model.testing	Provides testing utilities for Metaschema modules and constraints.
dev.metaschema.model.testing.testsuite	Provides generated Metaschema binding classes for module(s): Metaschema Test Suite.
dev.metaschema.schemagen	Provides schema generation capabilities for Metaschema modules.
dev.metaschema.schemagen.json	Provides JSON Schema generation from Metaschema modules.
dev.metaschema.schemagen.xml	Provides XML Schema (XSD) generation from Metaschema modules.

Uses of IModule in dev.metaschema.cli.commands

Methods in dev.metaschema.cli.commands that return IModule

Modifier and Type	Method	Description
protected abstract IModule	AbstractValidateContentCommand.AbstractValidationCommandExecutor.getModule(org.apache.commons.cli.CommandLine commandLine, IBindingContext bindingContext)	Get the module to use for validation.
static IModule	MetaschemaCommands.loadModule(String moduleResource, URI currentWorkingDirectory, IBindingContext bindingContext)	Load a Metaschema module from the provided relative resource path.
static IModule	MetaschemaCommands.loadModule(URI moduleResource, IBindingContext bindingContext)	Load a Metaschema module from the provided resource path.
static IModule	MetaschemaCommands.loadModule(org.apache.commons.cli.CommandLine commandLine, org.apache.commons.cli.Option option, URI currentWorkingDirectory, IBindingContext bindingContext)	Load a Metaschema module based on the provided command line option.

Methods in dev.metaschema.cli.commands with parameters of type IModule

Modifier and Type	Method	Description
protected abstract IBindingContext.ISchemaValidationProvider	AbstractValidateContentCommand.AbstractValidationCommandExecutor.getSchemaValidationProvider(IModule module, org.apache.commons.cli.CommandLine commandLine, IBindingContext bindingContext)	Get the schema validation implementation requested based on the provided command line arguments.

Uses of IModule in dev.metaschema.core.metapath.item.node

Methods in dev.metaschema.core.metapath.item.node that return IModule

Modifier and Type	Method	Description
IModule	IModuleNodeItem.getModule()	The Metaschema module this item is based on.

Methods in dev.metaschema.core.metapath.item.node with parameters of type IModule

Modifier and Type	Method	Description
IModuleNodeItem	AbstractNodeItemFactory.newModuleNodeItem(IModule module)
IModuleNodeItem	INodeItemFactory.newModuleNodeItem(IModule module)	Create a new Metaschema node item for the provided metaschema.
void	RecursionCollectingNodeItemVisitor.visit(IModule module)	Visit the provided module.

Uses of IModule in dev.metaschema.core.model

Classes in dev.metaschema.core.model with type parameters of type IModule

Modifier and Type	Class	Description
class	AbstractGlobalAssemblyDefinition<MODULE extends IModule,INSTANCE extends IAssemblyInstance,FLAG extends IFlagInstance,MODEL extends IModelInstanceAbsolute,NAMED_MODEL extends INamedModelInstanceAbsolute,FIELD extends IFieldInstanceAbsolute,ASSEMBLY extends IAssemblyInstanceAbsolute,CHOICE extends IChoiceInstance,CHOICE_GROUP extends IChoiceGroupInstance>	A base class for an assembly definition defined globally within a Metaschema module.
class	AbstractGlobalDefinition<MODULE extends IModule,INSTANCE extends INamedInstance>	A base class for definitions defined globally within a Metaschema module.
class	AbstractGlobalFieldDefinition<MODULE extends IModule,INSTANCE extends IFieldInstance,FLAG extends IFlagInstance>	A base class for a field definition defined globally within a Metaschema module.
class	AbstractGlobalFlagDefinition<MODULE extends IModule,INSTANCE extends IFlagInstance>	A base class for a flag definition defined globally within a Metaschema module.

Subinterfaces of IModule in dev.metaschema.core.model

Modifier and Type	Interface	Description
interface	IMetaschemaModule<SELF extends IMetaschemaModule<SELF>>	Represents a loaded Metaschema module.
interface	IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>	The API for accessing information about a given Metaschema module.

Classes in dev.metaschema.core.model that implement IModule

Modifier and Type	Class	Description
class	AbstractModule<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>	Provides a common, abstract implementation of a IModule.

Methods in dev.metaschema.core.model that return IModule

Modifier and Type	Method	Description
IModule	AbstractChoiceGroupInstance.getContainingModule()
IModule	AbstractChoiceInstance.getContainingModule()
IModule	AbstractFlagInstance.getContainingModule()
IModule	AbstractNamedModelInstance.getContainingModule()
IModule	IModelElement.getContainingModule()	Retrieves the Metaschema module that contains the information element's declaration.
IModule	IModule.getImportedModuleByShortName(String name)	Retrieve the imported Metaschema module with the specified name, if it exists.

Methods in dev.metaschema.core.model that return types with arguments of type IModule

Modifier and Type	Method	Description
List<? extends IModule>	IModule.getImportedModules()	Retrieves all Metaschema modules imported by this Metaschema module.

Methods in dev.metaschema.core.model with parameters of type IModule

Modifier and Type	Method	Description
static Collection<? extends IDefinition>	UsedDefinitionModelWalker.collectUsedDefinitionsFromModule(IModule module)	Collect the globally defined Metaschema definitions from the provided Metaschema module, and any Metaschema modules imported directly or indirectly by this module.
static ISource	ISource.moduleSource(IModule module)	Get the descriptor for a ISource.SourceLocation.MODEL source with as associated resource.
void	IModuleLoader.IModulePostProcessor.processModule(IModule module)	Perform a post-processing operation on the provided module.

Method parameters in dev.metaschema.core.model with type arguments of type IModule

Modifier and Type	Method	Description
static Collection<? extends IDefinition>	UsedDefinitionModelWalker.collectUsedDefinitionsFromModule(Collection<? extends IModule> modules)	Collect the globally defined Metaschema definitions from the provided Metaschema modules, and any Metaschema modules imported directly or indirectly by these modules.

Uses of IModule in dev.metaschema.core.model.constraint

Methods in dev.metaschema.core.model.constraint with parameters of type IModule

Modifier and Type	Method	Description
void	ExternalConstraintsModulePostProcessor.processModule(IModule module)

Uses of IModule in dev.metaschema.core.model.util

Methods in dev.metaschema.core.model.util with parameters of type IModule

Modifier and Type	Method	Description
static void	MermaidErDiagramGenerator.generate(IModule module, PrintWriter writer)	Generate a Mermaid diagram for the provided module, using the provided writer.
static IEnhancedQName	ModuleUtils.parseFlagName(IModule module, String name)	Parse a flag name.
static IEnhancedQName	ModuleUtils.parseModelName(IModule module, String name)	Parse the name of a field or assembly.

Uses of IModule in dev.metaschema.databind

Methods in dev.metaschema.databind with parameters of type IModule

Modifier and Type	Method	Description
protected abstract Class<? extends IBoundModule>	AbstractModuleLoaderStrategy.handleUnboundModule(IModule key)	Handle a module that is not already bound to a Java class.
protected Class<? extends IBoundModule>	SimpleModuleLoaderStrategy.handleUnboundModule(IModule module)
default void	IBindingContext.IModuleLoaderStrategy.postProcessModule(IModule module, IBindingContext bindingContext)	Perform post-processing on the module.
void	PostProcessingModuleLoaderStrategy.postProcessModule(IModule module, IBindingContext bindingContext)
protected void	PostProcessingModuleLoaderStrategy.processModule(IModule module)	Perform post-processing on the provided module.
IBoundModule	AbstractModuleLoaderStrategy.registerModule(IModule module, IBindingContext bindingContext)
IBoundModule	IBindingContext.IModuleLoaderStrategy.registerModule(IModule module, IBindingContext bindingContext)	Registers the provided Metaschema module.
default IBoundModule	IBindingContext.registerModule(IModule module)	Registers the provided Metaschema module with this binding context.
IBoundModule	PostProcessingModuleLoaderStrategy.registerModule(IModule module, IBindingContext bindingContext)

Uses of IModule in dev.metaschema.databind.codegen

Methods in dev.metaschema.databind.codegen that return IModule

Modifier and Type	Method	Description
IModule	IGeneratedModuleClass.getModule()	Get the associated Module module data.

Methods in dev.metaschema.databind.codegen with parameters of type IModule

Modifier and Type	Method	Description
static IProduction	ModuleCompilerHelper.compileMetaschema(IModule module, Path classDir)	Generate and compile Java class, representing the provided Module module and its related definitions, using the default binding configuration.
static IProduction	ModuleCompilerHelper.compileModule(IModule module, Path classDir, IBindingConfiguration bindingConfiguration)	Generate and compile Java class, representing the provided Module module and its related definitions, using the provided custom bindingConfiguration.
Class<? extends IBoundModule>	DefaultModuleBindingGenerator.generate(IModule module)
Class<? extends IBoundModule>	IModuleBindingGenerator.generate(IModule module)	Generate bound Java classes for the provided Metaschema module.
static IProduction	JavaGenerator.generate(IModule module, Path targetDir, IBindingConfiguration bindingConfiguration)	Generate Java sources for the provided Metaschema module.
IGeneratedModuleClass	IProduction.getModuleProduction(IModule module)	Get information about the Java classes generated for the provided Module module.

Method parameters in dev.metaschema.databind.codegen with type arguments of type IModule

Modifier and Type	Method	Description
static IProduction	JavaGenerator.generate(Collection<? extends IModule> modules, Path targetDirectory, IBindingConfiguration bindingConfiguration)	Generates Java classes for Module fields and flags.
static IProduction	IProduction.of(Collection<? extends IModule> modules, IBindingConfiguration bindingConfiguration, Path classDir)	Create a new production for the provided set of Module modules.

Uses of IModule in dev.metaschema.databind.codegen.config

Methods in dev.metaschema.databind.codegen.config with parameters of type IModule

Modifier and Type	Method	Description
String	DefaultBindingConfiguration.getClassName(IModule module)
String	IBindingConfiguration.getClassName(IModule module)	Get the Java class name for the provided Module module.
protected DefaultBindingConfiguration.MetaschemaBindingConfiguration	DefaultBindingConfiguration.getMetaschemaBindingConfiguration(IModule module)	Get the binding configuration for the provided Module.
String	DefaultBindingConfiguration.getPackageNameForModule(IModule module)
String	IBindingConfiguration.getPackageNameForModule(IModule module)	Generates a Java package name for the provided Module module.

Uses of IModule in dev.metaschema.databind.config.binding

Classes in dev.metaschema.databind.config.binding that implement IModule

Modifier and Type	Class	Description
final class	MetaschemaBindingsModule	Metaschema Binding Configuration

Uses of IModule in dev.metaschema.databind.model

Subinterfaces of IModule in dev.metaschema.databind.model

Modifier and Type	Interface	Description
interface	IBoundModule	Represents a bound Metaschema module that provides access to its field and assembly definitions through Java class bindings.

Classes in dev.metaschema.databind.model that implement IModule

Modifier and Type	Class	Description
class	AbstractBoundModule	An abstract base class for Metaschema modules bound to Java classes.

Uses of IModule in dev.metaschema.databind.model.annotations

Methods in dev.metaschema.databind.model.annotations with parameters of type IModule

Modifier and Type	Method	Description
static IGroupAs	ModelUtil.resolveDefaultGroupAs(GroupAs groupAs, IModule module)	Resolves a GroupAs annotation determining if an actual value is provided or if the value is the default, which indicates that no actual GroupAs was provided.

Uses of IModule in dev.metaschema.databind.model.metaschema

Subinterfaces of IModule in dev.metaschema.databind.model.metaschema

Modifier and Type	Interface	Description
interface	IBindingMetaschemaModule	Represents a Metaschema module loaded via data binding.

Methods in dev.metaschema.databind.model.metaschema with parameters of type IModule

Modifier and Type	Method	Description
void	ModuleLoadingPostProcessor.postProcessModule(IModule module, IBindingContext bindingContext)	Post-processes the provided Metaschema module.

Uses of IModule in dev.metaschema.databind.model.metaschema.binding

Classes in dev.metaschema.databind.model.metaschema.binding that implement IModule

Modifier and Type	Class	Description
final class	MetaschemaModelModule	Metaschema Model

Uses of IModule in dev.metaschema.model.testing

Methods in dev.metaschema.model.testing that return types with arguments of type IModule

Modifier and Type	Method	Description
protected abstract BiFunction<IModule,Writer,Void>	AbstractTestSuite.getSchemaGeneratorSupplier()	Get the method used to generate a schema using a given Metaschema module and writer.

Methods in dev.metaschema.model.testing with parameters of type IModule

Modifier and Type	Method	Description
protected void	AbstractTestSuite.generateSchema(IModule module, Path schemaPath, BiFunction<IModule,Writer,Void> schemaProducer)	Generate a schema for the provided module using the provided schema generator.

Method parameters in dev.metaschema.model.testing with type arguments of type IModule

Modifier and Type	Method	Description
protected void	AbstractTestSuite.generateSchema(IModule module, Path schemaPath, BiFunction<IModule,Writer,Void> schemaProducer)	Generate a schema for the provided module using the provided schema generator.

Uses of IModule in dev.metaschema.model.testing.testsuite

Classes in dev.metaschema.model.testing.testsuite that implement IModule

Modifier and Type	Class	Description
final class	MetaschemaTestSuiteModule	Metaschema Test Suite

Uses of IModule in dev.metaschema.schemagen

Methods in dev.metaschema.schemagen that return IModule

Modifier and Type	Method	Description
IModule	AbstractGenerationState.getModule()
IModule	IGenerationState.getModule()	Get the Metaschema module being processed for schema generation.

Methods in dev.metaschema.schemagen with parameters of type IModule

Modifier and Type	Method	Description
void	AbstractSchemaGenerator.generateFromModule(IModule metaschema, Writer out, IConfiguration<SchemaGenerationFeature<?>> configuration)
void	ISchemaGenerator.generateFromModule(IModule metaschema, Writer writer, IConfiguration<SchemaGenerationFeature<?>> configuration)	Generate and write a schema for the provided metaschema to the Writer provided by writer using the provided configuration.
static void	ISchemaGenerator.generateSchema(IModule module, Writer writer, ISchemaGenerator.SchemaFormat asFormat, IConfiguration<SchemaGenerationFeature<?>> configuration)	Generate a schema for the provided module and write it to the specified writer.
static void	ISchemaGenerator.generateSchema(IModule module, Path destination, ISchemaGenerator.SchemaFormat asFormat, IConfiguration<SchemaGenerationFeature<?>> configuration)	Generate a schema for the provided module and write it to the specified file path.
static ModuleIndex	ModuleIndex.indexDefinitions(IModule module, IInlineStrategy inlineStrategy)	Creates an index of all definitions reachable from the module's root assembly definitions.
protected abstract S	AbstractSchemaGenerator.newGenerationState(IModule module, T schemaWriter, IConfiguration<SchemaGenerationFeature<?>> configuration)	Create a new schema generation state object.

Constructors in dev.metaschema.schemagen with parameters of type IModule

Modifier	Constructor	Description
	AbstractGenerationState(IModule module, WRITER writer, IConfiguration<SchemaGenerationFeature<?>> configuration, DATATYPE_MANAGER datatypeManager)	Construct a new generation state instance.

Uses of IModule in dev.metaschema.schemagen.json

Methods in dev.metaschema.schemagen.json with parameters of type IModule

Modifier and Type	Method	Description
protected dev.metaschema.schemagen.json.impl.JsonGenerationState	JsonSchemaGenerator.newGenerationState(IModule module, com.fasterxml.jackson.core.JsonGenerator schemaWriter, IConfiguration<SchemaGenerationFeature<?>> configuration)

Uses of IModule in dev.metaschema.schemagen.xml

Methods in dev.metaschema.schemagen.xml with parameters of type IModule

Modifier and Type	Method	Description
protected static void	XmlSchemaGenerator.generateSchemaMetadata(IModule module, dev.metaschema.schemagen.xml.impl.XmlGenerationState state)	Generates the schema metadata annotation containing module information.
protected dev.metaschema.schemagen.xml.impl.XmlGenerationState	XmlSchemaGenerator.newGenerationState(IModule module, AutoCloser<org.codehaus.stax2.XMLStreamWriter2,SchemaGenerationException> schemaWriter, IConfiguration<SchemaGenerationFeature<?>> configuration)