spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models

Single models for parameter definitions and values (as ‘for a single entity’).

authors

13. Marin (KTH)

date

28.6.2019

Module Contents

Classes

SingleParameterModel	A parameter model for a single entity_class to go in a CompoundParameterModel.
SingleObjectParameterMixin	Associates a parameter model with a single object_class.
SingleRelationshipParameterMixin	Associates a parameter model with a single relationship_class.
SingleParameterDefinitionMixin	A parameter_definition model for a single entity_class.
SingleParameterValueMixin	A parameter_value model for a single entity_class.
SingleObjectParameterDefinitionModel	An object parameter_definition model for a single object_class.
SingleRelationshipParameterDefinitionModel	A relationship parameter_definition model for a single relationship_class.
SingleObjectParameterValueModel	An object parameter_value model for a single object_class.
SingleRelationshipParameterValueModel	A relationship parameter_value model for a single relationship_class.

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleParameterModel(header, db_mngr, db_map, entity_class_id, lazy=False)

Bases: spinetoolbox.mvcmodels.minimal_table_model.MinimalTableModel

A parameter model for a single entity_class to go in a CompoundParameterModel. Provides methods to associate the model to an entity_class as well as to filter entities within the class.

Init class.

Parameters

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

property item_type(self)

The item type, either ‘parameter_value’ or ‘parameter_definition’, required by the data method.

property entity_class_type(self)

The entity_class type, either ‘object_class’ or ‘relationship_class’.

property entity_class_name_field(self)

property entity_class_name(self)

property entity_class_id_key(self)

property json_fields(self)

property fixed_fields(self)

property group_fields(self)

property parameter_definition_id_key(self)

property can_be_filtered(self)

insertRows(self, row, count, parent=QModelIndex())

This model doesn’t support row insertion.

item_id(self, row)

db_item(self, index)

_db_item(self, row)

db_item_from_id(self, id_)

db_items(self)

flags(self, index)

Make fixed indexes non-editable.

get_field_item_data(self, field)

Returns item data for given field.

Parameters

field (str) – A field from the header

Returns

str, str

get_id_key(self, field)

get_field_item(self, field, db_item)

Returns a db item corresponding to the given field from the table header, or an empty dict if the field doesn’t contain db items.

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

Gets the id and database for the row, and reads data from the db manager using the item_type property. Paint the object_class icon next to the name. Also paint background of fixed indexes gray and apply custom format to JSON fields.

batch_set_data(self, indexes, data)

Sets data for indexes in batch. Sets data directly in database using db mngr. If successful, updated data will be automatically seen by the data method.

abstract update_items_in_db(self, items)

Update items in db. Required by batch_set_data

set_filter_parameter_ids(self, parameter_ids)

_filter_accepts_row(self, row)

_parameter_filter_accepts_row(self, row)

Returns the result of the parameter filter.

_auto_filter_accepts_row(self, row)

Returns the result of the auto filter.

accepted_rows(self)

Returns a list of accepted rows, for convenience.

_get_field_item(self, field, id_)

Returns a item from the db_mngr.get_item depending on the field. If a field doesn’t correspond to a item in the database then an empty dict is returned.

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleObjectParameterMixin

Associates a parameter model with a single object_class.

property entity_class_type(self)

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleRelationshipParameterMixin

Associates a parameter model with a single relationship_class.

property entity_class_type(self)

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleParameterDefinitionMixin(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInParameterNameMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInValueListIdMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.MakeParameterTagMixin

A parameter_definition model for a single entity_class.

Initializes lookup dicts.

property item_type(self)

update_items_in_db(self, items)

Update items in db.

Parameters

item (list) – dictionary-items

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleParameterValueMixin(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.ValidateValueInListForUpdateMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInAlternativeIdMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.ImposeEntityClassIdMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInParameterDefinitionIdsMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.FillInEntityIdsMixin

A parameter_value model for a single entity_class.

Initializes lookup dicts.

property item_type(self)

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)

set_filter_entity_ids(self, db_map_class_entity_ids)

set_filter_alternative_ids(self, db_map_alternative_ids)

_filter_accepts_row(self, row)

Reimplemented to also account for the entity filter.

_entity_filter_accepts_row(self, row)

Returns the result of the entity filter.

_alternative_filter_accepts_row(self, row)

Returns the result of the alternative filter.

update_items_in_db(self, items)

Update items in db.

Parameters

item (list) – dictionary-items

_check_item(self, item)

Checks if a db item is good to be updated.

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleObjectParameterDefinitionModel(*args, **kwargs)

Bases: SingleObjectParameterMixin, SingleParameterDefinitionMixin, SingleParameterModel

An object parameter_definition model for a single object_class.

Initializes lookup dicts.

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleRelationshipParameterDefinitionModel(*args, **kwargs)

Bases: SingleRelationshipParameterMixin, SingleParameterDefinitionMixin, SingleParameterModel

A relationship parameter_definition model for a single relationship_class.

Initializes lookup dicts.

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleObjectParameterValueModel(*args, **kwargs)

Bases: SingleObjectParameterMixin, SingleParameterValueMixin, SingleParameterModel

An object parameter_value model for a single object_class.

Initializes lookup dicts.

property entity_type(self)

Either ‘object’ or “relationship’.

class spinetoolbox.spine_db_editor.mvcmodels.single_parameter_models.SingleRelationshipParameterValueModel(*args, **kwargs)

Bases: SingleRelationshipParameterMixin, spinetoolbox.spine_db_editor.mvcmodels.parameter_mixins.MakeRelationshipOnTheFlyMixin, SingleParameterValueMixin, SingleParameterModel

A relationship parameter_value model for a single relationship_class.

Initializes lookup dicts.

property entity_type(self)

Either ‘object’ or “relationship’.

update_items_in_db(self, items)

Update items in db.

Parameters

item (list) – dictionary-items