Module dev.metaschema.core
Package dev.metaschema.core.model

Interface IInstance

All Superinterfaces:
IDefaultable, IModelElement, IModelElementVisitable
All Known Subinterfaces:
IAssemblyInstance, IAssemblyInstanceAbsolute, IAssemblyInstanceGrouped, IBindingInstance, IBindingInstanceModel, IBoundInstance<ITEM>, IBoundInstanceFlag, IBoundInstanceModel<ITEM>, IBoundInstanceModelAssembly, IBoundInstanceModelChoiceGroup, IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar, IBoundInstanceModelGroupedAssembly, IBoundInstanceModelGroupedField, IBoundInstanceModelGroupedNamed, IBoundInstanceModelNamed<ITEM>, IChoiceGroupInstance, IChoiceInstance, IFeatureDefinitionInstanceInlined<DEFINITION,INSTANCE>, IFeatureDefinitionReferenceInstance<DEFINITION,INSTANCE>, IFeatureValueless, IFieldInstance, IFieldInstanceAbsolute, IFieldInstanceGrouped, IFlagInstance, IGroupable, IInstanceAbsolute, IModelInstance, IModelInstanceAbsolute, INamedInstance, INamedModelInstance, INamedModelInstanceAbsolute, INamedModelInstanceGrouped, IValuedInstance
All Known Implementing Classes:
AbstractAssemblyInstance, AbstractChoiceGroupInstance, AbstractChoiceInstance, AbstractFieldInstance, AbstractFlagInstance, AbstractInlineAssemblyDefinition, AbstractInlineFieldDefinition, AbstractInlineFlagDefinition, AbstractInstance, AbstractNamedInstance, AbstractNamedModelInstance
public interface IInstance extends IModelElement
This marker interface indicates that this object is an instance.

  • Method Details

    • getContainingDefinition

      @NonNull IModelDefinition getContainingDefinition()
      Retrieve the Metaschema module definition on which the instance was declared.
      Returns:
      the Metaschema module definition on which the instance was declared

    • getParentContainer

      @NonNull IContainer getParentContainer()
      Get the parent model definition that serves as the container of this instance.
      Returns:
      the container

    • toCoordinates

      String toCoordinates()
      Generates a "coordinate" string for the provided information element instance. A coordinate consists of the element's:
      • containing Metaschema module's short name
      • model type
      • name
      • hash code
      • the hash code of the definition
      Specified by:
      toCoordinates in interface IModelElement
      Returns:
      the coordinate