Store table macros
|
Defines |
| #define | BEGIN_STORE_TABLE(Class, parent, table) |
| | This macro defines begin of store table definition.
|
| #define | BIND_CLA(member, filter_class, fkname, coll_id, table_name) |
| | Macro for storing subobjects from various collections using custom root table name and dba_coll_id field.
|
| #define | BIND_COL(member, filter_class, fkname) |
| | Macro for storing list of related objects.
|
| #define | BIND_DAT(member, filter_class, field) |
| | This macro defines class member binded to relation field that shoud be converted to date or time value in archive.
|
| #define | BIND_FLT(member, filter_class, field) |
| | This macro defines class member binded to relation field that shoud be converted to real value in archive.
|
| #define | BIND_INT(member, filter_class, field) |
| | This macro defines class member binded to relation field that shoud be converted to numeric value in archive.
|
| #define | BIND_STB(member) |
| | This macro transfers all members binded from one table to another one.
|
| #define | BIND_STR(member, filter_class, field) |
| | This macro defines class member binded to relation field that shoud be converted to text in archive.
|
| #define | DECLARE_STORE_TABLE() |
| | This macro declares store table inside Storeable derived class.
|
|
#define | END_STORE_TABLE() |
| | This macro defines end of store table.
|
Define Documentation
| #define BEGIN_STORE_TABLE |
( |
Class, |
|
|
parent, |
|
|
table |
|
) |
|
|
|
|
This macro defines begin of store table definition.
- Parameters:
-
| Class | name of class that owns this table |
| parent | name of parent storeable class |
| table | name of relation where objects will be serialized (could be NULL) |
If table is NULL then name of relation of parent store table is used. If last table in hierarchy has NULL relation name you have to provide relation name in open() method of stream or serialize using BIND_STB(member). |
| #define BIND_CLA |
( |
member, |
|
|
filter_class, |
|
|
fkname, |
|
|
coll_id, |
|
|
table_name |
|
) |
|
|
|
|
Macro for storing subobjects from various collections using custom root table name and dba_coll_id field.
This macro must be used instead of BIND_COL(member,filter_class,fkname), when:
- objects in member list should be stored in different relation that specified in object store table
- there are two or more members that holds objects of the same type.
- Parameters:
-
| member | member that holds list of storeable derived objects. |
| filter_class | name of dba::CollectionFilter that will perform iteration on member |
| fkname | name of column that holds foreign key to parent object |
| coll_id | numeric value that identifies collection - may be NULL |
| table_name | name of relation where objects from member collection should be stored. |
|
| #define BIND_COL |
( |
member, |
|
|
filter_class, |
|
|
fkname |
|
) |
|
|
|
|
Macro for storing list of related objects.
- Warning:
- if you need to add BIND_COL for two or more lists of objects of the same type you have to use BIND_CLA(member,filter_class,fkname,coll_id,table_name) instead of this macro
- Parameters:
-
| member | member that holds list of storeable derived objects. |
| filter_class | name of dba::CollectionFilter that will perform iteration on member |
| fkname | name of column that holds foreign key to parent object |
|
| #define BIND_DAT |
( |
member, |
|
|
filter_class, |
|
|
field |
|
) |
|
|
|
|
This macro defines class member binded to relation field that shoud be converted to date or time value in archive.
- Parameters:
-
| member | name of member. Must be prefixed with class name. |
| filter_class | name of dba::StoreableFilter derived class that should peform conversion |
| field | name of column in relation where member should be stored |
|
| #define BIND_FLT |
( |
member, |
|
|
filter_class, |
|
|
field |
|
) |
|
|
|
|
This macro defines class member binded to relation field that shoud be converted to real value in archive.
- Parameters:
-
| member | name of member. Must be prefixed with class name. |
| filter_class | name of dba::StoreableFilter derived class that should peform conversion |
| field | name of column in relation where member should be stored |
|
| #define BIND_INT |
( |
member, |
|
|
filter_class, |
|
|
field |
|
) |
|
|
|
|
This macro defines class member binded to relation field that shoud be converted to numeric value in archive.
- Parameters:
-
| member | name of member. Must be prefixed with class name. |
| filter_class | name of dba::StoreableFilter derived class that should peform conversion |
| field | name of column in relation where member should be stored |
|
| #define BIND_STB |
( |
member |
|
) |
|
|
|
|
This macro transfers all members binded from one table to another one.
Detailed. |
| #define BIND_STR |
( |
member, |
|
|
filter_class, |
|
|
field |
|
) |
|
|
|
|
This macro defines class member binded to relation field that shoud be converted to text in archive.
- Parameters:
-
| member | name of member. Must be prefixed with class name. |
| filter_class | name of dba::StoreableFilter derived class that should peform conversion |
| field | name of column in relation where member should be stored |
|
| #define DECLARE_STORE_TABLE |
( |
|
) |
|
|
|
|
This macro declares store table inside Storeable derived class.
Store table is used to define what members of class should be serialized and how. |
|
|
|