Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind.model

Class AbstractBoundModule

java.lang.Object

gov.nist.secauto.metaschema.core.model.AbstractModule<IBoundModule,IBoundDefinitionModelComplex,IBoundDefinitionFlag,IBoundDefinitionModelField<?>,IBoundDefinitionModelAssembly>

gov.nist.secauto.metaschema.databind.model.AbstractBoundModule

All Implemented Interfaces:

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

Direct Known Subclasses:

MetaschemaModelModule

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

Field Summary

Fields inherited from interface gov.nist.secauto.metaschema.core.model.IModule

XML_NAMESPACE

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
static IBoundModule	createInstance(Class<? extends IBoundModule> clazz, IBindingContext bindingContext)	Create a new Module instance for a given class annotated by the MetaschemaModule annotation.
protected Class<? extends IBoundObject>[]	getAssemblyClasses()	Get the assembly instance annotations associated with this bound choice group.
IBoundDefinitionModelAssembly	getAssemblyDefinitionByName(QName name)
protected Map<QName,IBoundDefinitionModelAssembly>	getAssemblyDefinitionMap()	Get the mapping of assembly definition effective name to definition.
Collection<IBoundDefinitionModelAssembly>	getAssemblyDefinitions()
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(QName name)
protected Map<QName,IBoundDefinitionModelField<?>>	getFieldDefinitionMap()	Get the mapping of field definition effective name to definition.
Collection<IBoundDefinitionModelField<?>>	getFieldDefinitions()
IBoundDefinitionFlag	getFlagDefinitionByName(QName name)
Collection<IBoundDefinitionFlag>	getFlagDefinitions()
StaticContext	getModuleStaticContext()
Map<String,String>	getNamespaceBindings()
protected NsBinding[]	getNsBindings()

Methods inherited from class gov.nist.secauto.metaschema.core.model.AbstractModule

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundModule

getLocation

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModule

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

Methods inherited from interface gov.nist.secauto.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

createInstance

@NonNull
public static IBoundModule createInstance(@NonNull
 Class<? extends IBoundModule> clazz,
 @NonNull
 IBindingContext bindingContext)

Create a new Module instance for a given class annotated by the MetaschemaModule annotation.

Will also load any imported Metaschemas.

Parameters:

clazz - the Module class

bindingContext - the Module binding context

Returns:

the new Module instance

getModuleStaticContext

public StaticContext getModuleStaticContext()

Specified by:

getModuleStaticContext in interface IModule

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()

Specified by:

getNamespaceBindings in interface IModule

getNsBindings

@NonNull
protected NsBinding[] getNsBindings()

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<QName,IBoundDefinitionModelAssembly> getAssemblyDefinitionMap()

Get the mapping of assembly definition effective name to definition.

Returns:

the mapping

getAssemblyDefinitions

public Collection<IBoundDefinitionModelAssembly> getAssemblyDefinitions()

Specified by:

getAssemblyDefinitions in interface IBoundModule

Specified by:

getAssemblyDefinitions in interface IModule

Specified by:

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

getAssemblyDefinitionByName

public IBoundDefinitionModelAssembly getAssemblyDefinitionByName(@NonNull
 QName name)

Specified by:

getAssemblyDefinitionByName in interface IBoundModule

Specified by:

getAssemblyDefinitionByName in interface IModule

Specified by:

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

getFieldDefinitionMap

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

Get the mapping of field definition effective name to definition.

Returns:

the mapping

getFieldDefinitions

public Collection<IBoundDefinitionModelField<?>> getFieldDefinitions()

Specified by:

getFieldDefinitions in interface IBoundModule

Specified by:

getFieldDefinitions in interface IModule

Specified by:

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

getFieldDefinitionByName

public IBoundDefinitionModelField<?> getFieldDefinitionByName(@NonNull
 QName name)

Specified by:

getFieldDefinitionByName in interface IBoundModule

Specified by:

getFieldDefinitionByName in interface IModule

Specified by:

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

getFlagDefinitions

public Collection<IBoundDefinitionFlag> getFlagDefinitions()

Specified by:

getFlagDefinitions in interface IModule

Specified by:

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

getFlagDefinitionByName

public IBoundDefinitionFlag getFlagDefinitionByName(@NonNull
 QName name)

Specified by:

getFlagDefinitionByName in interface IModule

Specified by:

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