Module dev.metaschema.databind

Package dev.metaschema.databind.model

Class AbstractBoundModule

java.lang.Object

dev.metaschema.core.model.AbstractModule<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

dev.metaschema.databind.model.AbstractBoundModule

All Implemented Interfaces:

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

Direct Known Subclasses:

MetaschemaBindingsModule, MetaschemaModelModule, MetaschemaTestSuiteModule

public abstract class AbstractBoundModule
extends AbstractModule<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>
implements IBoundModule

An abstract base class for Metaschema modules bound to Java classes.

This class provides the common implementation for modules that are defined through Java annotations on classes, enabling data binding between Metaschema module definitions and Java objects.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBoundModule(List<? extends IBoundModule> importedModules, IBindingContext bindingContext)	Construct a new Module instance.

Method Summary

Modifier and Type	Method	Description
protected Class<? extends IBoundObject>[]	getAssemblyClasses()	Get the assembly instance annotations associated with this bound choice group.
IBoundDefinitionModelAssembly	getAssemblyDefinitionByName(Integer name)	Retrieves the top-level assembly definition in this Metaschema module with the matching name, if it exists.
protected Map<Integer,IBoundDefinitionModelAssembly>	getAssemblyDefinitionMap()	Get the mapping of assembly definition effective name to definition.
Collection<IBoundDefinitionModelAssembly>	getAssemblyDefinitions()	Retrieves the top-level assembly definitions in this Metaschema module.
IBindingContext	getBindingContext()	Get the Module binding context.
protected Class<? extends IBoundObject>[]	getFieldClasses()	Get the field instance annotations associated with this bound choice group.
IBoundDefinitionModelField<?>	getFieldDefinitionByName(Integer name)	Retrieves the top-level field definition in this Metaschema module with the matching name, if it exists.
protected Map<Integer,IBoundDefinitionModelField<?>>	getFieldDefinitionMap()	Get the mapping of field definition effective name to definition.
Collection<IBoundDefinitionModelField<?>>	getFieldDefinitions()	Retrieves the top-level field definitions in this Metaschema module.
IBoundDefinitionFlag	getFlagDefinitionByName(IEnhancedQName name)	Retrieves the top-level flag definition in this Metaschema module with the matching name, if it exists.
Collection<IBoundDefinitionFlag>	getFlagDefinitions()	Retrieves the top-level flag definitions in this Metaschema module.
String	getLocationHint()	Get a hint about where the source is location.
StaticContext	getModuleStaticContext()	Get the Metapath static context for compiling Metapath expressions that query instances of this model.
Map<String,String>	getNamespaceBindings()	Get the mapping of prefix to namespace URI for use in resolving the namespace of lexical qualified named in Metapath.
protected NsBinding[]	getNsBindings()	Get the namespace binding annotations associated with this module.
ISource	getSource()	Get the source information for the module.

Methods inherited from class dev.metaschema.core.model.AbstractModule

getExportedAssemblyDefinitionByName, getExportedAssemblyDefinitions, getExportedFieldDefinitionByName, getExportedFieldDefinitions, getExportedFlagDefinitionByName, getExportedFlagDefinitions, getExportedRootAssemblyDefinitionByName, getImportedModuleByShortName, getImportedModules, getQName

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.metaschema.databind.model.IBoundModule

getLocation

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

getExportedRootAssemblyDefinitionByName, getJsonBaseUri, getName, getQName, getRemarks, getShortName, getVersion, getXmlNamespace

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

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

Constructor Details

AbstractBoundModule

protected AbstractBoundModule(@NonNull
 List<? extends IBoundModule> importedModules,
 @NonNull
 IBindingContext bindingContext)

Construct a new Module instance.

Parameters:

importedModules - Module imports associated with the Metaschema module

bindingContext - the Module binding context

Method Details

getSource

public ISource getSource()

Description copied from interface: IModule

Get the source information for the module.

Specified by:

getSource in interface IModule

Returns:

the source information

getLocationHint

public String getLocationHint()

Description copied from interface: IModule

Get a hint about where the source is location.

This value will typically be a URI or class name.

Specified by:

getLocationHint in interface IModule

Returns:

the hint

getModuleStaticContext

public StaticContext getModuleStaticContext()

Description copied from interface: IModule

Get the Metapath static context for compiling Metapath expressions that query instances of this model.

Specified by:

getModuleStaticContext in interface IModule

Returns:

the static context

getBindingContext

@NonNull
public IBindingContext getBindingContext()

Description copied from interface: IBoundModule

Get the Module binding context.

Specified by:

getBindingContext in interface IBoundModule

Returns:

the context

getNamespaceBindings

public Map<String,String> getNamespaceBindings()

Description copied from interface: IModule

Get the mapping of prefix to namespace URI for use in resolving the namespace of lexical qualified named in Metapath.

Specified by:

getNamespaceBindings in interface IModule

Returns:

the mapping

getNsBindings

@NonNull
protected NsBinding[] getNsBindings()

Get the namespace binding annotations associated with this module.

Returns:

the namespace bindings array, or an empty array if none are defined

getAssemblyClasses

@NonNull
protected Class<? extends IBoundObject>[] getAssemblyClasses()

Get the assembly instance annotations associated with this bound choice group.

Returns:

the annotations

getFieldClasses

@NonNull
protected Class<? extends IBoundObject>[] getFieldClasses()

Get the field instance annotations associated with this bound choice group.

Returns:

the annotations

getAssemblyDefinitionMap

protected Map<Integer,IBoundDefinitionModelAssembly> getAssemblyDefinitionMap()

Get the mapping of assembly definition effective name to definition.

Returns:

the mapping

getAssemblyDefinitions

public Collection<IBoundDefinitionModelAssembly> getAssemblyDefinitions()

Description copied from interface: IModule

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

Specified by:

getAssemblyDefinitions in interface IBoundModule

Specified by:

getAssemblyDefinitions in interface IModule

Specified by:

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

Returns:

the collection of assembly definitions

getAssemblyDefinitionByName

public 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 IBoundModule

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

getFieldDefinitionMap

protected Map<Integer,IBoundDefinitionModelField<?>> getFieldDefinitionMap()

Get the mapping of field definition effective name to definition.

Returns:

the mapping

getFieldDefinitions

public Collection<IBoundDefinitionModelField<?>> getFieldDefinitions()

Description copied from interface: IModule

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

Specified by:

getFieldDefinitions in interface IBoundModule

Specified by:

getFieldDefinitions in interface IModule

Specified by:

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

Returns:

the collection of field definitions

getFieldDefinitionByName

public 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 IBoundModule

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

getFlagDefinitions

public Collection<IBoundDefinitionFlag> getFlagDefinitions()

Description copied from interface: IModule

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

Specified by:

getFlagDefinitions in interface IModule

Specified by:

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

Returns:

the collection of flag definitions

getFlagDefinitionByName

public IBoundDefinitionFlag getFlagDefinitionByName(@NonNull
 IEnhancedQName name)

Description copied from interface: IModule

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

Specified by:

getFlagDefinitionByName in interface IModule

Specified by:

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

Parameters:

name - the definition name

Returns:

the matching flag definition, or null if none match