Class CollectionAttribute<T, E>`Abstract`

Type Parameters

Hierarchy

PluralAttribute<T, E>
- CollectionAttribute

Index

Constructors

Constructors

`Protected` constructor

new CollectionAttribute<T, E>(name: string, typeConstructor: Class<T>, elementType: Type<E>): CollectionAttribute<T, E>
Type Parameters
- T
- E
Parameters
- name: string
  
  the name of the attribute
- typeConstructor: Class<T>
  
  The collection constructor of the attribute
- elementType: Type<E>
  
  The element type of the collection
Returns CollectionAttribute<T, E>
Overrides PluralAttribute.constructor
- Defined in lib/metamodel/CollectionAttribute.ts:18

Properties

accessor

accessor: null | Accessor = null

declaringType

declaringType: null | ManagedType<any> = null

elementType

elementType: Type<E>

isAcl

isAcl: boolean = false

isId

isId: boolean = false

isMetadata

isMetadata: boolean

isVersion

isVersion: boolean = false

metadata

metadata: null | {
[name: string]: string;
} = null

name

name: string

order

order: null | number = null

typeConstructor

typeConstructor: Class<T>

`Static` `Readonly` CollectionType

CollectionType: typeof CollectionType = CollectionType

`Static` `Readonly` PersistentAttributeType

PersistentAttributeType: typeof PersistentAttributeType = PersistentAttributeType

Accessors

collectionType

get collectionType(): CollectionType
Returns the collection attribute type

Returns CollectionType
Overrides PluralAttribute.collectionType
- Defined in lib/metamodel/CollectionAttribute.ts:9

isAssociation

get isAssociation(): boolean
Returns boolean
Inherited from PluralAttribute.isAssociation
- Defined in lib/metamodel/Attribute.ts:93

isCollection

get isCollection(): boolean
Returns boolean
Inherited from PluralAttribute.isCollection
- Defined in lib/metamodel/Attribute.ts:97

persistentAttributeType

get persistentAttributeType(): PersistentAttributeType
Returns the persistent attribute type

Returns PersistentAttributeType
Inherited from PluralAttribute.persistentAttributeType
- Defined in lib/metamodel/PluralAttribute.ts:27

Methods

`Abstract` getJsonValue

getJsonValue(state: ManagedState, object: Managed, options: {
    depth?: number | boolean;
    excludeMetadata?: boolean;
    persisting: boolean;
}): undefined | Json
Gets this attribute value form the object as json

Returns
The converted json value
Parameters
- state: ManagedState
  
  The root object state
- object: Managed
  
  The object which contains the value of this attribute
- options: {
      depth?: number | boolean;
      excludeMetadata?: boolean;
      persisting: boolean;
  }
  
  additional options which are applied through the conversion
  - Optional depth?: number | boolean
  - Optional excludeMetadata?: boolean
  - persisting: boolean
Returns undefined | Json
Inherited from PluralAttribute.getJsonValue
- Defined in lib/metamodel/Attribute.ts:172

getMetadata

getMetadata(key: string): null | string
Gets some metadata of this type

Returns
Parameters
- key: string
Returns null | string
Inherited from PluralAttribute.getMetadata
- Defined in lib/metamodel/Attribute.ts:157

getValue

getValue(entity: Managed): null | T
Returns
Parameters
- entity: Managed
Returns null | T
Inherited from PluralAttribute.getValue
- Defined in lib/metamodel/Attribute.ts:129

hasMetadata

hasMetadata(key: string): boolean
Retrieves whether this type has specific metadata

Returns
Parameters
- key: string
Returns boolean
Inherited from PluralAttribute.hasMetadata
- Defined in lib/metamodel/Attribute.ts:147

init

init(declaringType: ManagedType<any>, order: number): void
Returns
Parameters
- declaringType: ManagedType<any>
  
  The type that owns this attribute
- order: number
  
  Position of the attribute
Returns void
Inherited from PluralAttribute.init
- Defined in lib/metamodel/Attribute.ts:115

`Protected` keyValue

keyValue(json: Json): string
Retrieves a serialized string value of the given json which can be used as object keys

Returns
A serialized version of the json
Parameters
- json: Json
  
  The json of which the key should be retrieved
Returns string
Inherited from PluralAttribute.keyValue
- Defined in lib/metamodel/PluralAttribute.ts:47

`Abstract` setJsonValue

setJsonValue(state: ManagedState, object: Managed, jsonValue: Json, options: {
onlyMetadata?: boolean;
persisting: boolean;
}): void
Sets this attribute value from json to the object

