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

Interface IModelElement

All Superinterfaces:
IDefaultable, IModelElementVisitable
All Known Subinterfaces:
IAssembly, IAssemblyDefinition, IAssemblyInstance, IAssemblyInstanceAbsolute, IAssemblyInstanceGrouped, IChoiceGroupInstance, IChoiceInstance, IDefinition, IFeatureContainerFlag<FI>, IFeatureDefinitionInstanceInlined<DEFINITION,INSTANCE>, IFeatureDefinitionReferenceInstance<DEFINITION,INSTANCE>, IFeatureValueless, IField, IFieldDefinition, IFieldInstance, IFieldInstanceAbsolute, IFieldInstanceGrouped, IFlag, IFlagDefinition, IFlagInstance, IGroupable, IInstance, IInstanceAbsolute, IModelDefinition, IModelInstance, IModelInstanceAbsolute, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, INamedModelInstanceGrouped, IValuedDefinition, IValuedInstance
All Known Implementing Classes:
AbstractAssemblyInstance, AbstractChoiceGroupInstance, AbstractChoiceInstance, AbstractFieldInstance, AbstractFlagInstance, AbstractGlobalAssemblyDefinition, AbstractGlobalDefinition, AbstractGlobalFieldDefinition, AbstractGlobalFlagDefinition, AbstractInlineAssemblyDefinition, AbstractInlineFieldDefinition, AbstractInlineFlagDefinition, AbstractInstance, AbstractNamedInstance, AbstractNamedModelInstance
public interface IModelElement extends IDefaultable, IModelElementVisitable
A marker interface for Metaschema constructs that can be members of a Metaschema definition's model.

  • Method Details

    • getModelType

      @NonNull ModelType getModelType()
      Get the Metaschema model type of the information element.
      Returns:
      the type

    • toCoordinates

      @NonNull String toCoordinates()
      Retrieves a string that uniquely identifies the model element in the overall collection of model elements. This should the type of element, it's name, and any additional information needed to uniquely identify it.
      Returns:
      the coordinates

    • getRemarks

      @Nullable MarkupMultiline getRemarks()
      Retrieve the remarks associated with this information element, if any.
      Returns:
      the remarks or null if no remarks are defined

    • getContainingModule

      @NonNull IModule getContainingModule()
      Retrieves the Metaschema module that contains the information element's declaration.
      Returns:
      the Metaschema module