spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item

Classes to represent entities in a tree.

authors

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

date

11.3.2019

Module Contents

Classes

EntityRootItem	A tree item that may belong in multiple databases.
ObjectTreeRootItem	An object tree root item.
RelationshipTreeRootItem	A relationship tree root item.
EntityClassItem	An entity_class item.
ObjectClassItem	An object_class item.
RelationshipClassItemBase	A relationship_class item.
RelationshipClassItem	A relationship_class item.
ObjectRelationshipClassItem	A relationship_class item.
MemberObjectClassItem	A member object class item.
EntityItem	An entity item.
ObjectItem	An object item.
MemberObjectItem	A member object item.
RelationshipItem	A relationship item.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.EntityRootItem(model=None, db_map_id=None)

Bases: spinetoolbox.spine_db_editor.mvcmodels.multi_db_tree_item.MultiDBTreeItem

A tree item that may belong in multiple databases.

Init class.

Parameters

• db_mngr (SpineDBManager) – a database manager

• db_map_data (dict) – maps instances of DiffDatabaseMapping to the id of the item in that db

item_type = root

property display_id(self)

“See super class.

property display_icon(self)

Returns an icon to display next to the name. Reimplement in subclasses to return something nice.

property display_data(self)

“See super class.

abstract _get_children_ids(self, db_map)

See super class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.ObjectTreeRootItem(model=None, db_map_id=None)

Bases: EntityRootItem

An object tree root item.

Init class.

Parameters

• db_mngr (SpineDBManager) – a database manager

• db_map_data (dict) – maps instances of DiffDatabaseMapping to the id of the item in that db

item_type = root

property child_item_type(self)

Returns ObjectClassItem.

abstract set_data(self, column, value, role)

See base class.

_get_children_ids(self, db_map)

See super class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.RelationshipTreeRootItem(model=None, db_map_id=None)

Bases: EntityRootItem

A relationship tree root item.

Init class.

Parameters

• db_mngr (SpineDBManager) – a database manager

• db_map_data (dict) – maps instances of DiffDatabaseMapping to the id of the item in that db

item_type = root

property child_item_type(self)

Returns RelationshipClassItem.

abstract set_data(self, column, value, role)

See base class.

_get_children_ids(self, db_map)

See super class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.EntityClassItem(*args, **kwargs)

Bases: spinetoolbox.spine_db_editor.mvcmodels.multi_db_tree_item.MultiDBTreeItem

An entity_class item.

Overridden method to declare group_child_count attribute.

property display_icon(self)

Returns class icon.

_display_icon(self, for_group=False)

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

Returns data for given column and role.

abstract _get_children_ids(self, db_map)

See super class

fetch_more(self)

Fetches children from all associated databases and raises group children.

raise_group_children_by_id(self, db_map_ids)

Moves group children to the top of the list.

Parameters

db_map_ids (dict) – set of ids corresponding to newly inserted group children, keyed by DiffDatabaseMapping

_raise_group_children_by_row(self, rows)

Moves group children to the top of the list.

Parameters

rows (set, list) – collection of rows corresponding to newly inserted group children

remove_children(self, position, count)

Overriden method to keep the group child count up to date.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.ObjectClassItem(*args, **kwargs)

Bases: EntityClassItem

An object_class item.

Overridden method to declare group_child_count attribute.

item_type = object_class

property child_item_type(self)

Returns ObjectItem.

default_parameter_data(self)

Return data to put as default in a parameter table when this item is selected.

abstract set_data(self, column, value, role)

See base class.

_get_children_ids(self, db_map)

see super class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.RelationshipClassItemBase(*args, **kwargs)

Bases: EntityClassItem

A relationship_class item.

Overridden method to declare group_child_count attribute.

visual_key = ['name', 'object_class_name_list']

item_type = relationship_class

property child_item_type(self)

Returns RelationshipItem.

default_parameter_data(self)

Return data to put as default in a parameter table when this item is selected.

abstract set_data(self, column, value, role)

See base class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.RelationshipClassItem(*args, **kwargs)

Bases: RelationshipClassItemBase

A relationship_class item.

Overridden method to declare group_child_count attribute.

abstract set_data(self, column, value, role)

See base class.

_get_children_ids(self, db_map)

see super class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.ObjectRelationshipClassItem(*args, **kwargs)

Bases: RelationshipClassItemBase

A relationship_class item.

Overridden method to declare group_child_count attribute.

abstract set_data(self, column, value, role)

See base class.

_get_children_ids(self, db_map)

see super class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.MemberObjectClassItem(*args, **kwargs)

Bases: ObjectClassItem

A member object class item.

Overridden method to declare group_child_count attribute.

item_type = members

property display_id(self)

“Returns an id for display based on the display key. This id must be the same across all db_maps. If it’s not, this property becomes None and measures need to be taken (see update_children_by_id).

property display_data(self)

“Returns the name for display.

db_map_data(self, db_map)

Returns data for this item as if it was indeed an object class.

_display_icon(self, for_group=False)

Returns icon for this item as if it was indeed an object class.

has_children(self)

Returns True, this item always has children.

_get_children_ids(self, db_map)

See base class.

property child_item_type(self)

Returns MemberObjectItem.

default_parameter_data(self)

Return data to put as default in a parameter table when this item is selected.

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

Returns data for given column and role.

abstract set_data(self, column, value, role)

See base class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.EntityItem(model=None, db_map_id=None)

Bases: spinetoolbox.spine_db_editor.mvcmodels.multi_db_tree_item.MultiDBTreeItem

An entity item.

Init class.

Parameters

• db_mngr (SpineDBManager) – a database manager

• db_map_data (dict) – maps instances of DiffDatabaseMapping to the id of the item in that db

property display_icon(self)

Returns corresponding class icon.

db_map_member_ids(self, db_map)

db_map_entity_groups(self, db_map)

property member_ids(self)

is_group(self)

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

Returns data for given column and role.

abstract _get_children_ids(self, db_map)

See base class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.ObjectItem(model=None, db_map_id=None)

Bases: EntityItem

An object item.

Init class.

Parameters

• db_mngr (SpineDBManager) – a database manager

• db_map_data (dict) – maps instances of DiffDatabaseMapping to the id of the item in that db

item_type = object

property child_item_type(self)

Returns RelationshipClassItem.

default_parameter_data(self)

Return data to put as default in a parameter table when this item is selected.

abstract set_data(self, column, value, role)

See base class.

_get_children_ids(self, db_map)

See base class

fetch_more(self)

Fetches children from all associated databases.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.MemberObjectItem(model=None, db_map_id=None)

Bases: ObjectItem

A member object item.

Init class.

Parameters

• db_mngr (SpineDBManager) – a database manager

• db_map_data (dict) – maps instances of DiffDatabaseMapping to the id of the item in that db

item_type = object

property display_icon(self)

Returns corresponding class icon.

has_children(self)

Returns false, this item never has children.

abstract set_data(self, column, value, role)

See base class.

class spinetoolbox.spine_db_editor.mvcmodels.entity_tree_item.RelationshipItem(*args, **kwargs)

Bases: EntityItem

A relationship item.

Overridden method to make sure we never try to fetch this item.

visual_key = ['name', 'object_name_list']

item_type = relationship

property object_name_list(self)

property display_data(self)

“Returns the name for display.

property edit_data(self)

has_children(self)

Returns false, this item never has children.

default_parameter_data(self)

Return data to put as default in a parameter table when this item is selected.

can_fetch_more(self)

Returns whether or not this item can fetch more.

abstract _get_children_ids(self, db_map)

See base class

is_valid(self)

Checks that the grand parent object is still in the relationship.