Module dev.metaschema.core

Package dev.metaschema.core.model

Interface IFeatureContainerModelAbsolute<MI extends IModelInstanceAbsolute,NMI extends INamedModelInstanceAbsolute,FI extends IFieldInstanceAbsolute,AI extends IAssemblyInstanceAbsolute>

Type Parameters:

MI - the model instance Java type

NMI - the named model instance Java type

FI - the field instance Java type

AI - the assembly instance Java type

All Superinterfaces:

IContainer, IContainerModel, IContainerModelAbsolute

All Known Subinterfaces:

IFeatureContainerModelAssembly<MI,NMI,FI,AI,CI,CGI>

All Known Implementing Classes:

AbstractChoiceInstance, AbstractGlobalAssemblyDefinition, AbstractInlineAssemblyDefinition

public interface IFeatureContainerModelAbsolute<MI extends IModelInstanceAbsolute,NMI extends INamedModelInstanceAbsolute,FI extends IFieldInstanceAbsolute,AI extends IAssemblyInstanceAbsolute>
extends IContainerModelAbsolute

Common interface for model container support classes.

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<MI,NMI,FI,AI>	getModelContainer()	Get the model container implementation instance.
default Collection<? extends MI>	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.

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

getOwningDefinition, hasChildren

Method Details

getModelContainer

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

Get the model container implementation instance.

Returns:

the model container instance

getModelInstances

default Collection<? extends MI> getModelInstances()

Description copied from interface: IContainerModel

Get all model instances within the container.

Specified by:

getModelInstances in interface IContainerModel

Specified by:

getModelInstances in interface IContainerModelAbsolute

Returns:

an ordered collection of model instances

getNamedModelInstanceByName

default NMI getNamedModelInstanceByName(Integer name)

Description copied from interface: IContainerModel

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

Specified by:

getNamedModelInstanceByName in interface IContainerModel

Specified by:

getNamedModelInstanceByName in interface IContainerModelAbsolute

Parameters:

name - the effective name-based qualified name index 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: IContainerModel

Get all named model instances within the container.

Specified by:

getNamedModelInstances in interface IContainerModel

Specified by:

getNamedModelInstances in interface IContainerModelAbsolute

Returns:

an ordered mapping of use name to model instance

getFieldInstanceByName

default FI getFieldInstanceByName(Integer name)

Description copied from interface: IContainerModel

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

Specified by:

getFieldInstanceByName in interface IContainerModel

Specified by:

getFieldInstanceByName in interface IContainerModelAbsolute

Parameters:

name - the use name-based qualified name index 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: IContainerModel

Get all field instances within the container.

Specified by:

getFieldInstances in interface IContainerModel

Specified by:

getFieldInstances in interface IContainerModelAbsolute

Returns:

a mapping of use name to field instance

getAssemblyInstanceByName

default AI getAssemblyInstanceByName(Integer name)

Description copied from interface: IContainerModel

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

Specified by:

getAssemblyInstanceByName in interface IContainerModel

Specified by:

getAssemblyInstanceByName in interface IContainerModelAbsolute

Parameters:

name - the effective name-based qualified name index 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: IContainerModel

Get all assembly instances within the container.

Specified by:

getAssemblyInstances in interface IContainerModel

Specified by:

getAssemblyInstances in interface IContainerModelAbsolute

Returns:

a mapping of use name to assembly instance