Module dev.metaschema.core

Package dev.metaschema.core.model

Class AbstractModule<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

java.lang.Object

dev.metaschema.core.model.AbstractModule<M,D,FL,FI,A>

Type Parameters:

M - the imported module Java type

D - the definition Java type

FL - the flag definition Java type

FI - the field definition Java type

A - the assembly definition Java type

All Implemented Interfaces:

IModule, IModuleExtended<M,D,FL,FI,A>

Direct Known Subclasses:

AbstractBoundModule

public abstract class AbstractModule<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>
extends Object
implements IModuleExtended<M,D,FL,FI,A>

Provides a common, abstract implementation of a IModule.

Constructor Summary

Constructors

Constructor	Description
AbstractModule(List<? extends M> importedModules)	Construct a new Metaschema module object.

Method Summary

Modifier and Type	Method	Description
A	getExportedAssemblyDefinitionByName(Integer name)	Retrieves the exported named assembly definition, if it exists.
Collection<A>	getExportedAssemblyDefinitions()	Retrieve the top-level assembly definitions that are marked global in this Metaschema module or in any imported Metaschema module.
FI	getExportedFieldDefinitionByName(Integer name)	Retrieves the exported named field definition, if it exists.
Collection<FI>	getExportedFieldDefinitions()	Retrieve the top-level field definitions that are marked global in this Metaschema module or in any imported Metaschema module.
FL	getExportedFlagDefinitionByName(IEnhancedQName name)	Retrieves the exported named flag definition, if it exists.
Collection<FL>	getExportedFlagDefinitions()	Retrieve the top-level flag definitions that are marked global in this Metaschema module or in any imported Metaschema modules.
A	getExportedRootAssemblyDefinitionByName(Integer name)	Retrieves the exported named root assembly definition, if it exists.
M	getImportedModuleByShortName(String name)	Retrieve the imported Metaschema module with the specified name, if it exists.
List<? extends M>	getImportedModules()	Retrieves all Metaschema modules imported by this Metaschema module.
IEnhancedQName	getQName()	Get the qualified name associated with the Metaschema module.

Methods inherited from class java.lang.Object

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

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

getJsonBaseUri, getLocation, getLocationHint, getModuleStaticContext, getName, getNamespaceBindings, getRemarks, getShortName, getSource, getVersion, getXmlNamespace

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

getAssemblyAndFieldDefinitions, getAssemblyDefinitionByName, getAssemblyDefinitions, getExportedRootAssemblyDefinitions, getFieldDefinitionByName, getFieldDefinitions, getFlagDefinitionByName, getFlagDefinitions, getRootAssemblyDefinitions, getScopedAssemblyDefinitionByName, getScopedFieldDefinitionByName, getScopedFlagDefinitionByName

Constructor Details

AbstractModule

public AbstractModule(@NonNull
 List<? extends M> importedModules)

Construct a new Metaschema module object.

Parameters:

importedModules - the collection of Metaschema module objects this Metaschema module imports

Method Details

getQName

public IEnhancedQName getQName()

Description copied from interface: IModule

Get the qualified name associated with the Metaschema module.

Specified by:

getQName in interface IModule

Returns:

the qualified name

getImportedModules

public List<? extends M> getImportedModules()

Description copied from interface: IModule

Retrieves all Metaschema modules imported by this Metaschema module.

Specified by:

getImportedModules in interface IModule

Specified by:

getImportedModules in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Returns:

a list of imported Metaschema modules

getImportedModuleByShortName

public M getImportedModuleByShortName(String name)

Description copied from interface: IModule

Retrieve the imported Metaschema module with the specified name, if it exists.

Specified by:

getImportedModuleByShortName in interface IModule

Specified by:

getImportedModuleByShortName in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Parameters:

name - the short name of the Metschema module to retrieve

Returns:

the imported Metaschema module or null if it doesn't exist

getExportedFlagDefinitions

public Collection<FL> getExportedFlagDefinitions()

Description copied from interface: IModule

Retrieve the top-level flag definitions that are marked global in this Metaschema module or in any imported Metaschema modules. The resulting collection is built by adding global definitions from each imported Metaschema module in order of import, then adding global definitions from the current Metaschema module. Such a map is built in this way for each imported Metaschema module in the chain. Values for clashing keys will be replaced in this order, giving preference to the "closest" definition.

Specified by:

getExportedFlagDefinitions in interface IModule

Specified by:

getExportedFlagDefinitions in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Returns:

the collection of exported flag definitions

getExportedFlagDefinitionByName

public FL getExportedFlagDefinitionByName(IEnhancedQName name)

Description copied from interface: IModule

Retrieves the exported named flag definition, if it exists.

For information about how flag definitions are exported see IModule.getExportedFlagDefinitions().

Specified by:

getExportedFlagDefinitionByName in interface IModule

Specified by:

getExportedFlagDefinitionByName in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Parameters:

name - the definition name

Returns:

the flag definition, or null if it doesn't exist.

getExportedFieldDefinitions

public Collection<FI> getExportedFieldDefinitions()

Description copied from interface: IModule

Retrieve the top-level field definitions that are marked global in this Metaschema module or in any imported Metaschema module. The resulting collection is built by adding global definitions from each imported Metaschema module in order of import, then adding global definitions from the current Metaschema module. Such a map is built in this way for each imported Metaschema module in the chain. Values for clashing keys will be replaced in this order, giving preference to the "closest" definition

Specified by:

getExportedFieldDefinitions in interface IModule

Specified by:

getExportedFieldDefinitions in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Returns:

the collection of exported field definitions

getExportedFieldDefinitionByName

public FI getExportedFieldDefinitionByName(Integer name)

Description copied from interface: IModule

Retrieves the exported named field definition, if it exists.

For information about how field definitions are exported see IModule.getExportedFieldDefinitions().

Specified by:

getExportedFieldDefinitionByName in interface IModule

Specified by:

getExportedFieldDefinitionByName in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Parameters:

name - the definition name

Returns:

the field definition, or null if it doesn't exist.

getExportedAssemblyDefinitions

public Collection<A> getExportedAssemblyDefinitions()

Description copied from interface: IModule

Retrieve the top-level assembly definitions that are marked global in this Metaschema module or in any imported Metaschema module. The resulting collection is built by adding global definitions from each imported Metaschema module in order of import, then adding global definitions from the current Metaschema module. This collection is built in this way for each imported Metaschema module in the chain. Items with duplicate names will be replaced in this order, giving preference to the "closest" definition

Specified by:

getExportedAssemblyDefinitions in interface IModule

Specified by:

getExportedAssemblyDefinitions in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Returns:

the collection of exported assembly definitions

getExportedAssemblyDefinitionByName

public A getExportedAssemblyDefinitionByName(Integer name)

Description copied from interface: IModule

Retrieves the exported named assembly definition, if it exists.

For information about how assembly definitions are exported see IModule.getExportedAssemblyDefinitions().

Specified by:

getExportedAssemblyDefinitionByName in interface IModule

Specified by:

getExportedAssemblyDefinitionByName in interface IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>

Parameters:

name - the definition name

Returns:

the assembly definition, or null if it doesn't exist.

getExportedRootAssemblyDefinitionByName

public A getExportedRootAssemblyDefinitionByName(Integer name)

Description copied from interface: IModule

Retrieves the exported named root assembly definition, if it exists.

For information about how assembly definitions are exported see IModule.getExportedAssemblyDefinitions().

Specified by:

getExportedRootAssemblyDefinitionByName in interface IModule

Parameters:

name - the root name

Returns:

the assembly definition, or null if it doesn't exist.