6.2. Using HyperAdminimal

6.2. Using HyperAdminimal
	Chapter 6. How to use HyperAdminimal

As shown in Figure 6.1, the application is composed of a basic toolbar and of a form composed of 11 input text fields.

The text fields aim at specifying the input parameters for the generation of the dataset .hyp file. As most of expected inputs are files, the buttons on the right side allow to browse the user's file system to choose them. Nevertheless, the user may directly type the absolute paths to the input files in their respective text fields.

Note that most of parameters are required, only Contiguity and Cities fields are optional.


	At this step, the user is expected to have prepared on his/her disk the four requested input files (see Expected Input Files).

In addition to the requested input files, note that the user must mandatory provide some metadata about the dataset to be generated:

the name of the author of this dataset
the firstname of this author
the name for the dataset
a short sentence as an abstract of this dataset (Dataset description field value)

Finally, the Output file field consists in entering the absolute path and filename of the dataset .hyp file to be generated. For example, /home/user/myDataset.hyp (spaces and accentuated characters should be avoided for this value).

Then, to start the build of the dataset hyp file, simply click the "Play" button on the toolbar.

Build logs and eventual error messages or exceptions are displayed to the console (see the command to execute HyperAdminimal). In the case of a failure, the displayed messages to the console may be useffull to fix the input files.

At the end of the process, a graphical box displays a message that indicates if the build failed or succeeded.

6.2.1. Saving and loading the build parameters

In order to replay several times a dataset build, the HyperAdminimal application proposes a functionnality to save and load the build parameters. This functionnality can be explained by describing the available buttons on the toolbar:

Reset parameters
This button erases the values in the fields.
Load parameters
Clicking this button opens a file chooser, the user is invited to select on his/her disk an XML file that has previously been saved via the save parameters functionnality.

Save parameters

On clicking this button, the user is invited to select a directory and a filename on his/her disk. The content of the fields will be saved to this file in XML format. As shown in Figure 6.2, the format of this XML file is quite simple, it can thus be eventually easily copied/pasted and manually edited for various configurations.

Figure 6.2. HyperAdminimal parameters XML file format sample

<?xml version="1.0" encoding="UTF-8"?>
<hyperadmin>
  <mif>/home/blerubrus/geom_nuts2_eu31.mif</mif>
  <mid>/home/blerubrus/geom_nuts2_eu31.mid</mid>
  <structure>/home/blerubrus/structure.xls</structure>
  <data>/home/blerubrus/data.xls</data>
  <contiguity />
  <authorname>HyperCarte Research Group</authorname>
  <authorfirstname>LIG STEAMER</authorfirstname>
  <datasetname>testDataset</datasetname>
  <datasetdescription>Built with HyperAdmininimal</datasetdescription>
  <output>/home/blerubrus/test.hyp</output>
</hyperadmin>


6.1. Launching HyperAdminimal		Appendix A. References