Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundInstanceModelGroupedNamed

All Superinterfaces:

IAttributable, IDefaultable, IDescribable, IFeatureComplexItemValueHandler, IGroupable, IInstance, IItemValueHandler<IBoundObject>, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceGrouped

All Known Subinterfaces:

IBoundInstanceModelGroupedAssembly, IBoundInstanceModelGroupedField

public interface IBoundInstanceModelGroupedNamed
extends INamedModelInstanceGrouped, IFeatureComplexItemValueHandler

Represents a model instance that is a member of a choice group instance.

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 void	callAfterDeserialize(IBoundObject targetObject, IBoundObject parentObject)	Invoke the after-deserialize lifecycle callback on the target object.
default void	callBeforeDeserialize(IBoundObject targetObject, IBoundObject parentObject)	Invoke the before-deserialize lifecycle callback on the target object.
default IBoundObject	deepCopyItem(IBoundObject item, IBoundObject parentInstance)	Create and return a deep copy of the provided item.
default IBoundDefinitionModelAssembly	getContainingDefinition()	Retrieve the Metaschema module definition on which the instance was declared.
IBoundDefinitionModelComplex	getDefinition()	Retrieve the definition of this instance.
default IBoundInstanceFlag	getEffectiveJsonKey()	Get the JSON key flag instance for this model instance, if one is configured.
default IBoundInstanceFlag	getJsonKey()	Get the JSON key associated with this instance.
default String	getName()	Retrieve the name of the model element.
IBoundInstanceModelChoiceGroup	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.databind.model.info.IFeatureComplexItemValueHandler

getBoundClass, getJsonProperties, newInstance

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.databind.model.info.IItemValueHandler

readItem, writeItem

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, 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

hasJsonKey

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

getDiscriminatorValue, getEffectiveDisciminatorValue, getMaxOccurs, getMinOccurs

Method Details

getParentContainer

IBoundInstanceModelChoiceGroup 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

Specified by:

getParentContainer in interface INamedModelInstanceGrouped

Returns:

the container

getDefinition

IBoundDefinitionModelComplex getDefinition()

Description copied from interface: INamedInstance

Retrieve the definition of this instance.

Specified by:

getDefinition in interface IFeatureComplexItemValueHandler

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

Returns:

the corresponding definition

getEffectiveJsonKey

@Nullable
default IBoundInstanceFlag 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

Specified by:

getEffectiveJsonKey in interface INamedModelInstanceGrouped

Returns:

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

getJsonKey

default IBoundInstanceFlag getJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key associated with this instance.

Specified by:

getJsonKey in interface INamedModelInstance

Specified by:

getJsonKey in interface INamedModelInstanceGrouped

Returns:

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

getContainingDefinition

default IBoundDefinitionModelAssembly 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

Specified by:

getContainingDefinition in interface INamedModelInstanceGrouped

Returns:

the Metaschema module definition on which the instance was declared

getName

default String getName()

Description copied from interface: INamed

Retrieve the name of the model element.

Specified by:

getName in interface INamed

Returns:

the name

deepCopyItem

default IBoundObject deepCopyItem(IBoundObject item,
 IBoundObject parentInstance)
                           throws BindingException

Description copied from interface: IItemValueHandler

Create and return a deep copy of the provided item.

Specified by:

deepCopyItem in interface IFeatureComplexItemValueHandler

Specified by:

deepCopyItem in interface IItemValueHandler<IBoundObject>

Parameters:

item - the item to copy

parentInstance - an optional parent object to use for serialization callbacks

Returns:

the new deep copy

Throws:

BindingException - if an error occurred while analyzing the bound objects

callBeforeDeserialize

default void callBeforeDeserialize(IBoundObject targetObject,
 IBoundObject parentObject)
                            throws BindingException

Description copied from interface: IFeatureComplexItemValueHandler

Invoke the before-deserialize lifecycle callback on the target object.

Specified by:

callBeforeDeserialize in interface IFeatureComplexItemValueHandler

Parameters:

targetObject - the object being deserialized

parentObject - the parent object containing the target, or null if there is no parent

Throws:

BindingException - if an error occurs during the callback

callAfterDeserialize

default void callAfterDeserialize(IBoundObject targetObject,
 IBoundObject parentObject)
                           throws BindingException

Description copied from interface: IFeatureComplexItemValueHandler

Invoke the after-deserialize lifecycle callback on the target object.

Specified by:

callAfterDeserialize in interface IFeatureComplexItemValueHandler

Parameters:

targetObject - the object that was deserialized

parentObject - the parent object containing the target, or null if there is no parent

Throws:

BindingException - if an error occurs during the callback