Module dev.metaschema.core

Package dev.metaschema.core.model

Interface IFeatureContainerModelGrouped<NMI extends INamedModelInstanceGrouped,FI extends IFieldInstanceGrouped,AI extends IAssemblyInstanceGrouped>

Type Parameters:

NMI - the Java type of named model instances

FI - the Java type of field instances

AI - the Java type of assembly instances

All Superinterfaces:

IContainer, IContainerModel, IContainerModelGrouped

All Known Implementing Classes:

AbstractChoiceGroupInstance

public interface IFeatureContainerModelGrouped<NMI extends INamedModelInstanceGrouped,FI extends IFieldInstanceGrouped,AI extends IAssemblyInstanceGrouped>
extends IContainerModelGrouped

Provides grouped container model functionality through delegation.

This interface provides default implementations for grouped container model operations by delegating to an IContainerModelSupport instance.

Method Summary

Modifier and Type	Method	Description
default AI	getAssemblyInstanceByName(Integer name)	Get the assembly instance contained within the model with the associated use name.
default Collection<AI>	getAssemblyInstances()	Get all assembly instances within the container.
default FI	getFieldInstanceByName(Integer name)	Get the field instance contained within the model with the associated use name.
default Collection<FI>	getFieldInstances()	Get all field instances within the container.
IContainerModelSupport<NMI,NMI,FI,AI>	getModelContainer()	Get the model container implementation instance.
default Collection<NMI>	getModelInstances()	Get all model instances within the container.
default NMI	getNamedModelInstanceByName(Integer name)	Get the model instance contained within the model with the associated use name.
default Collection<NMI>	getNamedModelInstances()	Get all named model instances within the container.
default boolean	hasChildren()	Identifies if the container allows child instances or not.

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

getOwningDefinition

Method Details

getModelContainer

@NonNull
IContainerModelSupport<NMI,NMI,FI,AI> getModelContainer()

Get the model container implementation instance.

Returns:

the model container instance

hasChildren

default boolean hasChildren()

Description copied from interface: IContainer

Identifies if the container allows child instances or not.

This can be the case if the container has flags or a complex model with at least a choice, choice group, field, or assembly instance.

Specified by:

hasChildren in interface IContainer

Specified by:

hasChildren in interface IContainerModel

Returns:

true if there are flags or a model, or false otherwise

getModelInstances

default Collection<NMI> getModelInstances()

Description copied from interface: IContainerModel

Get all model instances within the container.

Specified by:

getModelInstances in interface IContainerModel

Specified by:

getModelInstances in interface IContainerModelGrouped

Returns:

an ordered collection of model instances

getNamedModelInstanceByName

default NMI getNamedModelInstanceByName(Integer name)

Description copied from interface: IContainerModelGrouped

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

Specified by:

getNamedModelInstanceByName in interface IContainerModel

Specified by:

getNamedModelInstanceByName in interface IContainerModelGrouped

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

getNamedModelInstances

default Collection<NMI> getNamedModelInstances()

Description copied from interface: IContainerModelGrouped

Get all named model instances within the container.

Specified by:

getNamedModelInstances in interface IContainerModel

Specified by:

getNamedModelInstances in interface IContainerModelGrouped

Returns:

the named model instances in this container

getFieldInstanceByName

default FI getFieldInstanceByName(Integer name)

Description copied from interface: IContainerModelGrouped

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

Specified by:

getFieldInstanceByName in interface IContainerModel

Specified by:

getFieldInstanceByName in interface IContainerModelGrouped

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

getFieldInstances

default Collection<FI> getFieldInstances()

Description copied from interface: IContainerModelGrouped

Get all field instances within the container.

Specified by:

getFieldInstances in interface IContainerModel

Specified by:

getFieldInstances in interface IContainerModelGrouped

Returns:

the field instances in this container

getAssemblyInstanceByName

default AI getAssemblyInstanceByName(Integer name)

Description copied from interface: IContainerModelGrouped

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

Specified by:

getAssemblyInstanceByName in interface IContainerModel

Specified by:

getAssemblyInstanceByName in interface IContainerModelGrouped

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

getAssemblyInstances

default Collection<AI> getAssemblyInstances()

Description copied from interface: IContainerModelGrouped

Get all assembly instances within the container.

Specified by:

getAssemblyInstances in interface IContainerModel

Specified by:

getAssemblyInstances in interface IContainerModelGrouped

Returns:

the assembly instances in this container