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

Interface IBoundInstanceModelNamed<ITEM>

Type Parameters:
ITEM - the Java type of the bound item
All Superinterfaces:
dev.metaschema.core.model.IAttributable, IBoundInstance<ITEM>, IBoundInstanceModel<ITEM>, IBoundModelElement, IBoundModelObject<ITEM>, IBoundProperty<ITEM>, dev.metaschema.core.model.IDefaultable, dev.metaschema.core.model.IDescribable, IFeatureJavaField, dev.metaschema.core.model.IGroupable, dev.metaschema.core.model.IInstance, dev.metaschema.core.model.IInstanceAbsolute, IItemValueHandler<ITEM>, dev.metaschema.core.model.IJsonInstance, dev.metaschema.core.model.IJsonNamed, dev.metaschema.core.model.IModelElement, dev.metaschema.core.model.IModelElementVisitable, dev.metaschema.core.model.IModelInstance, dev.metaschema.core.model.IModelInstanceAbsolute, dev.metaschema.core.model.INamed, dev.metaschema.core.model.INamedInstance, dev.metaschema.core.model.INamedModelElement, dev.metaschema.core.model.INamedModelInstance, dev.metaschema.core.model.INamedModelInstanceAbsolute, dev.metaschema.core.model.IValued, IValuedMutable
All Known Subinterfaces:
IBoundInstanceModelAssembly, IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar
public interface IBoundInstanceModelNamed<ITEM> extends IBoundInstanceModel<ITEM>, dev.metaschema.core.model.INamedModelInstanceAbsolute
Represents a bound model instance that is named and can be addressed by that name in the Metaschema model.

  • 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 boolean
    canHandleXmlQName(dev.metaschema.core.qname.IEnhancedQName qname)
    Determine if the provided XML qualified name is associated with this property.
    IBoundDefinitionModel<ITEM>
    getDefinition()
     
    default IBoundInstanceFlag
    getEffectiveJsonKey()
     
    default Integer
    getIndex()
     
    default IBoundInstanceFlag
    getItemJsonKey(Object item)
    Get the JSON key flag for the provided item.
    default Collection<? extends Object>
    getItemValues(Object value)
    Get the item values associated with the provided value.
    default IBoundInstanceFlag
    getJsonKey()
     
    default String
    getName()
     

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

    getProperties, getPropertyValues, hasProperty, hasPropertyValue

    Methods inherited from interface dev.metaschema.databind.model.IBoundInstance

    getContainingModule, getValue, setValue

    Methods inherited from interface dev.metaschema.databind.model.IBoundInstanceModel

    deepCopy, getCollectionInfo, getContainingDefinition, getResolvedDefaultValue

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

    getDefaultValue, getEffectiveDefaultValue

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

    getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

    Methods inherited from interface dev.metaschema.databind.model.IFeatureJavaField

    getField, getItemType, getType

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

    getEffectiveXmlGroupAsQName, getGroupAsName, getJsonGroupAsBehavior, getMaxOccurs, getMinOccurs, getXmlGroupAsBehavior

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

    toCoordinates

    Methods inherited from interface dev.metaschema.databind.model.info.IItemValueHandler

    deepCopyItem, readItem, writeItem

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

    getModelType, getRemarks

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

    accept

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

    getContainingDefinition, getParentContainer, isEffectiveValueWrappedInXml

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

    getEffectiveIndex, getEffectiveName, getQName, getUseIndex, getUseName

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

    getReferencedDefinitionQName, isInlineDefinition

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

    hasJsonKey

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

    getJsonName

  • Method Details

    • getDefinition

      @NonNull IBoundDefinitionModel<ITEM> getDefinition()
      Specified by:
      getDefinition in interface dev.metaschema.core.model.INamedInstance
      Specified by:
      getDefinition in interface dev.metaschema.core.model.INamedModelInstance

    • getName

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

    • getIndex

      default Integer getIndex()
      Specified by:
      getIndex in interface dev.metaschema.core.model.INamed

    • getEffectiveJsonKey

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

    • getJsonKey

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

    • getItemJsonKey

      default IBoundInstanceFlag getItemJsonKey(Object item)
      Description copied from interface: IBoundInstanceModel
      Get the JSON key flag for the provided item.
      Specified by:
      getItemJsonKey in interface IBoundInstanceModel<ITEM>
      Parameters:
      item - the item to get the JSON key flag for
      Returns:
      the JSON key flag

    • getItemValues

      default Collection<? extends Object> getItemValues(Object value)
      Description copied from interface: IBoundInstanceModel
      Get the item values associated with the provided value.
      Specified by:
      getItemValues in interface IBoundInstanceModel<ITEM>
      Specified by:
      getItemValues in interface dev.metaschema.core.model.IGroupable
      Parameters:
      value - the value which may be a singleton or a collection
      Returns:
      the ordered collection of values

    • canHandleXmlQName

      default boolean canHandleXmlQName(dev.metaschema.core.qname.IEnhancedQName qname)
      Description copied from interface: IBoundModelObject
      Determine if the provided XML qualified name is associated with this property.
      Specified by:
      canHandleXmlQName in interface IBoundModelObject<ITEM>
      Parameters:
      qname - the XML qualified name of the property being parsed
      Returns:
      true if the instance will handle this name, or false otherwise