Module dev.metaschema.core

Package dev.metaschema.core.model

Interface IContainerModelGrouped

All Superinterfaces:

IContainer, IContainerModel

All Known Subinterfaces:

IBoundInstanceModelChoiceGroup, IChoiceGroupInstance, IFeatureContainerModelGrouped<NMI,FI,AI>

All Known Implementing Classes:

AbstractChoiceGroupInstance

public interface IContainerModelGrouped
extends IContainerModel

Represents a model container with grouped instances.

Grouped instances are part of a choice group and share a common group-as name. This interface narrows the return types of IContainerModel methods to grouped instance types.

Method Summary

Modifier and Type	Method	Description
IAssemblyInstanceGrouped	getAssemblyInstanceByName(Integer name)	Get the assembly instance contained within the model with the associated use name.
Collection<? extends IAssemblyInstanceGrouped>	getAssemblyInstances()	Get all assembly instances within the container.
IFieldInstanceGrouped	getFieldInstanceByName(Integer name)	Get the field instance contained within the model with the associated use name.
Collection<? extends IFieldInstanceGrouped>	getFieldInstances()	Get all field instances within the container.
default Collection<? extends INamedModelInstanceGrouped>	getModelInstances()	Get all model instances within the container.
INamedModelInstanceGrouped	getNamedModelInstanceByName(Integer name)	Get the model instance contained within the model with the associated use name.
Collection<? extends INamedModelInstanceGrouped>	getNamedModelInstances()	Get all named model instances within the container.
IAssemblyDefinition	getOwningDefinition()	Retrieve the Metaschema module definition containing this container.

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

hasChildren

Method Details

getOwningDefinition

IAssemblyDefinition getOwningDefinition()

Description copied from interface: IContainerModel

Retrieve the Metaschema module definition containing this container.

Specified by:

getOwningDefinition in interface IContainerModel

Returns:

the containing Metaschema module definition

getModelInstances

@NonNull
default Collection<? extends INamedModelInstanceGrouped> getModelInstances()

Description copied from interface: IContainerModel

Get all model instances within the container.

Specified by:

getModelInstances in interface IContainerModel

Returns:

an ordered collection of model instances

getNamedModelInstances

@NonNull
Collection<? extends INamedModelInstanceGrouped> getNamedModelInstances()

Get all named model instances within the container.

Specified by:

getNamedModelInstances in interface IContainerModel

Returns:

the named model instances in this container

getNamedModelInstanceByName

@Nullable
INamedModelInstanceGrouped getNamedModelInstanceByName(Integer name)

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

Specified by:

getNamedModelInstanceByName in interface IContainerModel

Parameters:

name - the effective name of the model instance

Returns:

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

See Also:

• INamed.getEffectiveName()

getFieldInstances

@NonNull
Collection<? extends IFieldInstanceGrouped> getFieldInstances()

Get all field instances within the container.

Specified by:

getFieldInstances in interface IContainerModel

Returns:

the field instances in this container

getFieldInstanceByName

@Nullable
IFieldInstanceGrouped getFieldInstanceByName(Integer name)

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

Specified by:

getFieldInstanceByName in interface IContainerModel

Parameters:

name - the use name of the field instance

Returns:

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

See Also:

• INamed.getUseName()

getAssemblyInstances

@NonNull
Collection<? extends IAssemblyInstanceGrouped> getAssemblyInstances()

Get all assembly instances within the container.

Specified by:

getAssemblyInstances in interface IContainerModel

Returns:

the assembly instances in this container

getAssemblyInstanceByName

@Nullable
IAssemblyInstanceGrouped getAssemblyInstanceByName(Integer name)

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

Specified by:

getAssemblyInstanceByName in interface IContainerModel

Parameters:

name - the effective name of the assembly instance

Returns:

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

See Also:

• INamed.getEffectiveName()