widgets.data_store_widget

Contains the DataStoreForm class, parent class of TreeViewForm and GraphViewForm.

author:

13. Marin (KTH)

date:

26.11.2018

Module Contents

class widgets.data_store_widget.DataStoreForm(project, ui, db_maps)

Bases: PySide2.QtWidgets.QMainWindow

A widget to show and edit Spine objects in a data store.

project

The project instance that owns this form

Type:SpineToolboxProject

ui

UI definition of the form that is initialized

db_maps

named DiffDatabaseMapping instances

Type:dict

msg

msg_error

commit_available

add_toggle_view_actions(self)

Add toggle view actions to View menu.

connect_signals(self)

Connect signals to slots.

qsettings(self)

Returns the QSettings instance from ToolboxUI.

add_message(self, msg)

Append regular message to status bar.

Parameters:msg (str) – String to show in QStatusBar

add_error_message(self, msg)

Show error message.

Parameters:msg (str) – String to show in QErrorMessage

_handle_object_parameter_value_visibility_changed(self, visible)

_handle_object_parameter_definition_visibility_changed(self, visible)

_handle_relationship_parameter_value_visibility_changed(self, visible)

_handle_relationship_parameter_definition_visibility_changed(self, visible)

_handle_tag_button_toggled(self, db_map_ids, checked)

Called when a parameter tag button is toggled. Compute selected parameter definition ids per object class ids. Then update set of selected object class ids. Finally, update filter.

_handle_commit_available(self, on)

show_commit_session_dialog(self, checked=False)

Query user for a commit message and commit changes to source database.

commit_session(self, commit_msg)

rollback_session(self, checked=False)

refresh_session(self, checked=False)

init_models(self)

Initialize models.

init_object_tree_model(self)

Initialize object tree model.

init_parameter_value_models(self)

Initialize parameter value models from source database.

init_parameter_definition_models(self)

Initialize parameter (definition) models from source database.

init_parameter_value_list_model(self)

Initialize parameter value_list models from source database.

init_parameter_tag_toolbar(self)

Initialize parameter tag toolbar.

setup_delegates(self)

Set delegates for tables.

all_selected_object_class_ids(self)

Return object class ids selected in object tree and parameter tag toolbar.

all_selected_relationship_class_ids(self)

Return relationship class ids selected in relationship tree and parameter tag toolbar.

set_default_parameter_rows(self, index=None)

Set default rows for parameter models according to selection in object or relationship tree.

do_update_filter(self)

Apply filter on visible views.

show_add_object_classes_form(self, checked=False)

Show dialog to let user select preferences for new object classes.

show_add_objects_form(self, checked=False, class_name='')

Show dialog to let user select preferences for new objects.

show_add_relationship_classes_form(self, checked=False, object_class_one_name=None)

Show dialog to let user select preferences for new relationship class.

show_add_relationships_form(self, checked=False, relationship_class_key=(), object_class_name='', object_name='')

Show dialog to let user select preferences for new relationships.

add_object_classes(self, object_class_d)

Insert new object classes.

add_object_classses_to_models(self, db_map, added)

add_objects(self, object_d)

Insert new objects.

add_relationship_classes(self, rel_cls_d)

Insert new relationship classes.

add_relationship_classes_to_models(self, db_map, added)

add_relationships(self, relationship_d)

Insert new relationships.

add_relationships_to_models(self, db_map, added)

show_edit_object_classes_form(self, checked=False)

show_edit_objects_form(self, checked=False)

show_edit_relationship_classes_form(self, checked=False)

show_edit_relationships_form(self, checked=False)

update_object_classes(self, object_class_d)

Update object classes.

update_object_classes_in_models(self, db_map, updated)

update_objects(self, object_d)

Update objects.

update_objects_in_models(self, db_map, updated)

update_relationship_classes(self, rel_cls_d)

Update relationship classes.

update_relationship_classes_in_models(self, db_map, updated)

update_relationships(self, relationship_d)

Update relationships.

update_relationships_in_models(self, db_map, updated)

add_parameter_value_lists(self, parameter_value_list_d)

update_parameter_value_lists(self, parameter_value_list_d)

show_manage_parameter_tags_form(self, checked=False)

add_parameter_tags(self, parameter_tag_d)

Add parameter tags.

update_parameter_tags(self, parameter_tag_d)

Update parameter tags.

remove_parameter_tags(self, parameter_tag_d)

Remove parameter tags.

show_parameter_value_editor(self, index, table_view, value=None)

Shows the parameter value editor for the given index of given table view.

set_parameter_value_data(self, index, new_value)

Update (object or relationship) parameter value with newly edited data.

set_parameter_definition_data(self, index, new_value)

Update (object or relationship) parameter definition with newly edited data. If the parameter name changed, update it in (object or relationship) parameter value.

show_commit_session_prompt(self)

Shows the commit session message box.

restore_ui(self)

Restore UI state from previous session.

closeEvent(self, event=None)

Handle close window.

Parameters:event (QEvent) – Closing event if ‘X’ is clicked.