| Top | |
|
|
|
| char * | data-string | Read / Write / Construct Only |
| char * | filename | Read / Write / Construct Only |
| GdaSet * | options | Read / Write / Construct Only |
| gboolean | random-access | Read / Write / Construct Only |
| gboolean | strict | Read / Write / Construct |
| gpointer | xml-node | Read / Write / Construct Only |
The GdaDataModelImport data model imports data from a string or a file. The data can either be in a CSV (comma separated values) format or in an XML format as described by the libgda-array.dtd DTD (as a side way it is also possible to import data from an already-build XML tree validated against that DTD).
The caller must decide, upon construction, if the new GdaDataModelImport must support random access or simply a cursor based access. Random access makes it easier to use the resulting data model but consumes more memory as all the data is copied in memory, and is thus not suitable for large data sets. Note that importing from an already-build XML tree will always result in a random access data model.
Various import options can be specified using parameters in a GdaSet object. The available options depend on the format of the imported data listed here:
"SEPARATOR" (string, CVS import only): specifies the separator to consider
"ESCAPE_CHAR" (string, CVS import only): specifies the character used to "escape" the strings contained between two separators
"ENCODING" (string, CVS import only): specifies the character set used in the imported data
"TITLE_AS_FIRST_LINE" (boolean, CVS import only): TRUE to specify that the first line of the imported data contains the column names
"G_TYPE_<col number>" (GType, CVS import only): specifies the requested GType type for the column numbered "col number"
GdaDataModel * gda_data_model_import_new_file (const gchar *filename,gboolean random_access,GdaSet *options);
Creates a new GdaDataModel object which contains the data stored within the filename
file.
The options are the following ones:
For the CSV format:
ENCODING (string): specifies the encoding of the data in the file
SEPARATOR (string): specifies the CSV separator (comma as default)
QUOTE (string): specifies the character used as quote (double quote as default)
NAMES_ON_FIRST_LINE (boolean): consider that the first line of the file contains columns' titles (note that the TITLE_AS_FIRST_LINE option is also accepted as a synonym)
G_TYPE_<column number> (GType): specifies the type of value expected in column <column number>
Other formats: no option
Note: after the creation, please use gda_data_model_import_get_errors() to check any error.
filename |
the file to import data from |
|
random_access |
TRUE if random access will be required |
|
options |
importing options. |
[transfer none][allow-none] |
GdaDataModel * gda_data_model_import_new_mem (const gchar *data,gboolean random_access,GdaSet *options);
Creates a new GdaDataModel object which contains the data stored in the data
string.
Important note: the data
string is not copied for memory efficiency reasons and should not
therefore be altered in any way as long as the returned data model exists.
data |
a string containing the data to import |
|
random_access |
TRUE if random access will be required |
|
options |
importing options, see |
[transfer none][allow-none] |
GdaDataModel *
gda_data_model_import_new_xml_node (xmlNodePtr node);
Creates a new GdaDataModel and loads the data in node
. The resulting data model
can be accessed in a random way.
GSList *
gda_data_model_import_get_errors (GdaDataModelImport *model);
Get the list of errors which model
has to report. The returned list is a list of
GError structures, and must not be modified
the list of errors (which must not be modified), or NULL.
[transfer none][element-type GLib.Error]
void
gda_data_model_import_clean_errors (GdaDataModelImport *model);
Clears the history of errors model
has to report
“data-string” property “data-string” char *
Data to import, as a string.
Owner: GdaDataModelImport
Flags: Read / Write / Construct Only
Default value: NULL
“filename” property “filename” char *
Name of the file to import.
Owner: GdaDataModelImport
Flags: Read / Write / Construct Only
Default value: NULL
“options” property“options” GdaSet *
Data model options.
Owner: GdaDataModelImport
Flags: Read / Write / Construct Only
“random-access” property“random-access” gboolean
Defines if the data model will be accessed randomly or through a cursor. If set to FALSE,
access will have to be done using a cursor.
Owner: GdaDataModelImport
Flags: Read / Write / Construct Only
Default value: FALSE
“strict” property“strict” gboolean
Defines the behaviour in case the imported data contains recoverable errors (usually too
many or too few data per row). If set to TRUE, an error will be reported and the import
will stop, and if set to FALSE, then the error will be reported but the import will not stop.
Owner: GdaDataModelImport
Flags: Read / Write / Construct
Default value: FALSE
Since: 4.2.1
“xml-node” property“xml-node” gpointer
Data to import, as a pointer to an XML node (a xmlNodePtr).
Owner: GdaDataModelImport
Flags: Read / Write / Construct Only