GUI manual

INTRODUCTION

This site describes the program usage through a GUI interface. Sections below, cover only a functionality, which is specific for a GUI. The complete description of program is in the Main Manual.

Start program

To start the GUI interface, use swift.py script.
cd path/to/swift/
./swift.py

LAYOUT

UI Elements

1 - Source file text box

Write or select (with the Source Select button) the path to the source file.

Background colors:
  • white - the text box is clear (no file selected)
  • green - the valid source file is selected (the file exists and has a correct file extension)
  • red - the invalid source file is selected (the file doesn't exists or has an incorrect file extension)
2 - Target file text box

Write or select (with the Target Select button) the path to the target file (can't be the same as a source file).

Background colors:
  • white - the text box is clear (no file selected)
  • green - the valid target file is selected (the file exists and has a correct file extension)
  • red - the invalid target file is selected (the file doesn't exists or has an incorrect file extension)
3 - Source data table
Displays a source data as a table, use button Preview. Display of the table uses the "infinite" vertical scrollbar, i.e. as the scrollbar reaches its lower edge position, further data are loaded and the scrollbar shrinks and jumps up.
4 - Target data table
Displays a target data as a table if the Preview after convert checkbox is checked. Display of the table uses the "infinite" vertical scrollbar.
5 - Infobar.
Shows info messages.
6 - Source Select button
Selects the path to a source file.
7 - Target Select button
Selects the path to a target file.
8 - Convert button
Starts a conversion.
9 - Source Settings button
Opens the settings dialog for the source file.
10 - Source Original data button
Opens the Original data dialog with an original source data.
11 - Preview button
Displays a preview of the source data in the Source data table.
12 - Info button
Exports statistics of the source data into a selected file.
13 - Target Settings button
Opens the settings dialog for the target file.
14 - Target Original data button
Opens the Original data dialog with an original target data.
15 - Preview after convert checkbox
If is checked and if the conversion was successful, the target data will be displayed in the target data table.
16 - Split bar
Allows to change width of the source/target data table (with a mouse or with keys shortcut).

KEYS SHORTCUT

DIALOG BOXES

Source/Target settings dialog

The dialog is possible to open by settings button. Input elements inside the dialog match exactly optional arguments described here. Elements displayed in the dialog depends on the selected data format (by the source extension or by the Format combobox).

Examples:

Progress bar dialogs

The progress bar dialog is displayed always if the program iterates through the source file. For some conversions is necessary to iterate through the source file twice. At the first interaction the program reads information about the source data (Prepare Data dialog) and at the second iteration converts the source data to the target data (Convert Data dialog). The iteration can be stopped by the Cancel button anytime.

Examples:

Warning/Error dialogs

The program produces Warnings and Errors. Warnings don't have to be critical and is possible to skip them if you are sure what you do. Errors always stop an operation and provide detailed description, which can be shown/hidden by the Show/Hide button. All errors are listed here.

Find dialog

To find a value in the source/target data table press the shortcut: Ctrl+f.

Original data dialog

The Original data dialog is possible to open by the Original data button. In the dialog are displayed an original source/target data as they are written on the disk. You can find an expression in a displayed data using the Find bar at the bottom. The displayed data are read only and the display uses the "infinite" vertical scrollbar. Note the syntax highlighting for the individual data file formats.

EXAMPLE

Conversion CSV (example.csv) to CXT (result.cxt)

Main window

  1. Select a source file.
  2. Show a preview of data.
  3. Open the source settings dialog and fill relevant arguments.
  4. Select a target file.
  5. Open the target settings dialog and fill relevant arguments.

The source settings dialog

  1. Set the Target Attributes argument exactly as it would be given for the --target_attributes optional argument described here.
  2. Set the Missing Value argument.
  3. Click on the button OK, to confirm the form.

The target settings dialog

  1. Set the Objects arguments.
  2. Click on the button OK, to confirm the form.

Finish

  1. Click on the Convert button.

FEATURES

Copy data into the clipboard

If you select some data in a data table and press Ctrl+c, the selected data are copied into the clipboard.

Example:

1991-06-13 54 true
1990-04-23 98 false

More conversions at once

Each operation runs on the separate thread, so there is no problem to run next operation while the previous is still running.

Example:
  1. Select a source file and a target file.
  2. Set arguments for a conversion.
  3. Click on the Convert button. ... but the conversion takes a long time and you need to convert other (not so big) file. So you can repeat the previous process in the same manner. But be sure, that conversion arguments are set correctly before start next conversion (arguments are not cleared, so if you not change them, they will be also used for the second conversion).

Browsing big files

The program is prepared for working with very big files. Into the source/target data table and Original data dialog, data are loaded dynamically, so you don't have to be worried about a data size.