import DataModel from 'devapt-core-common/js/datas/data_model.js'

public class | source

DataModel

Extends:

DataRecord → DataModel

DataModel class.

Example:

	API:
		->constructor(arg_attributes)

		->get_collection():DataCollection
		
		->set(arg_attribute_name, arg_attribute_value):boolean - set an attribute value.
		->get(arg_attribute_name):any - get an attribute value.
		->get_id():string - get id attribute value.

		->save():Promise - save all changed attributes to the collection store.
		->rollback():boolean - disguard any unsaved changed attributes.
		->remove():Promise - remove record from collection store.
		->reload():Promise - restore attributes from collection store.


	USAGE ON BROWSER:
		class Cars extends DataModel {
			constructor(arg_attributes) {
				const ds = ... // get data store
				super(ds.get_collection('cars'), undefined, arg_attributes)
			}
		}
		var cars = new Cars( { engine:"fuel", color:"blue"} )

Constructor Summary

Public Constructor
public	constructor(arg_data_collection: DataCollection, arg_id: string \| undefined, arg_attributes: object \| Immutable.Map \| undefined): nothing DataModel class inherits from DataRecord and aims to provide a high level API for sub-classes.

Member Summary

Public Members
public	is_data_model: boolean Class type flag.

Inherited Summary

From class DataRecord
public	is_data_record: boolean Class type flag.
private	_attributes: object Record attributes map.
private	_collection: DataCollection Datas collection instance.
private	_dirty_attributes: array Record dirty attributes names.
private	_has_dirty_attributes: boolean Record has dirty attributes values flag.
private	_id: string Record unique identifier.
private	_id_field_name: string Record identifier field name.
private	_is_new: boolean Record is a new created record flag.
private	_previous_attributes: Map Record dirty attributes map.
public	clear(): boolean Clear all attributes values with default values.
public	deserialize(arg_serialized: stirng): boolean Transform attributes string to an object.
public	fill(-: arg_datas): boolean Fill all attributes values with given datas.
public	get(arg_attribute_path: string \| array): any \| undefined Get an attribute value.
public	get_attributes(): Immutable.Map Get record attributes.
public	get_attributes_object(): object Get record attributes.
public	get_collection(): DataCollection Get record collection.
public	get_fields_names(): array Get record fields names.
public	get_id(): string Get record id.
public	get_id_field_name(): string Get record id field name.
public	get_model(): DataModel Get record model.
public	get_type(): string Get record type.
public	reload(): Promise Reload record from collection store.
public	remove(): Promise Delete record from collection store.
public	rollback(): Promise Disguard all dirty attributes values.
public	save(): Promise Save all attributes values to the collection store.
public	serialize(): string Transform attributes to a string.
public	set(arg_attribute_path: string \| array, arg_attribute_value: any): boolean Set an attribute value.
public	set_attributes(arg_attributes: object \| Immutable.Map): nothing Set record attributes and normalize with schema.
public	set_removed(): nothing Set record as removed.
private	_check_attribute(arg_attribute_name: string, arg_attribute_value: any): boolean Check attribute name and value against model schema.
private	_emit(arg_event: string, arg_datas: any): nothing Emit on event.

Public Constructors

public constructor(arg_data_collection: DataCollection, arg_id: string | undefined, arg_attributes: object | Immutable.Map | undefined): nothing source

DataModel class inherits from DataRecord and aims to provide a high level API for sub-classes.

Override:

DataRecord#constructor

Params:

Name	Type	Attribute	Description
arg_data_collection	DataCollection		data collection: contains schema (mandatory).
arg_id	string \| undefined		data id, unique in collection (optional).
arg_attributes	object \| Immutable.Map \| undefined		initial datas values (optional).

DataModel

Extends:

Example:

Constructor Summary

Member Summary

Inherited Summary

Public Constructors

public constructor(arg_data_collection: DataCollection, arg_id: string | undefined, arg_attributes: object | Immutable.Map | undefined): nothing source

Override:

Params:

Return:

Public Members

public is_data_model: boolean source