spinetoolbox.mvcmodels.entity_tree_models

Models to represent entities in a tree.

authors:

16. Vennström (VTT), M. Marin (KTH)

date:

11.3.2019

Module Contents

class spinetoolbox.mvcmodels.entity_tree_models.EntityTreeModel(parent, db_mngr, *db_maps)

Bases: spinetoolbox.mvcmodels.minimal_tree_model.MinimalTreeModel

Base class for all entity tree models.

Init class.

Parameters:

• parent (DataStoreForm) –
• db_mngr (SpineDBManager) – A manager for the given db_maps
• db_maps (iter) – DiffDatabaseMapping instances

remove_selection_requested

root_item_type

Implement in subclasses to create a model specific to any entity type.

root_item

root_index

build_tree(self)

Builds tree.

columnCount(self, parent=QModelIndex())

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

headerData(self, section, orientation, role)

_select_index(self, index)

Marks the index as selected.

select_indexes(self, indexes)

Marks given indexes as selected.

find_leaves(self, db_map, *ids_path, parent_items=(), fetch=False)

Returns leaf-nodes following the given path of ids, where each element in ids_path is a set of ids to jump from one level in the tree to the next. Optionally fetches nodes as it goes.

class spinetoolbox.mvcmodels.entity_tree_models.ObjectTreeModel(*args, **kwargs)

Bases: spinetoolbox.mvcmodels.entity_tree_models.EntityTreeModel

An ‘object-oriented’ tree model.

root_item_type

selected_object_class_indexes

selected_object_indexes

selected_relationship_class_indexes

selected_relationship_indexes

_group_object_data(self, db_map_data)

Takes given object data and returns the same data keyed by parent tree-item.

Parameters:db_map_data (dict) – maps DiffDatabaseMapping instances to list of items as dict Returns:maps parent tree-items to DiffDatabaseMapping instances to list of item ids Return type:result (dict)

_group_relationship_class_data(self, db_map_data)

Takes given relationship class data and returns the same data keyed by parent tree-item.

Parameters:db_map_data (dict) – maps DiffDatabaseMapping instances to list of items as dict Returns:maps parent tree-items to DiffDatabaseMapping instances to list of item ids Return type:result (dict)

_group_relationship_data(self, db_map_data)

Takes given relationship data and returns the same data keyed by parent tree-item.

Parameters:db_map_data (dict) – maps DiffDatabaseMapping instances to list of items as dict Returns:maps parent tree-items to DiffDatabaseMapping instances to list of item ids Return type:result (dict)

add_object_classes(self, db_map_data)

add_objects(self, db_map_data)

add_relationship_classes(self, db_map_data)

add_relationships(self, db_map_data)

remove_object_classes(self, db_map_data)

remove_objects(self, db_map_data)

remove_relationship_classes(self, db_map_data)

remove_relationships(self, db_map_data)

update_object_classes(self, db_map_data)

update_objects(self, db_map_data)

update_relationship_classes(self, db_map_data)

update_relationships(self, db_map_data)

find_next_relationship_index(self, index)

Find and return next ocurrence of relationship item.

class spinetoolbox.mvcmodels.entity_tree_models.RelationshipTreeModel(*args, **kwargs)

Bases: spinetoolbox.mvcmodels.entity_tree_models.EntityTreeModel

A relationship-oriented tree model.

root_item_type

selected_relationship_class_indexes

selected_relationship_indexes

_group_relationship_data(self, db_map_data)

Takes given relationship data and returns the same data keyed by parent tree-item.

Parameters:db_map_data (dict) – maps DiffDatabaseMapping instances to list of items as dict Returns:maps parent tree-items to DiffDatabaseMapping instances to list of item ids Return type:result (dict)

add_relationship_classes(self, db_map_data)

add_relationships(self, db_map_data)

remove_relationship_classes(self, db_map_data)

remove_relationships(self, db_map_data)

update_relationship_classes(self, db_map_data)

update_relationships(self, db_map_data)