Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MappingElement

Warning: this class represents an abstract and non-instantiable concept in the meta model. You should not try to instantiate this class directly, but instantiate one of its concrete/non-abstract sub classes instead. Instantiating this class is possible in pure JavaScript, but there's no guarantee the result will be at all useful.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private ___documentation

___documentation: any

Private ___elementType

___elementType: any

Private ___exposedName

___exposedName: any

Private ___maxOccurs

___maxOccurs: any

Private ___minOccurs

___minOccurs: any

Private ___nillable

___nillable: any

Private ___path

___path: any

container

container: AbstractElement

containerAsMappingDocument

containerAsMappingDocument: MappingDocument

containerAsObjectMappingElement

containerAsObjectMappingElement: ObjectMappingElement

documentation

documentation: string

elementType

elementType: ElementType

exposedName

exposedName: string

In version 6.6.0: introduced

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

  • if false, a load is required to access these properties.

maxOccurs

maxOccurs: number

minOccurs

minOccurs: number

model

model: IModel

nillable

nillable: boolean

path

path: string

The value of this property is conceptually of type mappings.ElementPath.

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

Static typeName

typeName: string

Static versionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void
  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void
        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc