Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundModule

All Superinterfaces:

IModule, IModuleExtended<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

All Known Implementing Classes:

AbstractBoundModule, MetaschemaBindingsModule, MetaschemaModelModule, MetaschemaTestSuiteModule

public interface IBoundModule
extends IModuleExtended<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

Represents a bound Metaschema module that provides access to its field and assembly definitions through Java class bindings.

Method Summary

Modifier and Type	Method	Description
IBoundDefinitionModelAssembly	getAssemblyDefinitionByName(Integer name)	Retrieves the top-level assembly definition in this Metaschema module with the matching name, if it exists.
Collection<IBoundDefinitionModelAssembly>	getAssemblyDefinitions()	Retrieves the top-level assembly definitions in this Metaschema module.
IBindingContext	getBindingContext()	Get the Module binding context.
IBoundDefinitionModelField<?>	getFieldDefinitionByName(Integer name)	Retrieves the top-level field definition in this Metaschema module with the matching name, if it exists.
Collection<IBoundDefinitionModelField<?>>	getFieldDefinitions()	Retrieves the top-level field definitions in this Metaschema module.
default URI	getLocation()	Retrieves the location where the Metaschema module was loaded from.
static IBoundModule	newInstance(Class<? extends IBoundModule> clazz, IBindingContext bindingContext, List<? extends IBoundModule> importedModules)	Create a new instance of a bound module using reflection.

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

getExportedRootAssemblyDefinitionByName, getJsonBaseUri, getLocationHint, getModuleStaticContext, getName, getNamespaceBindings, getQName, getRemarks, getShortName, getSource, getVersion, getXmlNamespace

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

getAssemblyAndFieldDefinitions, getExportedAssemblyDefinitionByName, getExportedAssemblyDefinitions, getExportedFieldDefinitionByName, getExportedFieldDefinitions, getExportedFlagDefinitionByName, getExportedFlagDefinitions, getExportedRootAssemblyDefinitions, getFlagDefinitionByName, getFlagDefinitions, getImportedModuleByShortName, getImportedModules, getRootAssemblyDefinitions, getScopedAssemblyDefinitionByName, getScopedFieldDefinitionByName, getScopedFlagDefinitionByName

Method Details

newInstance

@NonNull
static IBoundModule newInstance(@NonNull
 Class<? extends IBoundModule> clazz,
 @NonNull
 IBindingContext bindingContext,
 @NonNull
 List<? extends IBoundModule> importedModules)

Create a new instance of a bound module using reflection.

Parameters:

clazz - the bound module class to instantiate

bindingContext - the binding context for the module

importedModules - the list of modules imported by this module

Returns:

the new module instance

Throws:

IllegalArgumentException - if the module cannot be instantiated

getBindingContext

@NonNull
IBindingContext getBindingContext()

Get the Module binding context.

Returns:

the context

getLocation

default URI getLocation()

Description copied from interface: IModule

Retrieves the location where the Metaschema module was loaded from.

Specified by:

getLocation in interface IModule

Returns:

the location, or null if this information is not available

getAssemblyDefinitions

Collection<IBoundDefinitionModelAssembly> getAssemblyDefinitions()

Description copied from interface: IModule

Retrieves the top-level assembly definitions in this Metaschema module.

Specified by:

getAssemblyDefinitions in interface IModule

Specified by:

getAssemblyDefinitions in interface IModuleExtended<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

Returns:

the collection of assembly definitions

getAssemblyDefinitionByName

IBoundDefinitionModelAssembly getAssemblyDefinitionByName(@NonNull
 Integer name)

Description copied from interface: IModule

Retrieves the top-level assembly definition in this Metaschema module with the matching name, if it exists.

Specified by:

getAssemblyDefinitionByName in interface IModule

Specified by:

getAssemblyDefinitionByName in interface IModuleExtended<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

Parameters:

name - the definition name

Returns:

the matching assembly definition, or null if none match

getFieldDefinitions

Collection<IBoundDefinitionModelField<?>> getFieldDefinitions()

Description copied from interface: IModule

Retrieves the top-level field definitions in this Metaschema module.

Specified by:

getFieldDefinitions in interface IModule

Specified by:

getFieldDefinitions in interface IModuleExtended<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

Returns:

the collection of field definitions

getFieldDefinitionByName

IBoundDefinitionModelField<?> getFieldDefinitionByName(@NonNull
 Integer name)

Description copied from interface: IModule

Retrieves the top-level field definition in this Metaschema module with the matching name, if it exists.

Specified by:

getFieldDefinitionByName in interface IModule

Specified by:

getFieldDefinitionByName in interface IModuleExtended<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

Parameters:

name - the definition name

Returns:

the matching field definition, or null if none match