spinetoolbox.spine_db_editor.widgets.tabular_view_mixin

Contains TabularViewMixin class.

author

16. Vennström (VTT)

date

1.11.2018

Module Contents

Classes

TabularViewMixin

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

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

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

_PARAMETER_VALUE = &Value

_INDEX_EXPANSION = &Index

_RELATIONSHIP = Re&lationship

_SCENARIO_ALTERNATIVE = &Scenario

_PARAMETER = parameter

_ALTERNATIVE = alternative

_INDEX = index

populate_pivot_action_group(self)

connect_signals(self)

Connects signals to slots.

init_models(self)

Initializes models.

_set_model_data(self, index, value)

property current_object_class_id_list(self)

property current_object_class_name_list(self)

property current_object_class_ids(self)

static _is_class_index(index)

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

Parameters

index (QModelIndex) – index from object or relationship tree

Returns

bool

_handle_pivot_table_visibility_changed(self, visible)

_handle_frozen_table_visibility_changed(self, visible)

_handle_object_tree_selection_changed(self, selected_indexes)

_handle_relationship_tree_selection_changed(self, selected_indexes)

_handle_entity_tree_current_changed(self, current_index)

static _make_get_id(action)

Returns a function to compute the db_map-id tuple of an item.

_get_db_map_entities(self)

Returns a dict mapping db maps to a list of dict entity items in the current class.

Returns

dict

load_empty_relationship_data(self, db_map_class_objects=None)

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

Parameters

db_map_class_objects (dict) –

Returns

Key is db_map-object_id tuple, value is None.

Return type

dict

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

Returns a dict of relationships in the current class.

Parameters

db_map_relationships (dict) –

Returns

Key is db_map-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

load_scenario_alternative_data(self, db_map_scenarios=None, db_map_alternatives=None)

Returns a dict containing all scenario alternatives.

Returns

Key is db_map-id tuple, value is None or rank.

Return type

dict

_get_parameter_value_or_def_ids(self, item_type)

Returns a dict mapping db maps to a list of integer parameter (value or def) ids from the current class.

Parameters

item_type (str) – either “parameter_value” or “parameter_definition”

Returns

dict

_get_db_map_parameter_values_or_defs(self, item_type)

Returns a dict mapping db maps to list of dict parameter (value or def) items from the current class.

Parameters

item_type (str) – either “parameter_value” or “parameter_definition”

Returns

dict

load_empty_parameter_value_data(self, db_map_entities=None, db_map_parameter_ids=None, db_map_alternative_ids=None)

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

Parameters

• db_map_entities (dict, optional) – if given, only load data for these db maps and entities

• db_map_parameter_ids (dict, optional) – if given, only load data for these db maps and parameter definitions

• db_map_alternative_ids (dict, optional) – if given, only load data for these db maps and alternatives

Returns

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

Return type

dict

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

Returns a dict of parameter values for the current class.

Parameters

• db_map_parameter_values (list, optional) –

• action (str) –

Returns

Key is a tuple object_id, …, parameter_id, value is the parameter_value.

Return type

dict

_indexes(self, value)

load_empty_expanded_parameter_value_data(self, db_map_entities=None, db_map_parameter_ids=None, db_map_alternative_ids=None)

Makes a dict of expanded parameter values for the current class.

Parameters

• db_map_parameter_values (list, optional) –

• action (str) –

Returns

mapping from unique value id tuple to value tuple

Return type

dict

load_full_expanded_parameter_value_data(self, db_map_parameter_values=None, action='add')

Makes a dict of expanded parameter values for the current class.

Parameters

• db_map_parameter_values (list, optional) –

• action (str) –

Returns

mapping from unique value id tuple to value tuple

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

load_expanded_parameter_value_data(self)

Returns all permutations of entities as well as parameter indexes and values for the current class.

Returns

Key is a tuple object_id, …, index, while value is None.

Return type

dict

get_pivot_preferences(self)

Returns saved pivot preferences.

Returns

pivot tuple, or None if no preference stored

Return type

tuple, NoneType

reload_pivot_table(self, current_index=None)

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

static _get_current_class_item(current_index)

_handle_pivot_action_triggered(self, action)

do_reload_pivot_table(self)

Reloads pivot table.

_can_build_pivot_table(self)

clear_pivot_table(self)

wipe_out_filter_menus(self)

make_pivot_headers(self)

Turns top left indexes in the pivot table into TabularViewHeaderWidget.

_resize_pivot_header_columns(self)

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 (str) –

• 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)

update_filter_menus(self, 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_alternatives_added_or_removed(self, db_map_data, action)

receive_parameter_values_added_or_removed(self, db_map_data, action)

receive_scenarios_added_or_removed(self, db_map_data, action)

receive_db_map_data_updated(self, db_map_data, get_class_id)

receive_classes_updated(self, db_map_data)

receive_classes_removed(self, db_map_data)

receive_alternatives_added(self, db_map_data)

Reacts to alternatives added event.

receive_scenarios_added(self, db_map_data)

Reacts to scenarios added event.

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_alternatives_updated(self, db_map_data)

Reacts to alternatives updated event.

receive_object_classes_updated(self, db_map_data)

Reacts to object classes updated event.

receive_relationship_classes_updated(self, db_map_data)

Reacts to relationship classes updated event.

receive_objects_updated(self, db_map_data)

Reacts to objects 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_scenarios_updated(self, db_map_data)

receive_alternatives_removed(self, db_map_data)

Reacts to alternatives removed event.

receive_scenarios_removed(self, db_map_data)

Reacts to scenarios removed event.

receive_object_classes_removed(self, db_map_data)

Reacts to object classes removed event.

receive_relationship_classes_removed(self, db_map_data)

Reacts to relationship classes remove event.

receive_objects_removed(self, db_map_data)

Reacts to objects removed 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.