spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models

Provides pivot table models for the Tabular View.

author:

16. Vennström (VTT)

date:

1.11.2018

Module Contents

Classes

PivotTableModelBase	param parent:
TopLeftHeaderItem	Base class for all ‘top left pivot headers’.
TopLeftObjectHeaderItem	A top left header for object_class.
TopLeftParameterHeaderItem	A top left header for parameter_definition.
TopLeftParameterIndexHeaderItem	A top left header for parameter index.
TopLeftAlternativeHeaderItem	A top left header for parameter index.
ParameterValuePivotTableModel	A model for the pivot table in parameter_value input type.
IndexExpansionPivotTableModel	A model for the pivot table in parameter index expansion input type.
RelationshipPivotTableModel	A model for the pivot table in relationship input type.
PivotTableSortFilterProxy	Initialize class.

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.PivotTableModelBase(parent)

Bases: PySide2.QtCore.QAbstractTableModel

Parameters:parent (SpineDBEditor) –

_V_HEADER_WIDTH = 5

_FETCH_STEP_COUNT = 64

_MIN_FETCH_COUNT = 512

_FETCH_DELAY = 0

item_type

Returns the item type.

plot_x_column

Returns the index of the column designated as Y values for plotting or None.

reset_data_count(self)

start_fetching(self)

fetch_more_rows(self)

fetch_more_columns(self)

call_reset_model(self, object_class_ids, pivot=None)

Parameters:

• object_class_names (dict) – mapping disambiguated class names to ids
• pivot (tuple, optional) – list of rows, list of columns, list of frozen indexes, frozen value

reset_model(self, data, index_ids, rows=(), columns=(), frozen=(), frozen_value=())

clear_model(self)

update_model(self, data)

Update model with new data, but doesn’t grow the model.

Parameters:data (dict) –

add_to_model(self, data)

remove_from_model(self, data)

set_pivot(self, rows, columns, frozen, frozen_value)

set_frozen_value(self, frozen_value)

set_plot_x_column(self, column, is_x)

Sets or clears the X flag on a column

headerRowCount(self)

Returns number of rows occupied by header.

headerColumnCount(self)

Returns number of columns occupied by header.

dataRowCount(self)

Returns number of rows that contain actual data.

dataColumnCount(self)

Returns number of columns that contain actual data.

emptyRowCount(self)

emptyColumnCount(self)

rowCount(self, parent=QModelIndex())

Number of rows in table, number of header rows + datarows + 1 empty row

columnCount(self, parent=QModelIndex())

Number of columns in table, number of header columns + datacolumns + 1 empty columns

flags(self, index)

Roles for data

top_left_indexes(self)

Returns indexes in the top left area.

Returns

list(QModelIndex): top indexes (horizontal headers, associated to rows) list(QModelIndex): left indexes (vertical headers, associated to columns)

index_in_top(self, index)

index_in_left(self, index)

index_in_top_left(self, index)

Returns whether or not the given index is in top left corner, where pivot names are displayed

index_in_column_headers(self, index)

Returns whether or not the given index is in column headers (horizontal) area

index_in_row_headers(self, index)

Returns whether or not the given index is in row headers (vertical) area

index_in_headers(self, index)

index_in_empty_column_headers(self, index)

Returns whether or not the given index is in empty column headers (vertical) area

index_in_empty_row_headers(self, index)

Returns whether or not the given index is in empty row headers (vertical) area

index_in_data(self, index)

Returns whether or not the given index is in data area

column_is_index_column(self, column)

Returns True if column is the column containing expanded parameter_value indexes.

headerData(self, section, orientation, role=Qt.DisplayRole)

map_to_pivot(self, index)

Returns a tuple of row and column in the pivot model that corresponds to the given model index.

Parameters:index (QModelIndex) – Returns:row int: column Return type:int

_top_left_id(self, index)

Returns the id of the top left header corresponding to the given header index.

Parameters:index (QModelIndex) – Returns:int, NoneType

_header_id(self, index)

Returns the id of the given row or column header index.

Parameters:index (QModelIndex) – Returns:int, NoneType

_header_ids(self, row, column)

Returns the ids for the headers at given row and column.

Parameters:

• row (int) –
• column (int) –

Returns:

tuple(int)

header_name(self, index)

Returns the name corresponding to the given header index. Used by PivotTableView.

Parameters:index (QModelIndex) – Returns:str

_color_data(self, index)

_text_alignment_data(self, index)

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

_header_name(self, top_left_id, header_id)

_data(self, index, role)

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

setData(self, index, value, role=Qt.EditRole)

batch_set_data(self, indexes, values)

_batch_set_inner_data(self, inner_data)

_do_batch_set_inner_data(self, row_map, column_map, data, values)

_batch_set_header_data(self, header_data)

_batch_set_empty_header_data(self, header_data, get_top_left_id)

receive_data_added_or_removed(self, data, action)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftHeaderItem(model)

Base class for all ‘top left pivot headers’. Represents a header located in the top left area of the pivot table.

Parameters:model (PivotTableModel) –

model

db_mngr

db_map

_get_header_data_from_db(self, item_type, header_id, field_name, role)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftObjectHeaderItem(model, class_name, class_id)

Bases: spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftHeaderItem

