spinetoolbox.spine_db_editor.mvcmodels.single_models

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

Module Contents

Classes

HalfSortedTableModel	Table model for outlining simple tabular data.
SingleModelBase	Base class for all single models that go in a CompoundModelBase subclass.
FilterEntityAlternativeMixin	Provides the interface to filter by entity and alternative.
ParameterMixin	Provides the data method for parameter values and definitions.
EntityMixin
SingleParameterDefinitionModel	A parameter_definition model for a single entity_class.
SingleParameterValueModel	A parameter_value model for a single entity_class.
SingleEntityAlternativeModel	An entity_alternative model for a single entity_class.

class spinetoolbox.spine_db_editor.mvcmodels.single_models.HalfSortedTableModel(parent=None, header=None, lazy=True)

Bases: spinetoolbox.mvcmodels.minimal_table_model.MinimalTableModel

Table model for outlining simple tabular data.

Parameters

• parent (QObject, optional) – the parent object

• header (list of str) – header labels

• lazy (boolean) – if True, fetches data lazily

reset_model(main_data=None)

Reset model.

add_rows(data)

_sort_key(element)

class spinetoolbox.spine_db_editor.mvcmodels.single_models.SingleModelBase(parent, db_map, entity_class_id, committed, lazy=False)

Bases: HalfSortedTableModel

Base class for all single models that go in a CompoundModelBase subclass.

Parameters

• parent (CompoundModelBase) – the parent model

• db_map (DatabaseMapping) –

• entity_class_id (int) –

• committed (bool) –

abstract property item_type

The DB item type, required by the data method.

property field_map

abstract property _references

property entity_class_name

property dimension_id_list

property fixed_fields

property group_fields

property can_be_filtered

__lt__(other)

update_items_in_db(items)

Update items in db. Required by batch_set_data

_mapped_field(field)

item_id(row)

Returns parameter id for row.

Parameters

row (int) – row index

Returns

parameter id

Return type

int

item_ids()

Returns model’s parameter ids.

Returns

ids

Return type

set of int

db_item(index)

_db_item(row)

db_item_from_id(id_)

db_items()

flags(index)

Make fixed indexes non-editable.

_filter_accepts_row(row)

filter_accepts_item(item)

set_auto_filter(field, values)

_auto_filter_accepts_item(item)

Returns the result of the auto filter.

accepted_rows()

Yields accepted rows, for convenience.

_get_ref(db_item, field)

Returns the item referred by the given field.

data(index, role=Qt.ItemDataRole.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.

batch_set_data(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.

class spinetoolbox.spine_db_editor.mvcmodels.single_models.FilterEntityAlternativeMixin(*args, **kwargs)

Provides the interface to filter by entity and alternative.

set_filter_entity_ids(db_map_class_entity_ids)

set_filter_alternative_ids(db_map_alternative_ids)

filter_accepts_item(item)

Reimplemented to also account for the entity and alternative filter.

_entity_filter_accepts_item(item)

Returns the result of the entity filter.

_alternative_filter_accepts_item(item)

Returns the result of the alternative filter.

class spinetoolbox.spine_db_editor.mvcmodels.single_models.ParameterMixin

Provides the data method for parameter values and definitions.

property value_field

property parameter_definition_id_key

property _references

data(index, role=Qt.ItemDataRole.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.

class spinetoolbox.spine_db_editor.mvcmodels.single_models.EntityMixin

update_items_in_db(items)

Overriden to create entities on the fly first.

abstract _do_update_items_in_db(db_map_data)

class spinetoolbox.spine_db_editor.mvcmodels.single_models.SingleParameterDefinitionModel(parent, db_map, entity_class_id, committed, lazy=False)

Bases: spinetoolbox.spine_db_editor.mvcmodels.single_and_empty_model_mixins.SplitValueAndTypeMixin, ParameterMixin, SingleModelBase

A parameter_definition model for a single entity_class.

Parameters

• parent (CompoundModelBase) – the parent model

• db_map (DatabaseMapping) –

• entity_class_id (int) –

• committed (bool) –

property item_type

The DB item type, required by the data method.

_sort_key(element)

_do_update_items_in_db(db_map_data)

class spinetoolbox.spine_db_editor.mvcmodels.single_models.SingleParameterValueModel(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.single_and_empty_model_mixins.MakeEntityOnTheFlyMixin, spinetoolbox.spine_db_editor.mvcmodels.single_and_empty_model_mixins.SplitValueAndTypeMixin, ParameterMixin, EntityMixin, FilterEntityAlternativeMixin, SingleModelBase

A parameter_value model for a single entity_class.

property item_type

The DB item type, required by the data method.

_sort_key(element)

_do_update_items_in_db(db_map_data)

class spinetoolbox.spine_db_editor.mvcmodels.single_models.SingleEntityAlternativeModel(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.single_and_empty_model_mixins.MakeEntityOnTheFlyMixin, EntityMixin, FilterEntityAlternativeMixin, SingleModelBase

An entity_alternative model for a single entity_class.

property item_type

The DB item type, required by the data method.

property _references

_sort_key(element)

_do_update_items_in_db(db_map_data)