Class Model<T>Abstract

A "model" is a class that implements runtime functionality associated with the corresponding element type.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

asOf? description? details? errors? id? isSeed? isType? isTypeScope? name operationalBase? tag type? until? xref? types

Accessors

allowedBaseTags base children discriminator effectiveId effectiveType effectiveXref globalBase isGlobal key parent path shadow valid

Methods

all appliesTo clone error extend freeze get instanceOf member owner references toJSON toString valueOf visit create

Constructors

constructor

Properties

OptionalasOf

asOf?: `${number}.${number}`

Optionaldescription

description?: string

Optionaldetails

details?: string

Optionalerrors

errors?: DefinitionError[]

Optionalid

id?: number

OptionalisSeed

isSeed?: boolean

OptionalisType

isType?: boolean

Indicates that an element defines a datatype.

OptionalisTypeScope

isTypeScope?: boolean

Indicates that an element may have type definitions as children.

name

name: string

OptionaloperationalBase

operationalBase?: Model<BaseElement>

Normally base performs lookup based on type. If instead a model is installed it is used as the base.

The operational base also enables resolution from the operational base's tree. This enables resolution on operational models that are not installed in a parent hierarchy.

Abstract Readonlytag

tag: ElementTag

Optionaltype

type?: string

Optionaluntil

until?: `${number}.${number}`

Optionalxref

xref?: CrossReference

Statictypes

types: {
    [type: string]: (new (definition: any) => Model);
}

Factory support. Populated by derivatives upon definition.

Accessors

allowedBaseTags

  • get allowedBaseTags(): ElementTag[]

  • The set of tags from which this model may derive.

    Returns ElementTag[]

base

  • get base(): undefined | Model<BaseElement>

  • Get a model for my base type as defined by type, if any.

    Returns undefined | Model<BaseElement>

children

  • get children(): Children<Model<BaseElement>>

  • Children of models are always models.

    Returns Children<Model<BaseElement>>

  • set children(children): void

  • Set the children of the model.

    Parameters

    Returns void

discriminator

  • get discriminator(): undefined | string

  • Obtain a discriminator that differentiates different models with the same name

    Returns undefined | string

effectiveId

  • get effectiveId(): undefined | number

  • Allows subclasses to pull a working ID from an alternate source.

    Returns undefined | number

effectiveType

  • get effectiveType(): undefined | string

  • In some circumstances the base type can be inferred. This inference happens here.

    Does not recurse so only returns the direct base type.

    Returns undefined | string

effectiveXref

  • get effectiveXref(): undefined | CrossReference

  • A local or parent xref.

    Returns undefined | CrossReference

globalBase

  • get globalBase(): undefined | Model<BaseElement>

  • Get the first global base type. This may have semantic meaning more specific than the base primitive type.

    Returns undefined | Model<BaseElement>

isGlobal

  • get isGlobal(): boolean

  • Determine if this model resides in the global namespace.

    Returns boolean

key

  • get key(): undefined | string

  • Get a string that uniquely identifies this model. This is normally the effective ID but some models require a generated identifier.

    Returns undefined | string

parent

  • get parent(): undefined | Model<BaseElement>

  • The structural parent. This is the model for the element that contains this element's definition.

    Returns undefined | Model<BaseElement>

  • set parent(parent): void

  • Parameters

    Returns void

path

  • get path(): string

  • The path ("." delimited) in the Matter tree.

    This is informational and generally tries to adhere to JS API conventions.

    Returns string

shadow

  • get shadow(): undefined | Model<BaseElement>

  • Get shadow model, if any. A "shadow" is an element in my parent's inheritance hierarchy that I override.

    Returns undefined | Model<BaseElement>

valid

  • get valid(): boolean

  • Did validation find errors?

    Returns boolean

Methods

all

  • all<T>(type, key?): T[]

  • Retrieve all models of a specific element type from local scope.

    Type Parameters

    Parameters

    • type: Type<T>

      model class or a predicate object

    • Optionalkey: string | number

      filters to models matching a specific type

    Returns T[]

appliesTo

  • appliesTo(revision): boolean

  • Determine whether this element applies to a specific revision.

    Parameters

    • revision: `${number}.${number}`

    Returns boolean

clone

  • clone<This>(this): This

  • Clone the model. This deep copies all descendant child models but not other properties.

    Type Parameters

    Parameters

    Returns This

error

  • error(code, message): void

  • Record a validation error for this model.

    Parameters

    • code: string
    • message: string

    Returns void

extend

  • extend<This>(this, properties?): This

  • Create an operational extension of the model. This creates a new model that inherits from this model for operational purposes.

    Type Parameters

    Parameters

    Returns This

freeze

  • freeze(): void

  • Freeze the model hierarchy rooted at this model.

    When using a model as operational schema we implement various optimizations that assume the schema is immutable. This function enforces that assumption.

    To make changes to a frozen model use clone.

    Returns void

get

  • get<T>(type, key): undefined | T

  • Retrieve a specific child by ID or name.

    Type Parameters

    Parameters

    • type: Type<T>
    • key: string | number

    Returns undefined | T

instanceOf

  • instanceOf(other): boolean

  • Does this model derive from another?

    Parameters

    Returns boolean

member

  • member(key, allowedTags?): undefined | Model<BaseElement>

  • Search the inheritance chain for a child property.

    Parameters

    Returns undefined | Model<BaseElement>

owner

  • owner<T>(constructor): undefined | T

  • Retrieve a model of a specific type from the ownership hierarchy.

    Type Parameters

    Parameters

    Returns undefined | T

references

toJSON

  • toJSON(): T

  • Convert model to JSON.

    Returns T

toString

  • toString(): string

  • Returns string

valueOf

  • valueOf(): T

  • Convert to non-class structure.

    Returns T

visit

  • visit(visitor): undefined | boolean

  • Apply a function to all tree elements.

    Parameters

    Returns undefined | boolean

Staticcreate

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods