Class SingularAttribute<T>

Type Parameters

Hierarchy

Attribute<T>
- SingularAttribute

Index

Constructors

constructor

new SingularAttribute<T>(name: string, type: Type<T>, isMetadata?: boolean): SingularAttribute<T>
Type Parameters
- T
Parameters
- name: string
- type: Type<T>
- Optional isMetadata: boolean
  
  true if the attribute is an metadata attribute
Returns SingularAttribute<T>
Overrides Attribute.constructor
- Defined in lib/metamodel/SingularAttribute.ts:40

Properties

accessor

accessor: null | Accessor = null

declaringType

declaringType: null | ManagedType<any> = null

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

type

type: Type<T>

`Static` `Readonly` PersistentAttributeType

PersistentAttributeType: typeof PersistentAttributeType = PersistentAttributeType

Accessors

isAssociation

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

isCollection

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

persistentAttributeType

get persistentAttributeType(): BASIC | EMBEDDED | ONE_TO_MANY
Returns the persistent attribute type

Returns BASIC | EMBEDDED | ONE_TO_MANY
Overrides Attribute.persistentAttributeType
- Defined in lib/metamodel/SingularAttribute.ts:22

typeConstructor

get typeConstructor(): Class<T>
The constructor of the element type of this attribute

Returns Class<T>
- Defined in lib/metamodel/SingularAttribute.ts:15

Methods

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
Overrides Attribute.getJsonValue
- Defined in lib/metamodel/SingularAttribute.ts:48

getMetadata

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

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

getValue

getValue(entity: Managed): null | T
Returns
Parameters
- entity: Managed
Returns null | T
Inherited from Attribute.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 Attribute.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 Attribute.init
- Defined in lib/metamodel/Attribute.ts:115

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
Overrides Attribute.setJsonValue
- Defined in lib/metamodel/SingularAttribute.ts:68

setValue

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

toJSON

toJSON(): {
type: string;
}
Converts this attribute field to json

Returns
The attribute description as json

Returns {
type: string;
}
- type: string
Overrides Attribute.toJSON
- Defined in lib/metamodel/SingularAttribute.ts:83

`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 Attribute.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 Attribute.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 Attribute.attachState
- Defined in lib/metamodel/Attribute.ts:56

Class SingularAttribute<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

name: string

type: Type<T>

Optional isMetadata: boolean

Returns SingularAttribute<T>

Properties

accessor

declaringType

isAcl

isId

isMetadata

isVersion

metadata

name

order

type

Static Readonly PersistentAttributeType

Accessors

isAssociation

Returns boolean

isCollection

Returns boolean

persistentAttributeType

Returns BASIC | EMBEDDED | ONE_TO_MANY

typeConstructor

Returns Class<T>

Methods

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

setJsonValue

Returns

Parameters

state: ManagedState

object: Managed

jsonValue: Json

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

Optional onlyMetadata?: boolean

persisting: boolean

`Optional` isMetadata: boolean

`Static` `Readonly` PersistentAttributeType

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

`Optional` depth?: number | boolean

`Optional` excludeMetadata?: boolean

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

`Optional` onlyMetadata?: boolean

Returns {
type: string;
}

`Static` attachSize

`Optional` size: number

`Static` attachState

`Optional` overwriteExistingValue: boolean