Module dev.metaschema.databind
Package dev.metaschema.databind.model

Interface IBoundInstanceModelGroupedNamed

All Superinterfaces:
dev.metaschema.core.model.IAttributable, dev.metaschema.core.model.IDefaultable, dev.metaschema.core.model.IDescribable, IFeatureComplexItemValueHandler, dev.metaschema.core.model.IGroupable, dev.metaschema.core.model.IInstance, IItemValueHandler<dev.metaschema.core.model.IBoundObject>, dev.metaschema.core.model.IJsonNamed, dev.metaschema.core.model.IModelElement, dev.metaschema.core.model.IModelElementVisitable, dev.metaschema.core.model.IModelInstance, dev.metaschema.core.model.INamed, dev.metaschema.core.model.INamedInstance, dev.metaschema.core.model.INamedModelElement, dev.metaschema.core.model.INamedModelInstance, dev.metaschema.core.model.INamedModelInstanceGrouped
All Known Subinterfaces:
IBoundInstanceModelGroupedAssembly, IBoundInstanceModelGroupedField
public interface IBoundInstanceModelGroupedNamed extends dev.metaschema.core.model.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

    dev.metaschema.core.model.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(dev.metaschema.core.model.IBoundObject targetObject, dev.metaschema.core.model.IBoundObject parentObject)
    Invoke the after-deserialize lifecycle callback on the target object.
    default void
    callBeforeDeserialize(dev.metaschema.core.model.IBoundObject targetObject, dev.metaschema.core.model.IBoundObject parentObject)
    Invoke the before-deserialize lifecycle callback on the target object.
    default dev.metaschema.core.model.IBoundObject
    deepCopyItem(dev.metaschema.core.model.IBoundObject item, dev.metaschema.core.model.IBoundObject parentInstance)
    Create and return a deep copy of the provided item.
    default IBoundDefinitionModelAssembly
    getContainingDefinition()
     
    IBoundDefinitionModelComplex
    getDefinition()
    Get the Metaschema definition representing the bound complex data.
    default IBoundInstanceFlag
    getEffectiveJsonKey()
     
    default IBoundInstanceFlag
    getJsonKey()
     
    default String
    getName()
     
    IBoundInstanceModelChoiceGroup
    getParentContainer()
     

    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()
      Specified by:
      getParentContainer in interface dev.metaschema.core.model.IInstance
      Specified by:
      getParentContainer in interface dev.metaschema.core.model.IModelInstance
      Specified by:
      getParentContainer in interface dev.metaschema.core.model.INamedModelInstanceGrouped

    • getDefinition

      IBoundDefinitionModelComplex getDefinition()
      Description copied from interface: IFeatureComplexItemValueHandler
      Get the Metaschema definition representing the bound complex data.
      Specified by:
      getDefinition in interface IFeatureComplexItemValueHandler
      Specified by:
      getDefinition in interface dev.metaschema.core.model.INamedInstance
      Specified by:
      getDefinition in interface dev.metaschema.core.model.INamedModelInstance
      Returns:
      the definition

    • getEffectiveJsonKey

      @Nullable default IBoundInstanceFlag getEffectiveJsonKey()
      Specified by:
      getEffectiveJsonKey in interface dev.metaschema.core.model.INamedModelInstance
      Specified by:
      getEffectiveJsonKey in interface dev.metaschema.core.model.INamedModelInstanceGrouped

    • getJsonKey

      default IBoundInstanceFlag getJsonKey()
      Specified by:
      getJsonKey in interface dev.metaschema.core.model.INamedModelInstance
      Specified by:
      getJsonKey in interface dev.metaschema.core.model.INamedModelInstanceGrouped

    • getContainingDefinition

      default IBoundDefinitionModelAssembly getContainingDefinition()
      Specified by:
      getContainingDefinition in interface dev.metaschema.core.model.IInstance
      Specified by:
      getContainingDefinition in interface dev.metaschema.core.model.IModelInstance
      Specified by:
      getContainingDefinition in interface dev.metaschema.core.model.INamedModelInstanceGrouped

    • getName

      default String getName()
      Specified by:
      getName in interface dev.metaschema.core.model.INamed

    • deepCopyItem

      default dev.metaschema.core.model.IBoundObject deepCopyItem(dev.metaschema.core.model.IBoundObject item, dev.metaschema.core.model.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<dev.metaschema.core.model.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(dev.metaschema.core.model.IBoundObject targetObject, dev.metaschema.core.model.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(dev.metaschema.core.model.IBoundObject targetObject, dev.metaschema.core.model.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