doc/groups_data_adapter.dox

   1 /**\r
   2  @page data_adapter Data Adapter module\r
   3 \r
   4  @section Overview\r
   5 Data Adapter module provides capabilities to access Platform data stores(DB).<br>\r
   6 The access operates through Framework DB mapped to Platform data stores(DB).<br>\r
   7 In order to be independent from Platform, internally it keeps mapping information between Framework DB and Platform data stores(DB).<br>\r
   8 Any Platform-dependent operations are executed through Plugins under Plugin Domain "DataConnector" and "DataConverter".<br>\r
   9 \r
  10 Plugins under Plugin Domain "DataConnector" handles conversion between external and Platform internal,<br>\r
  11 and Plugin under Plugin Domain "DataConverter" handles Platform DB item I/O.<br>\r
  12 \r
  13  @image html overview_data_adapter.png "Software architecture of Data Adapter module"\r
  14 \r
  15 Data Adapter module has following sub implementations with each corresponding roles.<br>\r
  16         - <b>Framework DB Accessor</b><br>\r
  17         Provides APIs to manipulate Framework DB items.<br>\r
  18 \r
  19         - <b>Platform DB Accessor</b><br>\r
  20         Provides APIs to manipulate Platform DB items.<br>\r
  21         Such operations are made through Plugins.<br>\r
  22 \r
  23         - <b>Changelog Processer</b><br>\r
  24         Provides APIs to manipulate Framework changelog items.<br>\r
  25         And even internally maintains changelog by catching change notifications from Platform <br>\r
  26         so that User Agent which uses framework may utilize it as sync history.<br>\r
  27 \r
  28         - <b>Converter</b><br>\r
  29         Provides APIs to initialize and compose Platform DB items<br>\r
  30         which Platform doesn't support conversion(between external and Platform internal) for.<br>\r
  31 \r
  32         - <b>LUID Generator</b><br>\r
  33         It guarantees generation of unique ID value used for Framework DB item.<br>\r
  34         It has limitation for maximum range of the generation, which is specified in Framework configuration XML.<br>\r
  35 */\r