Returns
Parameters
- state: ManagedState
  
  The root state
- object: Managed
  
  The object which contains the attribute
- jsonValue: Json
  
  The json value to convert an set
- options: {
  onlyMetadata?: boolean;
  persisting: boolean;
  }
  
  additional options which are applied through the conversion
  - Optional onlyMetadata?: boolean
  - persisting: boolean
Returns void
Inherited from PluralAttribute.setJsonValue
- Defined in lib/metamodel/Attribute.ts:183

setValue

setValue(entity: Managed, value: null | T): void
Parameters
- entity: Managed
- value: null | T
Returns void
Inherited from PluralAttribute.setValue
- Defined in lib/metamodel/Attribute.ts:137

toJSON

toJSON(): JsonMap
Converts this attribute field to json

Returns
The attribute description as json

Returns JsonMap
Inherited from PluralAttribute.toJSON
- Defined in lib/metamodel/Attribute.ts:190

`Static` attachSize

attachSize(collection: Map<any, any> | Set<any>, size?: number): number
Attach and returns the the given size on the collection, in a meaner that it isn't enumerable

Returns
The actual or new attached size whenever a new size was provided or not
Parameters
- collection: Map<any, any> | Set<any>
  
  The collection where the size is attached on
- Optional size: number
  
  The size which should be attached, the previously attached size will be returned if omitted
Returns number
Inherited from PluralAttribute.attachSize
- Defined in lib/metamodel/Attribute.ts:74

`Static` attachState

attachState<T>(obj: any[] | Map<any, any> | Set<any> | Managed, state: T, overwriteExistingValue?: boolean): T
Attach and returns the attached state of the given object or collection

Returns
The actual or new attached state whenever an existing state was found
Type Parameters
- T
Parameters
- obj: any[] | Map<any, any> | Set<any> | Managed
  
  The object or collection on which the state is attached
- state: T
  
  The new state which should be attached to the object
- Optional overwriteExistingValue: boolean
  
  If true, overwrites any existing attached state with the given new state, if false any previously attached state will kept and will be returned instead
Returns T
Inherited from PluralAttribute.attachState
- Defined in lib/metamodel/Attribute.ts:48
attachState<T>(obj: any[] | Map<any, any> | Set<any> | Managed): undefined | T
Retrieves the attached state of the given object or collection

Returns
The actual attached state or undefined if no previous state was attached
Type Parameters
- T
Parameters
- obj: any[] | Map<any, any> | Set<any> | Managed
  
  The object or collection on which the state is attached
Returns undefined | T
Inherited from PluralAttribute.attachState
- Defined in lib/metamodel/Attribute.ts:56

Class CollectionAttribute<T, E>Abstract

Type Parameters

T

E

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

T

E

Parameters

name: string

typeConstructor: Class<T>

elementType: Type<E>

Returns CollectionAttribute<T, E>

Properties

accessor

declaringType

elementType

isAcl

isId

isMetadata

isVersion

metadata

name

order

typeConstructor

Static Readonly CollectionType

Static Readonly PersistentAttributeType

Accessors

collectionType

Returns CollectionType

isAssociation

Returns boolean

isCollection

Returns boolean

persistentAttributeType

Returns PersistentAttributeType

Methods

Abstract getJsonValue

Returns

Parameters

state: ManagedState

object: Managed

options: { depth?: number | boolean; excludeMetadata?: boolean; persisting: boolean; }

Optional depth?: number | boolean

Optional excludeMetadata?: boolean

persisting: boolean

Returns undefined | Json

getMetadata

Returns

Parameters

key: string

Returns null | string

getValue

Returns

Parameters

entity: Managed

Returns null | T

hasMetadata

Returns

Parameters

key: string

Returns boolean

init

Returns

Parameters

declaringType: ManagedType<any>

order: number

Returns void

Protected keyValue

Returns

Parameters

json: Json

Returns string

Class CollectionAttribute<T, E>`Abstract`

`Protected` constructor

`Static` `Readonly` CollectionType

`Static` `Readonly` PersistentAttributeType

`Abstract` getJsonValue

options: {
depth?: number | boolean;
excludeMetadata?: boolean;
persisting: boolean;
}

`Optional` depth?: number | boolean

`Optional` excludeMetadata?: boolean

`Protected` keyValue

`Abstract` setJsonValue

options: {
onlyMetadata?: boolean;
persisting: boolean;
}

`Optional` onlyMetadata?: boolean

`Static` attachSize

`Optional` size: number

`Static` attachState

`Optional` overwriteExistingValue: boolean