Class DataObject

Data objects constitute the agnostic glue between objects and backends. They handle data and identifiers in a protected registry This is what backends and objects manipulate, oblivious of the other.

Hierarchy (View Summary)

DataObject
- PersistedDataObject

Implements

DataObjectType

Index

Constructors

`Protected`constructor

new DataObject(params: DataObjectParams | undefined): DataObject
Constructor is protected, use factory() instead
Parameters
- params: DataObjectParams | undefined
  object of parameters
Returns DataObject
- Defined in packages/core/src/components/DataObject.ts:43

Properties

`Protected`_modified

_modified: boolean = false

Has data been modified since last backend operation?

`Protected`_objectUri

_objectUri: ObjectUri

`Protected`_parentProp

_parentProp: string | undefined

`Protected`_populated

_populated: boolean = false

`Protected`_properties

_properties: Properties = {}

`Protected`_proxied

_proxied: any

`Protected`_uid

_uid: string | undefined = undefined

Accessors

class

get class(): any
Returns any
Implementation of DataObjectType.class
- Defined in packages/core/src/components/DataObject.ts:238

data

get data(): any
Returns any
- Defined in packages/core/src/components/DataObject.ts:223

parentProp

get parentProp(): string | undefined
Returns string | undefined
Implementation of DataObjectType.parentProp
- Defined in packages/core/src/components/DataObject.ts:243
set parentProp(str: string | undefined): void
Parameters
- str: string | undefined
Returns void
Implementation of DataObjectType.parentProp
- Defined in packages/core/src/components/DataObject.ts:246

path

get path(): string
Returns string
Implementation of DataObjectType.path
- Defined in packages/core/src/components/DataObject.ts:208

properties

get properties(): Properties
Returns Properties
Implementation of DataObjectType.properties
- Defined in packages/core/src/components/DataObject.ts:200

uid

get uid(): string | undefined
Returns string | undefined
Implementation of DataObjectType.uid
- Defined in packages/core/src/components/DataObject.ts:219
set uid(uid: string | undefined): void
Parameters
- uid: string | undefined
Returns void
Implementation of DataObjectType.uid
- Defined in packages/core/src/components/DataObject.ts:212

uri

get uri(): ObjectUri
Returns ObjectUri
Implementation of DataObjectType.uri
- Defined in packages/core/src/components/DataObject.ts:234
set uri(uri: ObjectUri): void
Parameters
- uri: ObjectUri
Returns void
Implementation of DataObjectType.uri
- Defined in packages/core/src/components/DataObject.ts:227

Methods

`Protected`_dataToJSON

_dataToJSON(
    objectsAsReferences?: boolean,
    ignoreUnchanged?: boolean,
    ignoreNulls?: boolean,
    converters?: {},
): {}
Parameters
- objectsAsReferences: boolean = false
- ignoreUnchanged: boolean = false
- ignoreNulls: boolean = false
- converters: {} = {}
Returns {}
- Defined in packages/core/src/components/DataObject.ts:349

`Protected`_init

_init(properties: any[]): void
Parameters
- properties: any[]
Returns void
- Defined in packages/core/src/components/DataObject.ts:60

addProperty

addProperty(property: PropertyClassType): void
Appends a new property definition instance to the registry dynamically.
Parameters
- property: PropertyClassType
  The instantiated Property element.
Returns void
Implementation of DataObjectType.addProperty
- Defined in packages/core/src/components/DataObject.ts:121

asProxy

asProxy(): DataObject
Wrap instance into proxy to get access to properties

Returns DataObject
Proxy
Implementation of DataObjectType.asProxy
- Defined in packages/core/src/components/DataObject.ts:70

clone

clone(data?: any): Promise<DataObject>
Returns a completely duplicated payload and registry.
Parameters
- data: any = {}
  Optional data overrides.
Returns Promise<DataObject>
The cloned DataObject.
Implementation of DataObjectType.clone
- Defined in packages/core/src/components/DataObject.ts:448

get

get(key: string): PropertyClassType
Returns property matching key or throw
Parameters
- key: string
  string
Returns PropertyClassType
BaseProperty
Implementation of DataObjectType.get
- Defined in packages/core/src/components/DataObject.ts:265

getProperties