A top left header for object_class.

Parameters:model (PivotTableModel) –

header_type

name

header_data(self, header_id, role=Qt.DisplayRole)

update_data(self, data)

add_data(self, names)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftParameterHeaderItem(model)

Bases: spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftHeaderItem

A top left header for parameter_definition.

Parameters:model (PivotTableModel) –

header_type

name

header_data(self, header_id, role=Qt.DisplayRole)

update_data(self, data)

add_data(self, names)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftParameterIndexHeaderItem(model)

Bases: spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftHeaderItem

A top left header for parameter index.

Parameters:model (PivotTableModel) –

header_type

name

header_data(self, header_id, role=Qt.DisplayRole)

update_data(self, _data)

add_data(self, _names)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftAlternativeHeaderItem(model)

Bases: spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.TopLeftHeaderItem

A top left header for parameter index.

Parameters:model (PivotTableModel) –

header_type

name

header_data(self, header_id, role=Qt.DisplayRole)

update_data(self, data)

add_data(self, names)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.ParameterValuePivotTableModel(parent)

Bases: spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.PivotTableModelBase

A model for the pivot table in parameter_value input type.

Parameters:parent (SpineDBEditor) –

item_type

Returns the item type.

object_and_parameter_ids(self, index)

Returns the object and parameter ids corresponding to the given data index. Used by PivotTableView.

Parameters:index (QModelIndex) – Returns:object ids int: parameter id Return type:list(int)

object_and_parameter_names(self, index)

Returns the object and parameter names corresponding to the given data index. Used by PivotTableView.

Parameters:index (QModelIndex) – Returns:object names str: parameter name Return type:list(str)

index_name(self, index)

Returns a string that concatenates the object and parameter names corresponding to the given data index. Used by plotting and ParameterValueEditor.

Parameters:index (QModelIndex) – Returns:str

column_name(self, column)

Returns a string that concatenates the object and parameter names corresponding to the given column. Used by plotting.

Parameters:column (int) – Returns:str

call_reset_model(self, object_class_ids, pivot=None)

See base class.

_default_pivot(self)

_data(self, index, role)

_do_batch_set_inner_data(self, row_map, column_map, data, values)

_object_parameter_value_to_add(self, header_ids, value)

_relationship_parameter_value_to_add(self, header_ids, value, rel_id_lookup)

_make_parameter_value_to_add(self)

static _parameter_value_to_update(id_, header_ids, value)

_batch_set_parameter_value_data(self, row_map, column_map, data, values)

Sets parameter values in batch.

_checked_parameter_values(self, items)

_add_parameter_values(self, items)

_update_parameter_values(self, items)

get_set_data_delayed(self, index)

Returns a function that ParameterValueEditor can call to set data for the given index at any later time, even if the model changes.

Parameters:index (QModelIndex) – Returns:function

receive_objects_added_or_removed(self, items, action)

receive_relationships_added_or_removed(self, relationships, action)

receive_parameter_definitions_added_or_removed(self, parameters, action)

receive_parameter_values_added_or_removed(self, parameter_values, action)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.IndexExpansionPivotTableModel(parent)

Bases: spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.ParameterValuePivotTableModel

A model for the pivot table in parameter index expansion input type.

Parameters:parent (SpineDBEditor) –

call_reset_model(self, object_class_ids, pivot=None)

See base class.

flags(self, index)

Roles for data

column_is_index_column(self, column)

Returns True if column is the column containing expanded parameter_value indexes.

_data(self, index, role)

static _parameter_value_to_update(id_, header_ids, value)

_update_parameter_values(self, items)

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.RelationshipPivotTableModel(parent)

Bases: spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.PivotTableModelBase

A model for the pivot table in relationship input type.

Parameters:parent (SpineDBEditor) –

item_type

Returns the item type.

call_reset_model(self, object_class_ids, pivot=None)

See base class.

_default_pivot(self)

_data(self, index, role)

_text_alignment_data(self, index)

_do_batch_set_inner_data(self, row_map, column_map, data, values)

_batch_set_relationship_data(self, row_map, column_map, data, values)

receive_objects_added_or_removed(self, items, action)

receive_relationships_added_or_removed(self, relationships, action)

receive_parameter_definitions_added_or_removed(self, db_map_data, action)

Returns False, this model does not hold parameter data.

receive_parameter_values_added_or_removed(self, db_map_data, action)

Returns False, this model does not hold parameter data.

class spinetoolbox.spine_db_editor.mvcmodels.pivot_table_models.PivotTableSortFilterProxy(parent=None)

Bases: PySide2.QtCore.QSortFilterProxyModel

Initialize class.

set_filter(self, identifier, filter_value)

Sets filter for a given index (object_class) name.

Parameters:

• identifier (int) – index identifier
• filter_value (set, None) – A set of accepted values, or None if no filter (all pass)

clear_filter(self)

accept_index(self, index, index_ids)

filterAcceptsRow(self, source_row, source_parent)

Returns true if the item in the row indicated by the given source_row and source_parent should be included in the model; otherwise returns false.

filterAcceptsColumn(self, source_column, source_parent)

Returns true if the item in the column indicated by the given source_column and source_parent should be included in the model; otherwise returns false.

batch_set_data(self, indexes, values)