Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.model

Interface IModelContainer

All Superinterfaces:

IContainer

All Known Subinterfaces:

IAssemblyDefinition, IChoiceInstance, IFeatureModelContainer<MI,NMI,FI,AI,CI>

All Known Implementing Classes:

AbstractChoiceInstance

public interface IModelContainer
extends IContainer

Indicates that the Metaschema type that has a complex model that can contain field and assembly instances.

Method Summary

Modifier and Type	Method	Description
IAssemblyInstance	getAssemblyInstanceByName(String name)	Get the assembly instance contained within the model with the associated use name.
Collection<? extends IAssemblyInstance>	getAssemblyInstances()	Get all assembly instances within the container.
List<? extends IChoiceInstance>	getChoiceInstances()	Get all choice instances within the container.
IFieldInstance	getFieldInstanceByName(String name)	Get the field instance contained within the model with the associated use name.
Collection<? extends IFieldInstance>	getFieldInstances()	Get all field instances within the container.
INamedModelInstance	getModelInstanceByName(String name)	Get the model instance contained within the model with the associated use name.
Collection<? extends IModelInstance>	getModelInstances()	Get all model instances within the container.
Collection<? extends INamedModelInstance>	getNamedModelInstances()	Get all named model instances within the container.
IAssemblyDefinition	getOwningDefinition()	Retrieve the Metaschema definition containing this container.

Method Detail

getOwningDefinition

@NonNull
IAssemblyDefinition getOwningDefinition()

Retrieve the Metaschema definition containing this container.

Specified by:

getOwningDefinition in interface IContainer

Returns:

the containing Metaschema definition

getModelInstanceByName

@Nullable
INamedModelInstance getModelInstanceByName(String name)

Get the model instance contained within the model with the associated use name.

Parameters:

name - the use name of the model instance

Returns:

the matching model instance, or null if no match was found

See Also:

INamedModelElement.getUseName()

getNamedModelInstances

@NonNull
Collection<? extends INamedModelInstance> getNamedModelInstances()

Get all named model instances within the container.

Returns:

an ordered mapping of use name to model instance

getFieldInstances

@NonNull
Collection<? extends IFieldInstance> getFieldInstances()

Get all field instances within the container.

Returns:

a mapping of use name to field instance

getFieldInstanceByName

@Nullable
IFieldInstance getFieldInstanceByName(String name)

Get the field instance contained within the model with the associated use name.

Parameters:

name - the use name of the field instance

Returns:

the matching field instance, or null if no match was found

See Also:

INamedModelElement.getUseName()

getAssemblyInstances

@NonNull
Collection<? extends IAssemblyInstance> getAssemblyInstances()

Get all assembly instances within the container.

Returns:

a mapping of use name to assembly instance

getAssemblyInstanceByName

@Nullable
IAssemblyInstance getAssemblyInstanceByName(String name)

Get the assembly instance contained within the model with the associated use name.

Parameters:

name - the use name of the assembly instance

Returns:

the matching assembly instance, or null if no match was found

See Also:

INamedModelElement.getUseName()

getChoiceInstances

@NonNull
List<? extends IChoiceInstance> getChoiceInstances()

Get all choice instances within the container.

Returns:

a list of choice instances

getModelInstances

@NonNull
Collection<? extends IModelInstance> getModelInstances()

Get all model instances within the container.

Returns:

an ordered collection of model instances