spinetoolbox.widgets.tabular_view_mixin

Contains TabularViewMixin class.

author:

16. Vennström (VTT)

date:

1.11.2018

Module Contents

class spinetoolbox.widgets.tabular_view_mixin.TabularViewMixin(*args, **kwargs)

Provides the pivot table and its frozen table for the DS form.

_PARAMETER_VALUE = Parameter value

_RELATIONSHIP = Relationship

_PARAMETER = parameter

_PARAM_INDEX_ID

setup_delegates(self)

Sets delegates for tables.

add_menu_actions(self)

Adds toggle view actions to View menu.

connect_signals(self)

Connects signals to slots.

init_models(self)

Initializes models.

_handle_pivot_table_selection_changed(self, selected, deselected)

Accepts selection.

is_value_input_type(self)

_set_model_data(self, index, value)

current_object_class_id_list(self)

current_object_class_name_list(self)

static _is_class_index(index, class_type)

Returns whether or not the given tree index is a class index.

Parameters:

• index (QModelIndex) – index from object or relationship tree
• class_type (str) –

Returns:

bool

_handle_pivot_table_visibility_changed(self, visible)

_handle_frozen_table_visibility_changed(self, visible)

_handle_entity_tree_selection_changed(self, selected, deselected)

_get_entities(self, class_id=None, class_type=None)

Returns a list of dict items from the object or relationship tree model corresponding to the given class id.

Parameters:

• class_id (int) –
• class_type (str) –

Returns:

list(dict)

load_empty_relationship_data(self, objects_per_class=None)

Returns a dict containing all possible relationships in the current class.

Parameters:objects_per_class (dict) – Returns:Key is object id tuple, value is None. Return type:dict

load_full_relationship_data(self, relationships=None, action='add')

Returns a dict of relationships in the current class.

Returns:Key is object id tuple, value is relationship id. Return type:dict

load_relationship_data(self)

Returns a dict that merges empty and full relationship data.

Returns:Key is object id tuple, value is True if a relationship exists, False otherwise. Return type:dict

_get_parameter_value_or_def_ids(self, item_type)

Returns a set of integer ids from the parameter model corresponding to the currently selected class and the given item type.

Parameters:item_type (str) – either “parameter value” or “parameter definition” Returns:set(int)

_get_parameter_values_or_defs(self, item_type)

Returns a list of dict items from the parameter model corresponding to the currently selected class and the given item type.

Parameters:item_type (str) – either “parameter value” or “parameter definition” Returns:list(dict)

load_empty_parameter_value_data(self, entities=None, parameter_ids=None)

Returns a dict containing all possible combinations of entities and parameters for the current class.

Parameters:

• entities (list, optional) – if given, only load data for these entities
• parameter_ids (set, optional) – if given, only load data for these parameter definitions

Returns:

Key is a tuple object_id, …, parameter_id, value is None.

Return type:

dict

load_full_parameter_value_data(self, parameter_values=None, action='add')

Returns a dict of parameter values for the current class.

Parameters:parameter_values (list, optional) – Returns:Key is a tuple object_id, …, parameter_id, value is the parameter value. Return type:dict

load_parameter_value_data(self)

Returns a dict that merges empty and full parameter value data.

Returns:Key is a tuple object_id, …, parameter_id, value is the parameter value or None if not specified. Return type:dict

get_pivot_preferences(self, selection_key)

Returns saved or default pivot preferences.

Parameters:selection_key (tuple(int,str,str)) – Tuple of class id, class type, and input type.

Returns

list: indexes in rows list: indexes in columns list: frozen indexes tuple: selection in frozen table

reload_pivot_table(self, text='')

Updates current class (type and id) and reloads pivot table for it.

do_reload_pivot_table(self)

Reloads pivot table.

clear_pivot_table(self)

wipe_out_filter_menus(self)

make_pivot_headers(self)

Turns top left indexes in the pivot table into TabularViewHeaderWidget.

make_frozen_headers(self)

Turns indexes in the first row of the frozen table into TabularViewHeaderWidget.

create_filter_menu(self, identifier)

Returns a filter menu for given given object class identifier.

Parameters:identifier (int) – Returns:TabularViewFilterMenu

create_header_widget(self, identifier, area, with_menu=True)

Returns a TabularViewHeaderWidget for given object class identifier.

Parameters:

• identifier (int) –
• area (str) –
• with_menu (bool) –

Returns:

TabularViewHeaderWidget

static _get_insert_index(pivot_list, catcher, position)

Returns an index for inserting a new element in the given pivot list.

Returns:int

handle_header_dropped(self, dropped, catcher, position='')

Updates pivots when a header is dropped.

Parameters:

• dropped (TabularViewHeaderWidget) –
• catcher (TabularViewHeaderWidget, PivotTableHeaderView, FrozenTableView) –
• position (str) – either “before”, “after”, or “”

get_frozen_value(self, index)

Returns the value in the frozen table corresponding to the given index.

Parameters:index (QModelIndex) – Returns:tuple

change_frozen_value(self, current, previous)

Sets the frozen value from selection in frozen table.

change_filter(self, identifier, valid_values, has_filter)

reload_frozen_table(self)

Resets the frozen model according to new selection in entity trees.

find_frozen_values(self, frozen)

Returns a list of tuples containing unique values (object ids) for the frozen indexes (object class ids).

Parameters:frozen (tuple(int)) – A tuple of currently frozen indexes Returns:list(tuple(list(int)))

static refresh_table_view(table_view)

static _group_by_class(items, get_class_id)

receive_data_added_or_removed(self, data, action)

receive_objects_added_or_removed(self, db_map_data, action)

receive_relationships_added_or_removed(self, db_map_data, action)

receive_parameter_definitions_added_or_removed(self, db_map_data, action)

receive_parameter_values_added_or_removed(self, db_map_data, action)

receive_db_map_data_updated(self, db_map_data, get_class_id)

receive_classes_removed(self, db_map_data)

receive_objects_added(self, db_map_data)

Reacts to objects added event.

receive_relationships_added(self, db_map_data)

Reacts to relationships added event.

receive_parameter_definitions_added(self, db_map_data)

Reacts to parameter definitions added event.

receive_parameter_values_added(self, db_map_data)

Reacts to parameter values added event.

receive_object_classes_updated(self, db_map_data)

Reacts to object classes updated event.

receive_objects_updated(self, db_map_data)

Reacts to objects updated event.

receive_relationship_classes_updated(self, db_map_data)

Reacts to relationship classes updated event.

receive_relationships_updated(self, db_map_data)

Reacts to relationships updated event.

receive_parameter_values_updated(self, db_map_data)

Reacts to parameter values added event.

receive_parameter_definitions_updated(self, db_map_data)

Reacts to parameter definitions updated event.

receive_object_classes_removed(self, db_map_data)

Reacts to object classes removed event.

receive_objects_removed(self, db_map_data)

Reacts to objects removed event.

receive_relationship_classes_removed(self, db_map_data)

Reacts to relationship classes remove event.

receive_relationships_removed(self, db_map_data)

Reacts to relationships removed event.

receive_parameter_definitions_removed(self, db_map_data)

Reacts to parameter definitions removed event.

receive_parameter_values_removed(self, db_map_data)

Reacts to parameter values removed event.

receive_session_rolled_back(self, db_maps)

Reacts to session rolled back event.