Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PropertyInfoImpl

Package version

Hierarchy

  • PropertyInfoImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PropertyInfoImpl(dtdlVersion: number, id: string, childOf: string | undefined, definedIn: string | undefined, entityKind: PropertyKinds): PropertyInfoImpl

Properties

Protected _checkedDescendantEnumValueDatatype

_checkedDescendantEnumValueDatatype: string | undefined

Protected _checkedForDescendantSchemaArray

_checkedForDescendantSchemaArray: boolean

Protected _checkedForDescendantSchemaOrContentsComponentNarrow

_checkedForDescendantSchemaOrContentsComponentNarrow: boolean

Protected _countOfContentsOrFieldsOrEnumValuesOrRequestOrResponseOrPropertiesOrSchemaOrElementSchemaOrMapValueNarrowStatus

_countOfContentsOrFieldsOrEnumValuesOrRequestOrResponseOrPropertiesOrSchemaOrElementSchemaOrMapValueNarrowStatus: TraversalStatus

Protected _countOfContentsOrFieldsOrEnumValuesOrRequestOrResponseOrPropertiesOrSchemaOrElementSchemaOrMapValueNarrowValue

_countOfContentsOrFieldsOrEnumValuesOrRequestOrResponseOrPropertiesOrSchemaOrElementSchemaOrMapValueNarrowValue: number

Protected _countOfExtendsNarrowStatus

_countOfExtendsNarrowStatus: TraversalStatus

Protected _countOfExtendsNarrowValue

_countOfExtendsNarrowValue: number

Protected _idOfDescendantSchemaArray

_idOfDescendantSchemaArray: InDTMI | undefined

Protected _idOfDescendantSchemaOrContentsComponentNarrow

_idOfDescendantSchemaOrContentsComponentNarrow: InDTMI | undefined

childOf

childOf: string | undefined

Optional comment

comment: undefined | string

definedIn

definedIn: string | undefined

Optional description

description: LanguageStringType

Optional displayName

displayName: LanguageStringType

dtdlVersion

dtdlVersion: number

entityKind

entityKind: PropertyKinds

id

id: string

isPartition

isPartition: boolean

Optional languageVersion

languageVersion: undefined | number

Optional name

name: undefined | string

Optional schema

schema: SchemaInfo

sourceObject

sourceObject: any

supplementalProperties

supplementalProperties: {}

Type declaration

  • [x: string]: any

supplementalTypeIds

supplementalTypeIds: string[]

supplementalTypes

supplementalTypes: SupplementalTypeInfo[]

undefinedProperties

undefinedProperties: {}

Type declaration

  • [name: string]: any

undefinedTypes

undefinedTypes: string[]

Optional writable

writable: undefined | false | true

Static Protected _badTypeActionFormat

_badTypeActionFormat: {}

Type declaration

  • [x: number]: string

Static Protected _badTypeCauseFormat

_badTypeCauseFormat: {}

Type declaration

  • [x: number]: string

Static Protected _concreteKinds

_concreteKinds: {}

Type declaration

Static Protected _versionlessTypes

_versionlessTypes: Set<string>

Methods

addConstraint

  • addConstraint(propertyName: string, valueConstraint: ValueConstraint): void

addInstanceProperty

  • addInstanceProperty(propertyName: string, instancePropertyName: string): void

addType

applyTransformations

applyTransformationsV2

applyTransformationsV3

checkDepthOfElementSchemaOrSchema

  • checkDepthOfElementSchemaOrSchema(depth: number, depthLimit: number, tooDeepElementId: Reference<InDTMI>, parsingErrors: ParsingError[]): boolean

checkDescendantEnumValueDataType

  • checkDescendantEnumValueDataType(ancestorId: InDTMI, datatype: string, parsingErrors: ParsingError[]): void

checkRestrictions

checkRestrictionsV2

checkRestrictionsV3

doesHaveType

  • doesHaveType(typeId: string): boolean

doesPropertyDictContainKey

  • doesPropertyDictContainKey(propertyName: string, key: string | undefined): boolean

