#include <hk_datasource.h>
Inheritance diagram for hk_datasource:
Public Types | |
| enum | enum_tablemodes { mode_normal, mode_createtable, mode_altertable, mode_disabled, mode_insertrow, mode_deleterow, mode_unknown } |
| enum | enum_accessmode { standard, batchread, batchwrite } |
| enum | enum_dependingmodes { depending_nohandle, depending_standard, depending_change, depending_delete, depending_changedelete } |
Public Member Functions | |
| virtual void | set_name (const hk_string &n, bool registerchange=true) |
| virtual hk_string | name (void) |
| enum_tablemodes | mode (void) |
| void | setmode_insertrow (void) |
| void | delete_actualrow (enum_interaction c=interactive) |
| void | setmode_normal (void) |
| void | setmode_createtable (void) |
| void | setmode_altertable (void) |
| hk_column * | new_column (void) |
| bool | alter_column (const hk_string &col, const hk_string *name=NULL, hk_column::enum_columntype *newtype=NULL, long *size=NULL, const hk_string *defaultvalue=NULL, const bool *primary=NULL, const bool *notnull=NULL) |
| bool | delete_column (const hk_string &col) |
| bool | create_table_now (void) |
| bool | alter_table_now (void) |
| bool | create_view_now (void) |
| bool | alter_view_now (void) |
| virtual bool | goto_row (unsigned long r) |
| bool | goto_first (void) |
| bool | goto_last (void) |
| bool | goto_next (void) |
| bool | goto_previous (void) |
| bool | goto_random (void) |
| unsigned long | row_position (void) |
| unsigned long | max_rows (void) |
| bool | set_accessmode (enum_accessmode) |
| enum_accessmode | accessmode (void) const |
| bool | enable (void) |
| bool | disable (void) |
| bool | set_enabled (bool e) |
| bool | is_enabled (void) const |
| bool | is_readonly (void) const |
| void | set_readonly (bool r) |
| list< hk_column * > * | columns (void) |
| hk_column * | column_by_name (const hk_string &c) |
| hk_column * | column_by_name (const hk_string &c, int colnumber) |
| int | columnname_occurances (const hk_string &colname) |
| int | columnname_occurance (hk_column *) |
| bool | set_sql (const hk_string &s, bool rawsql=false, bool registerchange=true) |
| virtual bool | set_query (hk_qbe *, bool registerchange=true) |
| hk_string | sql (void) const |
| bool | is_rawsql (void) |
| list< indexclass > * | indices (void) |
| bool | index_exists (const hk_string &) |
| bool | drop_index (const hk_string &i) |
| bool | create_index (const hk_string &name, bool unique, list< hk_string > &fields) |
| bool | alter_index (const hk_string &name, bool unique, list< hk_string > &fields) |
| enum_dependingmodes | dependingmode (void) |
| bool | set_depending_on (hk_datasource *d, bool react_on_data_changes=false, enum_dependingmodes mode=depending_standard) |
| hk_datasource * | depending_on (void) |
| bool | depending_on_react_on_data_changes (void) |
| list< hk_string > * | depending_on_thisfields (void) |
| list< hk_string > * | depending_on_masterfields (void) |
| bool | set_depending_on_presentationdatasource (long d, bool react_on_data_changes=false, enum_dependingmodes mode=depending_standard, bool registerchange=true) |
| long | depending_on_presentationdatasource (void) |
| void | add_depending_fields (const hk_string &this_ds_field, const hk_string &master_ds_field, bool registerchange=true) |
| void | clear_depending_fields (bool registerchange=true) |
| bool | store_changed_data (enum_interaction c=interactive) |
| void | set_ignore_changed_data (void) |
| bool | ignore_changed_data (void) const |
| void | set_filter (const hk_string &f, bool registerchange=true) |
| hk_string | filter (void) |
| void | set_temporaryfilter (const hk_string &f) |
| hk_string | temporaryfilter (void) |
| void | set_use_temporaryfilter (bool use) |
| bool | use_temporaryfilter (void) |
| void | set_internalfilter (const hk_string &f) |
| hk_string | internalfilter (void) |
| void | set_use_internalfilter (bool use) |
| bool | use_internalfilter (void) |
| void | clear_filter (bool registerchange=true) |
| void | set_sorting (const hk_string &s, bool registerchange=true) |
| hk_string | sorting (void) |
| void | set_temporarysorting (const hk_string &s) |
| hk_string | temporarysorting (void) |
| void | set_use_temporarysorting (bool use) |
| bool | use_temporarysorting (void) |
| void | clear_sorting (bool registerchange=true) |
| void | set_automatic_data_update (bool u) |
| bool | is_automatic_data_update (void) |
| void | set_sqldelimiter (const hk_string &) |
| void | set_datetimeformat (const hk_string &datetime, const hk_string &date, const hk_string &time) |
| hk_database * | database (void) |
| void | savedata (ostream &s, bool saveall=true) |
| void | loaddata (const hk_string &definition, bool loadsql=true) |
| long | presentationnumber (void) const |
| bool | datasource_used (void) const |
| virtual void | dump_data () |
| bool | ask_name (void) |
| bool | delete_rows (unsigned long from, unsigned long to, bool check_depending_datasources=true, bool ask=true) |
| void | transaction_begin (hk_string name="") |
| void | transaction_commit (hk_string name="") |
| void | transaction_rollback (hk_string name="") |
| void | set_blockvisiblesignals (bool v) |
| bool | blockvisiblesignals (void) |
| void | set_blockserversignals (bool) |
| bool | blockserversignals (void) |
| void | set_blockdatasourcesignals (bool) |
| bool | blockdatasourcesignals (void) |
| void | save_datasourcedefinition (ostream &s) |
| bool | load_datasourcedefinition (const hk_string &definition, bool use_xmltablename=true, bool ask=true) |
| hk_presentation * | presentation (void) |
| void | set_position (int x, int y, bool registerchange=true) |
| void | set_size (int width, int height, bool registerchange=true) |
| int | x (void) const |
| int | y (void) const |
| int | width (void) const |
| int | height (void) const |
| void | set_designsize (int w, int h, bool registerchange=true) |
| int | designwidth () const |
| int | designheight () const |
| void | automatic_position_datasource (void) |
| list< hk_datasource * > * | dependinglist (void) |
| bool | previous_enable_problems (void) const |
| list< referentialclass > * | referenceslist (void) |
| bool | add_reference (const referentialclass &) |
| bool | drop_reference (const hk_string &) |
| hk_string | fieldorigin (const hk_string &) |
| void | reset_changed_data (void) |
| bool | has_changed (void) const |
Protected Member Functions | |
| hk_datasource (hk_database *db, hk_presentation *p=NULL) | |
| void | column_remove (hk_column *col) |
| void | visible_add (hk_dsvisible *v) |
| void | visible_remove (hk_dsvisible *v) |
| virtual void | driver_specific_transaction_begin (hk_string) |
| virtual void | driver_specific_transaction_commit (hk_string) |
| virtual void | driver_specific_transaction_rollback (hk_string) |
| virtual unsigned long | driver_specific_max_rows (void) |
| virtual bool | driver_specific_set_accessmode (enum_accessmode) |
| virtual bool | driver_specific_batch_enable (void) |
| virtual bool | driver_specific_batch_disable (void) |
| virtual bool | driver_specific_batch_goto_next (void) |
| virtual bool | driver_specific_batch_goto_previous (void) |
| virtual bool | driver_specific_enable (void) |
| virtual bool | driver_specific_disable (void) |
| virtual list< hk_column * > * | driver_specific_columns (void) |
| virtual bool | driver_specific_goto_row (unsigned long r) |
| virtual hk_column * | driver_specific_new_column (void) |
| virtual bool | driver_specific_update_data (void) |
| virtual bool | driver_specific_delete_data_at (unsigned long) |
| virtual bool | driver_specific_insert_data (void) |
| virtual bool | driver_specific_create_table_now (void) |
| virtual bool | driver_specific_alter_table_now (void) |
| virtual bool | driver_specific_create_view_now (void) |
| virtual bool | driver_specific_alter_view_now (void) |
| virtual void | driver_specific_before_drop_table (void) |
| virtual void | filelist_changes (listtype t) |
| virtual list< indexclass > * | driver_specific_indices (void) |
| virtual bool | driver_specific_drop_index (const hk_string &i) |
| virtual bool | driver_specific_create_index (const hk_string &name, bool unique, list< hk_string > &fields) |
| virtual void | before_connection_disconnects (void) |
| virtual void | before_source_vanishes (void) |
| virtual void | driver_specific_after_copy_table () |
| virtual bool | driver_specific_load_view () |
| virtual void | driver_specific_create_viewsql () |
| virtual bool | driver_specific_add_reference (const referentialclass &) |
| virtual bool | driver_specific_drop_reference (const hk_string &) |
| virtual void | driver_specific_referenceslist (void) |
| void | depending_ds_add (hk_datasource *d) |
| void | depending_ds_remove (hk_datasource *d) |
| void | depending_on_datasource_row_change (bool take_changed_data=false) |
| void | depending_on_datasource_data_has_changed (void) |
| void | depending_on_datasource_after_store_changed_data (void) |
| void | depending_on_datasource_insertmode (void) |
| bool | depending_on_datasource_deleterow_ok (void) |
| bool | depending_on_datasource_before_delete_row (void) |
| bool | depending_on_datasource_updaterow_ok (void) |
| void | depending_on_datasource_before_update_row (void) |
| void | depending_on_datasource_after_update_row (void) |
| void | reload_data (bool take_changed_data=false) |
| void | create_actual_row_where_statement (void) |
| hk_string | create_row_where_statement_at (unsigned long int position, bool withwhere=true) |
| void | create_new_sql_statement (bool take_changed_data=false) |
| hk_string | whole_datasource_where_statement (bool take_changed_data=false) |
| void | print_sql (void) |
| void | clear_columnlist (void) |
| void | clear_modecolumnlists (void) |
| void | clear_visiblelist (void) |
| void | parse_sql (void) |
| virtual bool | update_row (enum_interaction c=interactive) |
| virtual bool | insert_row (enum_interaction c=interactive) |
| virtual bool | delete_row (enum_interaction c=interactive) |
| void | parse_fieldpart (void) |
| void | set_has_changed (void) |
| void | set_has_not_changed (void) |
| hk_string | delimit_identifier (const hk_string &) |
Protected Attributes | |
| bool | p_casesensitive |
| bool | p_enabled |
| bool | p_readonly |
| bool | p_primary_key_used |
| bool | p_ignore_changed_data |
| unsigned long | p_counter |
| hk_database * | p_database |
| list< hk_column * > * | p_columns |
| list< class_altercolumns > | p_altercolumns |
| list< hk_string > | p_deletecolumns |
| list< hk_column * > | p_newcolumns |
| list< hk_string > | depending_this_fields |
| list< hk_string > | depending_master_fields |
| struct_parsed_sql * | p_parsed_sql |
| hk_string | p_sql |
| hk_string | p_viewsql |
| hk_string | p_actual_row_where |
| bool | p_automatic_data_update |
| hk_actionquery * | p_actionquery |
| hk_string | p_datetimeformat |
| hk_string | p_dateformat |
| hk_string | p_timeformat |
| hk_string | p_sql_delimiter |
| hk_string | p_true |
| hk_string | p_false |
| bool | p_tablesql_set |
Friends | |
| class | hk_column |
| class | hk_dsvisible |
| class | hk_database |
| class | hk_presentation |
Classes | |
| class | class_altercolumns |
| class | fieldoriginclass |
| class | indexclass |
| class | struct_parsed_sql |
Two types of this class can be distinguished. Tables and Resultqueries.
Resultqueries are Queries with a SELECT - SQL-statement. The resulting data cannot be edited or manipulated.
Tables are a special form of resultqueries. The SQL-statement is fixed ("SELECT * FROM <tablename>), but the resulting dataset can be edited.
|
|
the accessmode regulates the behaviour of the datasource. In mode 'standard' the datasource is readable and writeable, but usually first loads all the data from the SQL server. This is in some cases not necessary. If you just need to serially read one row after another, you can use the 'batchread' mode. In this case random access is not possible and it is not possible to edit the data or insert rows (e.g. this is used in hk_report). In 'batchwrite' mode data can't be read and is only used for inserting data (e.g. used hk_importcsv) The batchmodes do not need as much memory as the standard mode. |
|
|
See dependingmode for details |
|
||||||||||||||||
|
use this method in connection with depending_on.
|
|
||||||||||||||||||||||||||||||||
|
if this datasource is of type "table" and in mode "alter" you can alter an existing column. NULL values mean, that this part will not be changed |
|
||||||||||||||||
|
Alters an existing index by first dropping it with drop_index and then by trying to recreate it with create_index |
|
|
After altering an existing table with setmode_altertable, new_column ,alter_column and delete_column this function alters physically the table |
|
|
asks interactively for a name |
|
|
clears the depending list. |
|
|
clears the filter which was set with set_filter
|
|
|
clears the sorting instruction
|
|
||||||||||||
|
if the datasource is enabled, you can reach a particular column by name.
|
|
|
if the datasource is enabled, you can reach a particular column by name
|
|
|
returns if this is the first, second ... nth column with this name |
|
|
returns how many columns exist in this datasource with the name 'colname'. Usually columnnames should be unique, but it is unfortunately technically possible to create SQL statements that return ambigous columnnames |
|
|
if the datasource is enabled you get a list of all columns. The fields can be reached by columns. See hk_column for details. |
|
||||||||||||||||
|
creates an index of a table. returns true if successful otherwise false; make sure you have set the tablename first.
|
|
|
After defining a new table with setmode_createtable and new_column this function creates physically the table |
|
|
|
|
|
this function tries to delete the actual row. If there is a depending datasource with equivalent rows the actual row will not be deleted. |
|
|
if this datasource is of type "table" and in mode "alter" you can delete an existing column.Just enter the name here. |
|
||||||||||||||||||||
|
Delete rows beginning from row number "from" to row number "to" |
|
|
a list of the depending on columns of the master datasource set with add_depending_fields |
|
|
See dependingmode for details |
|
|
a list of the depending on columns of this datasource set with add_depending_fields |
|
|
depending_nohandle = ignore that this is a depending datasource
depending_standard = can't delete a master row when there are
depending rows in the depending datasource
and can't change the value of a master connection field.
depending_change = if a master connection field is changed, the
equivalent depending fields will change their values too.
depending_delete = if the master row is deleted the depending rows will also be deleted
depending_changedelete = combination of depending_change and depending_delete
See also set_depending_on for details |
|
|
if the datasource is enabled, this function will disable it. The columnlist will be deleted. |
|
|
will be called from hk_database |
|
|
returns a list of the columns of the datasource. If the datasource is a table the list hast to be created even if the datasource is disabled. Fill the p_columns list for this reason and then return it. If necessary has to create one hk_column object per column and to add them to p_columns. Each column object has to get a unique number in its (protected) hk_column::p_fieldnr . |
|
|
has to make sure that the columns-list has been created. It also has to provide access to the data of the datasource |
|
|
deletes an index of a table. returns true if successful otherwise false;
|
|
|
if hk_connection is connected, this method will enable the datasource. The SQL-Statement in SQL will be executed. If the SQL-statement is ok, the resulting data can be reached via the columns in columns. You can browse the data by using the methods goto_row, goto_first, goto_last, goto_next and goto_previous.
|
|
|
move the row selector to the first row. All depending objects will be informed (visible objects, depending datasources etc)
|
|
|
move the row selector to the last row. All depending objects will be informed (visible objects, depending datasources etc)
|
|
|
move the row selector to the next row. All depending objects will be informed (visible objects, depending datasources etc)
|
|
|
move the row selector to the previous row. All depending objects will be informed (visible objects, depending datasources etc)
|
|
|
moves the rowselector to a random row. |
|
|
Goto a specific row. The first row number is 0, the last n-1 where n is the number of rows as delivered from max_rows().All depending objects will be informed (visible objects, depending datasources etc)
|
|
|
returns the list of all existing indices of a table or NULL in case of an error (i.e. not a table) |
|
|
shows whether the datasource is enabled. |
|
|
|
|
||||||||||||||||
|
loads the structure of the datasource (fields,indices) in an xml format file and creates the tableand is database driver independent |
|
||||||||||||
|
loads the object's values out of the definition string. |
|
|
number of rows in this query. |
|
|
if this datasource is a table, it can be in different "modes". For example if you want to create a new table and define the different columns, the table has to be in "mode_create" See enum_tablemodes for the different modetypes. |
|
|
if this datasource is of type "table" and in mode "create" or "alter" you can create a new column to define its parameters. |
|
|
if the datasource is part of a hk_presentation each datasource gets a unique datasource number as an identifier
|
|
|
returns true, if this datasource could not be enabled last time when tried |
|
|
number of the current row. |
|
|
stores the structure of the datasource (fields,indices) in an xml format file and is database driver independent |
|
||||||||||||
|
stores the object's values to stream s. The following tags will be used <type> either QUERY or TABLE <datasourcename> the name set with set_name <sql> the used sql statement Additionally the section <datasourceextra> has the following tags <filter> the filter set with set_filter <sorting> the sorting direction set with set_sorting <datetimeformat> <dateformat> <timeformat> if this datasource is part of a hk_presentation also the following tags will be stored <upn> the unique presentation number. See presentationnumber <depending_on> the depending on datasource set with set_depending_on_presentationdatasource one or more <dependingfields> sections with the following tags <thisfield> set with add_depending_fields <masterfield> set with add_depending_fields
|
|
|
when data has changed and the row selector is moved to another row, usually the datasource will be automatically updated. If the value is set to false, you have to update the data manually by calling store_changed_data.
|
|
|
if true no depending datasources will be informed when data changes in any kind Default is false |
|
|
if true no data will be sent to the database server when data changes in any kind Default is false |
|
|
if true no visual objects will be informed when data changes in any kind, except the datasource will be deleted Default is false |
|
||||||||||||||||
|
sets the default date and timeformats for new created columns |
|
||||||||||||||||
|
if there are 2 datasources in a 1:n relation it is possible to connect the 2 datasources. Add the master datasource here ( it's the '1'-datasource in the '1:n'-relation). Except of the master datasource you also have to add the connected fields with add_depending_fields This (the depending) datasource will enable/disable automatically when the master datasource will enable/disable. if this datasource is part of a hk_presentation use set_depending_on_presentationdatasource instead
|
|
||||||||||||||||||||
|
if this datasource is part of a hk_presentation object (form or report) then set the depending on datasource with this function. You can get the unique datasource number of a datasource with presentationnumber
|
|
|
convenience function: if e is true the datasource will be enabled by calling enable else it will disable the datasource by calling disable. |
|
||||||||||||
|
it is possible to filter only specific rows from a datasource by setting this filter. just add the conditions with this function.
|
|
||||||||||||
|
sets the name of the datasource
|
|
||||||||||||||||
|
the position will be used for the database designer GUI. Mostly you don't have to manipulate the values |
|
|
If the datasource is of type ds_table you can allow or disallow data changes. |
|
||||||||||||||||
|
the size will be used for the database designer GUI. Mostly you don't have to manipulate the values |
|
||||||||||||
|
it is possible to sort the datasource. just add the conditions with this function.
|
|
||||||||||||||||
|
set your own SQL statement, that will be executed when you enable the datasource. if this datasource is of type "table" it will be automatically created.
|
|
|
temporary filters just work like filters (see set_filter ), but have to be manually activated with set_use_temporaryfilter. When loaded with loaddata temporaryfilters are deactivated by default. |
|
|
If you want to alter an existing table first bring the table in altermode. Define new columns with new_column. Alter it with alter_column and delete a column by calling alter_column. Afterwards you can alter the table by calling alter_table_now |
|
|
If you want to create a new table first bring the table in createmode. Define new columns with new_column. Afterwards you can create the table by calling create_table_now |
|
|
brings the datasource in insertmode. To add a new row call this function, set the data of the new row as usual in the columns (i.e.with hk_column::ashk_string ) and finally call either setmode_normal or store_changed_data. |
|
|
This is the usual mode, where you can browse the data and if the data is not readonly change the data. |
|
|
if the data of the actual row has changed you can manually send the changes to the SQL Server by calling this function. The function will be called automatically before the datasource disables or the row selector will be moved to another row. |
|
|
Start a transaction. If the SQL server does not support transaction this function does nothing
|
|
|
Commits a transaction. If the SQL server does not support transaction this function does nothing
|
|
|
Undo a transaction. If the SQL server does not support transaction this function does nothing
|
|
|
if database driver supports cassensitive column and table names p_casesensitive is true else p_casesensitive is false. Then internally column_by_name() and name() return values in small letters |
1.4.1