activityfw/activitydatabase/hsactivitydbserver/inc/activitystorage.h
author hgs
Fri, 30 Apr 2010 15:22:08 +0300
changeset 93 82b66994846c
permissions -rw-r--r--
201017
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
93
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
#ifndef ACTIVITYSTORAGE_H
hgs
parents:
diff changeset
    18
#define ACTIVITYSTORAGE_H
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#define __E32SVR_H__
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32std.h>
hgs
parents:
diff changeset
    23
#include <e32base.h>
hgs
parents:
diff changeset
    24
#include <d32dbms.h>    // RDbStoreDatabase
hgs
parents:
diff changeset
    25
#include <s32file.h>    // CFileStore & CPermanentFileStore
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/**
hgs
parents:
diff changeset
    28
 *  CActivityStorage
hgs
parents:
diff changeset
    29
 * 
hgs
parents:
diff changeset
    30
 */
hgs
parents:
diff changeset
    31
class CActivityStorage : public CBase
hgs
parents:
diff changeset
    32
    {
hgs
parents:
diff changeset
    33
public:
hgs
parents:
diff changeset
    34
    /**
hgs
parents:
diff changeset
    35
     * Destructor.
hgs
parents:
diff changeset
    36
     */
hgs
parents:
diff changeset
    37
    ~CActivityStorage();
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
    /**
hgs
parents:
diff changeset
    40
     * Two-phased constructor.
hgs
parents:
diff changeset
    41
     * @param session - initialized session to file system
hgs
parents:
diff changeset
    42
     */
hgs
parents:
diff changeset
    43
    static CActivityStorage* NewL(RFs& session);
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
    /**
hgs
parents:
diff changeset
    46
     * Register new activity
hgs
parents:
diff changeset
    47
     * @param appId - application id
hgs
parents:
diff changeset
    48
     * @param actId - activity id
hgs
parents:
diff changeset
    49
     * @param data - activity data
hgs
parents:
diff changeset
    50
     */
hgs
parents:
diff changeset
    51
    void AddActivityL(TInt appId,const TDesC8& actId, const TDesC8& data);
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
    /**
hgs
parents:
diff changeset
    54
     * Update activity
hgs
parents:
diff changeset
    55
     * @param appId - application id
hgs
parents:
diff changeset
    56
     * @param actId - activity id
hgs
parents:
diff changeset
    57
     * @param data - activity data
hgs
parents:
diff changeset
    58
     */
hgs
parents:
diff changeset
    59
    void UpdateActivityL(TInt appId,const TDesC8& actId, const TDesC8& data);
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
    /**
hgs
parents:
diff changeset
    62
     * Delete activity
hgs
parents:
diff changeset
    63
     * @param appId - application id
hgs
parents:
diff changeset
    64
     * @param actId - activity id
hgs
parents:
diff changeset
    65
     */
hgs
parents:
diff changeset
    66
    void DeleteActivityL(TInt appId,const TDesC8& actId);
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
    /**
hgs
parents:
diff changeset
    69
     * Delete activity
hgs
parents:
diff changeset
    70
     * @param appId - application id
hgs
parents:
diff changeset
    71
     */
hgs
parents:
diff changeset
    72
    void DeleteActivitiesL(TInt appId);
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
    /**
hgs
parents:
diff changeset
    75
     * Serialize all activity into the buffer
hgs
parents:
diff changeset
    76
     * @param dst - destination buffer
hgs
parents:
diff changeset
    77
     */
hgs
parents:
diff changeset
    78
    void ActivitiesL(RBuf8 &dst);
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
    /**
hgs
parents:
diff changeset
    81
     * Serialize application activity into the buffer
hgs
parents:
diff changeset
    82
     * @param dst - destination buffer
hgs
parents:
diff changeset
    83
     * @param appId - application id
hgs
parents:
diff changeset
    84
     */
hgs
parents:
diff changeset
    85
    void ActivitiesL(RBuf8 &dst, TInt appId);
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
private:
hgs
parents:
diff changeset
    88
    /**
hgs
parents:
diff changeset
    89
     * Constructor for performing 1st stage construction
hgs
parents:
diff changeset
    90
     * @param session - initialized session to file system
hgs
parents:
diff changeset
    91
     */
hgs
parents:
diff changeset
    92
    CActivityStorage(RFs& session);
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
    /**
hgs
parents:
diff changeset
    95
     * EPOC default constructor for performing 2nd stage construction
hgs
parents:
diff changeset
    96
     */
hgs
parents:
diff changeset
    97
    void ConstructL();
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
    /**
hgs
parents:
diff changeset
   100
     * Create database and its structure
hgs
parents:
diff changeset
   101
     * @param databaseFile - database file path
hgs
parents:
diff changeset
   102
     */
hgs
parents:
diff changeset
   103
    void CreateDbL(const TDesC& databaseFile);
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
    /**
hgs
parents:
diff changeset
   106
     * Open database
hgs
parents:
diff changeset
   107
     * @param databaseFile - database file path
hgs
parents:
diff changeset
   108
     */
hgs
parents:
diff changeset
   109
    void OpenDbL(const TDesC& databaseFile);
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
    /**
hgs
parents:
diff changeset
   112
     * Create database structure
hgs
parents:
diff changeset
   113
     */
hgs
parents:
diff changeset
   114
    void CreateTableL();
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
    /**
hgs
parents:
diff changeset
   117
     * Serialize activity into buffer
hgs
parents:
diff changeset
   118
     * @param dst - destination buffer
hgs
parents:
diff changeset
   119
     */
hgs
parents:
diff changeset
   120
    void GetActivitiesL(const TDesC& dst);
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
    /**
hgs
parents:
diff changeset
   123
     * Format query to select activity row
hgs
parents:
diff changeset
   124
     * @param appId - application id
hgs
parents:
diff changeset
   125
     * @param actId - activity id
hgs
parents:
diff changeset
   126
     * @return formated sql query
hgs
parents:
diff changeset
   127
     */
hgs
parents:
diff changeset
   128
    HBufC* SelectRowLC(TInt appId, const TDesC8& actId) const;
hgs
parents:
diff changeset
   129
    
hgs
parents:
diff changeset
   130
    /**
hgs
parents:
diff changeset
   131
     * Format query to select activities for application
hgs
parents:
diff changeset
   132
     * @param appId - application id
hgs
parents:
diff changeset
   133
     * @return formated sql query
hgs
parents:
diff changeset
   134
     */
hgs
parents:
diff changeset
   135
    HBufC* SelectRowsLC(TInt appId) const;
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
    /**
hgs
parents:
diff changeset
   138
     * Format query to delete activity
hgs
parents:
diff changeset
   139
     * @param appId - application id
hgs
parents:
diff changeset
   140
     * @param actId - activity id
hgs
parents:
diff changeset
   141
     * @return formated sql query
hgs
parents:
diff changeset
   142
     */
hgs
parents:
diff changeset
   143
    HBufC* DeleteRowLC(TInt appId, const TDesC8& actId) const;
hgs
parents:
diff changeset
   144
    
hgs
parents:
diff changeset
   145
    /**
hgs
parents:
diff changeset
   146
     * Format query to delete activities for application
hgs
parents:
diff changeset
   147
     * @param appId - application id
hgs
parents:
diff changeset
   148
     * @return formated sql query
hgs
parents:
diff changeset
   149
     */
hgs
parents:
diff changeset
   150
    HBufC* DeleteRowsLC(TInt appId) const;
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
    /**
hgs
parents:
diff changeset
   153
     * Format sql query
hgs
parents:
diff changeset
   154
     * @format - sql format string
hgs
parents:
diff changeset
   155
     * @param appId - application id
hgs
parents:
diff changeset
   156
     * @param actId - activity id
hgs
parents:
diff changeset
   157
     * @return formated sql query
hgs
parents:
diff changeset
   158
     */
hgs
parents:
diff changeset
   159
    HBufC* BuildQueryLC(const TDesC& format, TInt appId, const TDesC8& actId) const;
hgs
parents:
diff changeset
   160
hgs
parents:
diff changeset
   161
    /**
hgs
parents:
diff changeset
   162
     * Count require buffer size to serialize activity query result
hgs
parents:
diff changeset
   163
     * @param data - sql query result
hgs
parents:
diff changeset
   164
     * @return reuired buffer size to seriazlie activity
hgs
parents:
diff changeset
   165
     */
hgs
parents:
diff changeset
   166
    TInt DataSizeL(RDbRowSet& data)const;
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
    /**
hgs
parents:
diff changeset
   169
     * Serialize activity query result to preallocated buffer
hgs
parents:
diff changeset
   170
     * @param dst - preallocated buffer
hgs
parents:
diff changeset
   171
     * @param view - sql query result
hgs
parents:
diff changeset
   172
     */
hgs
parents:
diff changeset
   173
    void ExternalizeL(TDes8& dst, RDbRowSet& view)const;
hgs
parents:
diff changeset
   174
hgs
parents:
diff changeset
   175
    /**
hgs
parents:
diff changeset
   176
     * Execute sql query and result serialize into buffer
hgs
parents:
diff changeset
   177
     * @param dst - destination result buffer
hgs
parents:
diff changeset
   178
     * @param query - sql activity query 
hgs
parents:
diff changeset
   179
     */
hgs
parents:
diff changeset
   180
    void ActivitiesL(RBuf8& dst, const TDesC& query);
hgs
parents:
diff changeset
   181
hgs
parents:
diff changeset
   182
    /**
hgs
parents:
diff changeset
   183
     * Get activity for update
hgs
parents:
diff changeset
   184
     * @param query - destination query result
hgs
parents:
diff changeset
   185
     * @param appId - application id
hgs
parents:
diff changeset
   186
     * @param actId - activity id
hgs
parents:
diff changeset
   187
     */
hgs
parents:
diff changeset
   188
    void GetActivityForUpdateL(RDbView& query, TInt appId, const TDesC8& actId);
hgs
parents:
diff changeset
   189
hgs
parents:
diff changeset
   190
private:
hgs
parents:
diff changeset
   191
    RFs& mFsSession;
hgs
parents:
diff changeset
   192
    RDbStoreDatabase mActDb;/* For database operations                 */
hgs
parents:
diff changeset
   193
    CFileStore* mFileStore;  /* For creating and opening database files */
hgs
parents:
diff changeset
   194
};
hgs
parents:
diff changeset
   195
hgs
parents:
diff changeset
   196
#endif // ACTIVITYSTORAGE_H