getProperties(type?: string): {}
Return a map of all propoerties or only those matching the provided type
Parameters
- Optionaltype: string
Returns {}
Implementation of DataObjectType.getProperties
- Defined in packages/core/src/components/DataObject.ts:101

has

has(key: string): boolean
Checks if a specific property exists.
Parameters
- key: string
  The property name.
Returns boolean
Boolean indicating existence.
Implementation of DataObjectType.has
- Defined in packages/core/src/components/DataObject.ts:256

isPopulated

isPopulated(): boolean
State check indicating if the object is fully populated.

Returns boolean
true if populated.
Implementation of DataObjectType.isPopulated
- Defined in packages/core/src/components/DataObject.ts:196

populate

populate(
data?: { name: string; [x: string]: unknown } | undefined,
): Promise<DataObject>
Populate data object from instant data or backend query
Parameters
- data: { name: string; [x: string]: unknown } | undefined = undefined
Returns Promise<DataObject>
Implementation of DataObjectType.populate
- Defined in packages/core/src/components/DataObject.ts:132

populateFromData

populateFromData(data: { [x: string]: unknown }): this
Populate data object from instant data or backend query
Parameters
- data: { [x: string]: unknown }
Returns this
Implementation of DataObjectType.populateFromData
- Defined in packages/core/src/components/DataObject.ts:155

set

set(key: string, val: any): DataObject
Modifies a property value directly.
Parameters
- key: string
  The property name.
- val: any
  The desired value.
Returns DataObject
The updated DataObject for chaining.
Implementation of DataObjectType.set
- Defined in packages/core/src/components/DataObject.ts:279

setProperties

setProperties(properties: Properties): void
Forces a completely new set of properties into the registry.
Parameters
- properties: Properties
  The dictionary of PropertyClassType entities.
Returns void
Implementation of DataObjectType.setProperties
- Defined in packages/core/src/components/DataObject.ts:91

toJSON

toJSON(params?: boolean | toJSONParams): { [x: string]: any }
Serializes the data object using advanced configuration params.
Parameters
- params: boolean | toJSONParams = false
  Serialization settings (e.g. resolve references, remove nulls).
Returns { [x: string]: any }
The raw serialized dictionary.
Implementation of DataObjectType.toJSON
- Defined in packages/core/src/components/DataObject.ts:309

toReference

toReference(): { label: any; ref: string; uri: string }
Flattens the object to a standard ObjectUri wrapper reference format.

Returns { label: any; ref: string; uri: string }
Reference object format.
Implementation of DataObjectType.toReference
- Defined in packages/core/src/components/DataObject.ts:342

val

val(key: string, transform?: string | undefined): any
Get value of given property
Parameters
- key: string
  string
- transform: string | undefined = undefined
Returns any
any
Implementation of DataObjectType.val
- Defined in packages/core/src/components/DataObject.ts:295

`Static`factory

factory(param?: DataObjectParams | undefined): DataObject
Data object must be created from factory in order for async-loaded data to be available
Parameters
- param: DataObjectParams | undefined = undefined
Returns DataObject
DataObject
- Defined in packages/core/src/components/DataObject.ts:431

Class DataObject

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns DataObject

Properties

Protected_modified

Protected_objectUri

Protected_parentProp

Protected_populated

Protected_properties

Protected_proxied

Protected_uid

Accessors

class

Returns any

data

Returns any

parentProp

Returns string | undefined

Parameters

Returns void

path

Returns string

properties

Returns Properties

uid

Returns string | undefined

Parameters

Returns void

uri

Returns ObjectUri

Parameters

Returns void

Methods

Protected_dataToJSON

Parameters

Returns {}

Protected_init

Parameters

Returns void

addProperty

Parameters

Returns void

asProxy

Returns DataObject

clone

Parameters

Returns Promise<DataObject>

get

Parameters

Returns PropertyClassType

getProperties

Parameters

Returns {}

has

Parameters

Returns boolean

isPopulated

Returns boolean

populate

Parameters

Returns Promise<DataObject>

populateFromData

Parameters

Returns this

set

Parameters

Returns DataObject

setProperties

Parameters

Returns void

toJSON

`Protected`constructor

`Protected`_modified

`Protected`_objectUri

`Protected`_parentProp

`Protected`_populated

`Protected`_properties

`Protected`_proxied

`Protected`_uid

`Protected`_dataToJSON

`Protected`_init

`Static`factory