spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models

Empty models for parameter definitions and values.

authors

13. Marin (KTH)

date

28.6.2019

Module Contents

Classes

EmptyParameterModel	An empty parameter model.
EmptyParameterDefinitionModel	An empty parameter_definition model.
EmptyObjectParameterDefinitionModel	An empty object parameter_definition model.
EmptyRelationshipParameterDefinitionModel	An empty relationship parameter_definition model.
EmptyParameterValueModel	An empty parameter_value model.
EmptyObjectParameterValueModel	An empty object parameter_value model.
EmptyRelationshipParameterValueModel	An empty relationship parameter_value model.

class spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models.EmptyParameterModel(parent, header, db_mngr)

Bases: spinetoolbox.mvcmodels.empty_row_model.EmptyRowModel

An empty parameter model.

Initialize class.

Parameters

• parent (Object) – the parent object, typically a CompoundParameterModel

• header (list) – list of field names for the header

• db_mngr (SpineDBManager) –

property item_type(self)

The item type, either ‘parameter_value’ or ‘parameter_definition’, required by the json_fields property.

property entity_class_type(self)

Either ‘object_class’ or ‘relationship_class’.

property entity_class_id_key(self)

property entity_class_name_key(self)

property can_be_filtered(self)

property json_fields(self)

accepted_rows(self)

db_item(self, _index)

item_id(self, _row)

flags(self, index)

Return default flags except if forcing defaults.

data(self, index, role=Qt.DisplayRole)

Returns the data stored under the given role for the item referred to by the index.

Parameters

• index (QModelIndex) – Index of item

• role (int) – Data role

Returns

Item data for given role.

_make_unique_id(self, item)

Returns a unique id for the given model item (name-based). Used by receive_parameter_data_added.

receive_parameter_data_added(self, db_map_data)

Runs when parameter definitions or values are added. Finds and removes model items that were successfully added to the db.

batch_set_data(self, indexes, data)

Sets data for indexes in batch. If successful, add items to db.

abstract add_items_to_db(self, db_map_data)

Add items to db.

Parameters

db_map_data (dict) – mapping DiffDatabaseMapping instance to list of items

_make_db_map_data(self, rows)

Returns model data grouped by database map.

Parameters

rows (set) – group data from these rows

Returns

mapping DiffDatabaseMapping instance to list of items

Return type

dict

class spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models.EmptyParameterDefinitionModel(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInValueListIdMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInEntityClassIdMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInParameterNameMixin, EmptyParameterModel

An empty parameter_definition model.

Initializes lookup dicts.

property item_type(self)

The item type, either ‘parameter_value’ or ‘parameter_definition’, required by the json_fields property.

property entity_class_type(self)

See base class.

add_items_to_db(self, db_map_data)

See base class.

_check_item(self, item)

Checks if a db item is ready to be inserted.

class spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models.EmptyObjectParameterDefinitionModel(*args, **kwargs)

Bases: EmptyParameterDefinitionModel

An empty object parameter_definition model.

Initializes lookup dicts.

property entity_class_type(self)

See base class.

class spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models.EmptyRelationshipParameterDefinitionModel(*args, **kwargs)

Bases: EmptyParameterDefinitionModel

An empty relationship parameter_definition model.

Initializes lookup dicts.

property entity_class_type(self)

See base class.

flags(self, index)

Additional hack to make the object_class_name_list column non-editable.

class spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models.EmptyParameterValueModel(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.ValidateValueInListForInsertMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.InferEntityClassIdMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInAlternativeIdMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInParameterDefinitionIdsMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInEntityIdsMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInEntityClassIdMixin, EmptyParameterModel

An empty parameter_value model.

Initializes lookup dicts.

property item_type(self)

The item type, either ‘parameter_value’ or ‘parameter_definition’, required by the json_fields property.

property entity_type(self)

Either ‘object’ or “relationship’.

property entity_id_key(self)

property entity_name_key(self)

property entity_name_key_in_cache(self)

_make_unique_id(self, item)

Returns a unique id for the given model item (name-based). Used by receive_parameter_data_added.

add_items_to_db(self, db_map_data)

See base class.

_check_item(self, db_map, item)

Checks if a db item is ready to be inserted.

class spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models.EmptyObjectParameterValueModel(*args, **kwargs)

Bases: EmptyParameterValueModel

An empty object parameter_value model.

Initializes lookup dicts.

property entity_class_type(self)

Either ‘object_class’ or ‘relationship_class’.

property entity_type(self)

Either ‘object’ or “relationship’.

class spinetoolbox.spine_db_editor.mvcmodels.empty_parameter_models.EmptyRelationshipParameterValueModel(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.MakeRelationshipOnTheFlyMixin, EmptyParameterValueModel

An empty relationship parameter_value model.

Initializes lookup dicts.

_add_entities_on_the_fly = True

property entity_class_type(self)

Either ‘object_class’ or ‘relationship_class’.

property entity_type(self)

Either ‘object’ or “relationship’.

add_items_to_db(self, db_map_data)

See base class.