MetamodelEntity
Base type for Highway entities participating in model identity, registration, and ownership. Other Highway types, such as DataType and DocumentMetadata, do not extend this class.
Keep this class small and stable: new common metadata fields can be added here in the future (e.g. responsible, owner, lifecycle state).
name / description / asil are nullable authoring attributes. Type contracts and model rules determine which are required or inapplicable for each entity type, and report missing required values as HIGH. They must not be used as identifiers and may be duplicated across entities. The canonical unique identifier is id, computed from the declaring context and the Kotlin val name captured into referenceName by model wiring. The read-only fullLabel, idLabel, and shortIdLabel extensions provide presentation text without adding stored attributes or changing identity.
Registry / scope
Every constructed entity is registered in the current ModelScope — see allInstancesSnapshot; the wireup pass and structural-consistency rules iterate it. Without an explicit scope, construction targets the process-global default scope (ModelScope.global). WireModel.reset clears the current scope — call it once per stigCheckModel invocation so that companion-static state from a previous Gradle-daemon run does not leak into the new one.
Live source-materializers (the IDEA plugin) wrap their work in ModelScope.with(scope) { … } so that per-file materialization runs in an isolated registry and does not interfere with other open files or with the global default.
Inheritors
Constructors
Properties
Identity of the authored Kotlin declaration, independent of its receiving model instance. Inherited declarations retain this provenance while id distinguishes each owning instance.
Fully-qualified name of the declaring context. Prefers declaringClassNameOverride (set explicitly by source materializers or canonical-ID binding) over declaringClass's captured name; falls back to null if neither is available.
Fully-qualified unique identifier of this model instance. A member follows its actual owning instance, so two instances of the same user class have distinct member IDs. declarationId retains the common source declaration for navigation and naming rules.
Kotlin val name that holds this entity, scoped to its declaring context. Populated reflectively by WireModel.wireAll in the compiled path, or set directly via bindToSource in the source-materialized path. null until either runs.
Functions
Binds an authored field or constructor-owned value without replacing its source declaration provenance.
Registers a child entity declared inside a source-materialized parent.
Records source-declared uses without changing the target's declaration or owner.
Binds an entity to an already computed canonical MetamodelEntity.id.
Sets the canonical identifiers for an entity that was materialized from source (as opposed to being instantiated from compiled bytecode). Intended for use by PSI / source materializers such as the IDEA plugin.
Interface-point analyses in declaration order, including analyses nested beneath ports or service groups.
Structural children, including explicit metamodel containment. Relation targets retain their own declaration.