Module dev.metaschema.core

Package dev.metaschema.core.model

Interface INamedModelInstanceGrouped

All Superinterfaces:

IAttributable, IDefaultable, IDescribable, IGroupable, IInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, INamed, INamedInstance, INamedModelElement, INamedModelInstance

All Known Subinterfaces:

IAssemblyInstanceGrouped, IFieldInstanceGrouped

public interface INamedModelInstanceGrouped
extends INamedModelInstance

Represents an arbitrary grouping of Metaschema model instances.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.core.model.IAttributable

IAttributable.Key

Field Summary

Fields inherited from interface dev.metaschema.core.model.IAttributable

DEFAULT_PROPERY_NAMESPACE

Fields inherited from interface dev.metaschema.core.model.IGroupable

DEFAULT_GROUP_AS_MAX_OCCURS, DEFAULT_GROUP_AS_MIN_OCCURS, DEFAULT_JSON_GROUP_AS_BEHAVIOR, DEFAULT_XML_GROUP_AS_BEHAVIOR

Method Summary

Modifier and Type	Method	Description
default IAssemblyDefinition	getContainingDefinition()	Retrieve the Metaschema module definition on which the instance was declared.
String	getDiscriminatorValue()	Get the discriminator JSON property name to use to identify the type of a given instance object.
default String	getEffectiveDisciminatorValue()	Get the effective discriminator JSON property name to use to identify the type of a given instance object.
default IFlagInstance	getEffectiveJsonKey()	Get the JSON key flag instance for this model instance, if one is configured.
default IFlagInstance	getJsonKey()	Get the JSON key associated with this instance.
default int	getMaxOccurs()	Get the maximum cardinality for this associated instance.
default int	getMinOccurs()	Get the minimum cardinality for this associated instance.
IChoiceGroupInstance	getParentContainer()	Get the parent model definition that serves as the container of this instance.

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

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

getDefaultValue, getEffectiveDefaultValue, getResolvedDefaultValue

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

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

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

getEffectiveXmlGroupAsQName, getGroupAsName, getItemValues, getJsonGroupAsBehavior, getXmlGroupAsBehavior

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

toCoordinates

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

getContainingModule, getModelType, getRemarks

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

accept

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

isEffectiveValueWrappedInXml

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

getEffectiveIndex, getEffectiveName, getIndex, getName, getQName, getUseIndex, getUseName

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

getReferencedDefinitionQName, isInlineDefinition

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

getJsonName

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

getDefinition, hasJsonKey

Method Details

getParentContainer

IChoiceGroupInstance getParentContainer()

Description copied from interface: IInstance

Get the parent model definition that serves as the container of this instance.

Specified by:

getParentContainer in interface IInstance

Specified by:

getParentContainer in interface IModelInstance

Returns:

the container

getContainingDefinition

default IAssemblyDefinition getContainingDefinition()

Description copied from interface: IInstance

Retrieve the Metaschema module definition on which the instance was declared.

Specified by:

getContainingDefinition in interface IInstance

Specified by:

getContainingDefinition in interface IModelInstance

Returns:

the Metaschema module definition on which the instance was declared

getDiscriminatorValue

@Nullable
String getDiscriminatorValue()

Get the discriminator JSON property name to use to identify the type of a given instance object.

Returns:

the discriminator property name or null if the effective name should be used instead

getEffectiveDisciminatorValue

@NonNull
default String getEffectiveDisciminatorValue()

Get the effective discriminator JSON property name to use to identify the type of a given instance object.

Returns:

the discriminator property name

getEffectiveJsonKey

@Nullable
default IFlagInstance getEffectiveJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key flag instance for this model instance, if one is configured.

Specified by:

getEffectiveJsonKey in interface INamedModelInstance

Returns:

the JSON key flag instance or null if no JSON key is configured

getJsonKey

@Nullable
default IFlagInstance getJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key associated with this instance.

Specified by:

getJsonKey in interface INamedModelInstance

Returns:

the configured JSON key or null if no JSON key is configured

getMinOccurs

default int getMinOccurs()

Description copied from interface: IGroupable

Get the minimum cardinality for this associated instance. This value must be less than or equal to the maximum cardinality returned by IGroupable.getMaxOccurs().

Specified by:

getMinOccurs in interface IGroupable

Returns:

0 or a positive integer value

See Also:

• IGroupable.DEFAULT_GROUP_AS_MIN_OCCURS

getMaxOccurs

default int getMaxOccurs()

Description copied from interface: IGroupable

Get the maximum cardinality for this associated instance. This value must be greater than or equal to the minimum cardinality returned by IGroupable.getMinOccurs(), or -1 if unbounded.

Specified by:

getMaxOccurs in interface IGroupable

Returns:

a positive integer value or -1 if unbounded

See Also:

• IGroupable.DEFAULT_GROUP_AS_MAX_OCCURS