data_connection

Module for data connection class.

author:

16. Savolainen (VTT)

date:

19.12.2017

Module Contents

class data_connection.DataConnection(toolbox, name, description, references, x, y)

Bases: project_item.ProjectItem

Data Connection class.

toolbox

QMainWindow instance

Type:ToolboxUI

name

Object name

Type:str

description

Object description

Type:str

references

List of file references

Type:list

x

Initial X coordinate of item icon

Type:int

y

Initial Y coordinate of item icon

Type:int

make_signal_handler_dict(self)

Returns a dictionary of all shared signals and their handlers. This is to enable simpler connecting and disconnecting.

activate(self)

Restore selections and connect signals.

deactivate(self)

Save selections and disconnect signals.

restore_selections(self)

Restore selections into shared widgets when this project item is selected.

save_selections(self)

Save selections in shared widgets for this project item into instance variables.

get_icon(self)

Returns the item representing this data connection in the scene.

add_files_to_references(self, paths)

Add multiple file paths to reference list.

Parameters:paths (list) – A list of paths to files

receive_files_dropped_on_dc(self, item, file_paths)

Called when files are dropped onto a data connection graphics item. If the item is this Data Connection’s graphics item, add the files to data.

add_files_to_data_dir(self, file_paths)

Add files to data directory

open_directory(self, checked=False)

Open file explorer in Data Connection data directory.

add_references(self, checked=False)

Let user select references to files for this data connection.

remove_references(self, checked=False)

Remove selected references from reference list. Do not remove anything if there are no references selected.

copy_to_project(self, checked=False)

Copy selected file references to this Data Connection’s data directory.

open_reference(self, index)

Open reference in default program.

open_data_file(self, index)

Open data file in default program.

show_spine_datapackage_form(self)

Show spine_datapackage_form widget.

datapackage_form_destroyed(self)

Notify a connection that datapackage form has been destroyed.

make_new_file(self)

Create a new blank file to this Data Connections data directory.

remove_files(self)

Remove selected files from data directory.

file_references(self)

Returns a list of paths to files that are in this item as references.

data_files(self)

Returns a list of files that are in the data directory.

refresh(self)

Refresh data files in Data Connection Properties. NOTE: Might lead to performance issues.

populate_reference_list(self, items)

List file references in QTreeView. If items is None or empty list, model is cleared.

populate_data_list(self, items)

List project internal data (files) in QTreeView. If items is None or empty list, model is cleared.

update_name_label(self)

Update Data Connection tab name label. Used only when renaming project items.

execute(self)

Executes this Data Connection.

stop_execution(self)

Stops executing this Data Connection.