spinetoolbox.spine_db_parcel

SpineDBParcel class.

authors:

13. Marin (KTH)

date:

10.5.2020

Module Contents

Classes

SpineDBParcel

A class to create parcels of data from a Spine db.

class spinetoolbox.spine_db_parcel.SpineDBParcel(db_mngr)

A class to create parcels of data from a Spine db. Mainly intended for the Export selection action in the Spine db editor.

The strategy is the following:

• _push methods (with a leading underscore) push items with everything they need to live in a standalone db.

  These are private methods.

• push methods (no leading underscore) call the _push methods to get away with pushing some specific content.

  These are public methods.

Initializes the parcel object.

Parameters:db_mngr (SpineDBManager) –

data

_get_fields(self, db_map, item_type, field, ids)

_push_object_class_ids(self, db_map_ids)

Pushes object_class ids.

_push_relationship_class_ids(self, db_map_ids)

Pushes relationship_class ids.

_push_object_ids(self, db_map_ids)

Pushes object ids.

_push_relationship_ids(self, db_map_ids)

Pushes relationship ids.

_push_parameter_value_list_ids(self, db_map_ids)

Pushes parameter_value_list ids.

_push_parameter_definition_ids(self, db_map_ids, entity_type)

Pushes parameter_definition ids.

_push_parameter_value_ids(self, db_map_ids, entity_type)

Pushes parameter_value ids.

_push_object_group_ids(self, db_map_ids)

Pushes object group ids.

_push_alternative_ids(self, db_map_ids)

Pushes alternative ids.

_push_scenario_ids(self, db_map_ids)

Pushes scenario ids.

_push_scenario_alternative_ids(self, db_map_ids)

Pushes scenario_alternative ids.

push_object_class_ids(self, db_map_ids)

Pushes parameter definitions associated with given object classes. This essentially pushes the object classes and their parameter definitions.

push_relationship_class_ids(self, db_map_ids)

Pushes parameter definitions associated with given relationship classes. This essentially pushes the relationships classes, their parameter definitions, and their member object classes.

push_object_ids(self, db_map_ids)

Pushes parameter values associated with objects and with any relationships involving those objects. This essentially pushes objects, their relationships, all the parameter values, and all the necessary classes, definitions, and lists.

push_relationship_ids(self, db_map_ids)

Pushes parameter values associated with relationships. This essentially pushes relationships, their parameter values, and all the necessary classes, definitions, and lists.

push_inside_object_ids(self, db_map_ids)

Pushes object ids, cascading relationship ids, and the associated parameter values, but not any entity classes or parameter definitions. Mainly intended for the Duplicate object action.

push_inside_relationship_ids(self, db_map_ids)

Pushes relationship ids, and the associated parameter values, but not any entity classes or parameter definitions.

push_inside_parameter_value_ids(self, db_map_ids, entity_type)

Pushes parameter_value ids.

_setdefault(self, db_map)