getCountOfContentsOrFieldsOrEnumValuesOrRequestOrResponseOrPropertiesOrSchemaOrElementSchemaOrMapValueNarrow

  • getCountOfContentsOrFieldsOrEnumValuesOrRequestOrResponseOrPropertiesOrSchemaOrElementSchemaOrMapValueNarrow(parsingErrors: ParsingError[]): number

getCountOfExtendsNarrow

  • getCountOfExtendsNarrow(parsingErrors: ParsingError[]): number

getTransitiveExtendsNarrow

  • getTransitiveExtendsNarrow(depth: number, depthLimit: number, tooDeepElementId: Reference<InDTMI>, parsingErrors: ParsingError[]): Set<string> | undefined

parsePropertiesV2

parsePropertiesV3

setPartitionInfo

  • setPartitionInfo(partitionJsonText: string): void

tryGetDescendantSchemaArray

tryGetDescendantSchemaOrContentsComponentNarrow

  • tryGetDescendantSchemaOrContentsComponentNarrow(elementId: Reference<InDTMI>): boolean

tryParseSupplementalProperty

trySetObjectProperty

  • trySetObjectProperty(propertyName: string, value: any, key: string | undefined): boolean

validateInstance

  • validateInstance(instanceText: string): boolean

validateInstanceElement

  • validateInstanceElement(instanceElt: any): boolean

validateInstanceInternal

  • validateInstanceInternal(instanceElt: any, instanceName: string | undefined): boolean

validateInstanceV2

  • validateInstanceV2(instanceElt: any, instanceName: string | undefined): boolean

validateInstanceV3

  • validateInstanceV3(instanceElt: any, instanceName: string | undefined): boolean

Static initialize

  • initialize(): void

Static parseIdString

Static parseObject

  • parseObject(model: Model, objectPropertyInfoList: ParsedObjectPropertyInfo[], elementPropertyConstraints: ElementPropertyConstraint[], valueConstraints: ValueConstraint[], aggregateContext: AggregateContext, parsingErrors: ParsingError[], object: {}, parentId: string | undefined, definedIn: string | undefined, propName: string | undefined, dtmiSeg: string | undefined, keyProp: string | undefined, idRequired: boolean, typeRequired: boolean, allowIdReferenceSyntax: boolean, allowedVersions: Set<number>): any

Static parseToken

  • parseToken(model: Model, objectPropertyInfoList: ParsedObjectPropertyInfo[], elementPropertyConstraints: ElementPropertyConstraint[], valueConstraints: ValueConstraint[], aggregateContext: AggregateContext, parsingErrors: ParsingError[], token: any, parentId: string | undefined, definedIn: string | undefined, propName: string | undefined, dtmiSeg: string | undefined, keyProp: string | undefined, idRequired: boolean, typeRequired: boolean, allowIdReferenceSyntax: boolean, allowedVersions: Set<number>): number

Static parseTypeArray

  • parseTypeArray(tokenArr: any[], elementId: string, parentId: string | undefined, definedIn: string | undefined, propName: string | undefined, aggregateContext: AggregateContext, parsingErrors: ParsingError[]): PropertyInfo | undefined

Static tryParseTypeStringV2

  • tryParseTypeStringV2(typestring: string, elementId: string, parentId: string | undefined, definedIn: string | undefined, propName: string | undefined, materialKinds: EntityKinds[], supplementalTypeIds: string[], elementInfo: Reference<PropertyInfo>, undefinedTypes: string[], aggregateContext: AggregateContext, parsingErrors: ParsingError[]): boolean

Static tryParseTypeStringV3

  • tryParseTypeStringV3(typestring: string, elementId: string, parentId: string | undefined, definedIn: string | undefined, propName: string | undefined, materialKinds: EntityKinds[], supplementalTypeIds: string[], elementInfo: Reference<PropertyInfo>, undefinedTypes: string[], aggregateContext: AggregateContext, parsingErrors: ParsingError[]): boolean

Generated using TypeDoc