File: StorageAdapter.h

package info (click to toggle)
buteo-sync-plugins 0.8.36-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,076 kB
  • sloc: cpp: 8,130; xml: 755; sh: 207; perl: 82; makefile: 11
file content (177 lines) | stat: -rw-r--r-- 5,021 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
 * This file is part of buteo-sync-plugins package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 *
 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef STORAGEADAPTER_H
#define STORAGEADAPTER_H

#include <QMap>
#include <QVector>

#include <buteosyncfw5/StoragePlugin.h>
#include <buteosyncml5/StoragePlugin.h>
#include <buteosyncml5/DataStore.h>
#include <buteosyncml5/SyncItemKey.h>

#include "ItemIdMapper.h"

class StoragePlugin;
class StorageItem;

/*! \brief Adapter to adapt framework storage plugin to SyncML stack storage
 *         plugin
 *
 * This adapter presumes that all DataSync::SyncItem instances passed as parameters
 * to functions of this adapter are originally created by this adapter.
 */
class StorageAdapter : public DataSync::StoragePlugin
{

public:

    /*! \brief Constructor
     *
     * @param aPlugin Plugin that this instance should adapt. Not owned
     */
    StorageAdapter( Buteo::StoragePlugin* aPlugin );

    /*! \brief Destructor
     *
     */
    virtual ~StorageAdapter();

    /*! \brief Returns if this adapter instance is valid
     *
     * @return True if this adapter instance is valid, otherwise false
     */
    bool isValid();

    /*! \brief Returns the FW plugin instance
     *
     * @return Plugin
     */
    Buteo::StoragePlugin* getPlugin() const;

    /*! \brief Initializes adapter
     *
     * Sets up SyncML storage plugin based on FW plugin properties
     *
     * @return True if initialization was successful, otherwise false
     */
    bool init();

    /*! \brief Uninitializes adapter
     *
     * @return True if uninitialization was successful, otherwise false
     */
    bool uninit();

    /*! \see DataSync::StoragePlugin::getSourceURI()
     *
     */
    virtual const QString& getSourceURI() const;

    /*! \see DataSync::StoragePlugin::getSourceURI()
     *
     */
    virtual const DataSync::StorageContentFormatInfo& getFormatInfo() const;

    /*! \see DataSync::StoragePlugin::getMaxObjSize()
     *
     */
    virtual qint64 getMaxObjSize() const;

    /*! \see DataSync::StoragePlugin::getPluginCTCaps()
     *
     */
    virtual QByteArray getPluginCTCaps( DataSync::ProtocolVersion aVersion ) const;

    /*! \see DataSync::StoragePlugin::getPluginExts()
      *
      */
    virtual QByteArray getPluginExts() const;

    /*! \see DataSync::StoragePlugin::getAll()
     *
     */
    virtual bool getAll( QList<DataSync::SyncItemKey>& aKeys );

    /*! \see DataSync::StoragePlugin::getModifications()
     *
     */
    virtual bool getModifications( QList<DataSync::SyncItemKey>& aNewKeys,
                                   QList<DataSync::SyncItemKey>& aReplacedKeys,
                                   QList<DataSync::SyncItemKey>& aDeletedKeys,
                                   const QDateTime& aTimeStamp );

    /*! \see DataSync::StoragePlugin::newItem()
     *
     */
    virtual DataSync::SyncItem* newItem();

    /*! \see DataSync::StoragePlugin::getSyncItem()
     *
     */
    virtual DataSync::SyncItem* getSyncItem( const DataSync::SyncItemKey& aKey );

    /*! \see DataSync::StoragePlugin::getSyncItems()
     *
     */
    virtual QList<DataSync::SyncItem*> getSyncItems( const QList <DataSync::SyncItemKey>& aKeyList );

    /*! \see DataSync::StoragePlugin::addItems()
     *
     */
    virtual QList<StoragePluginStatus> addItems( const QList<DataSync::SyncItem*>& aItems );

    /*! \see DataSync::StoragePlugin::replaceItems()
     *
     */
    virtual QList<StoragePluginStatus> replaceItems( const QList<DataSync::SyncItem*>& aItems );

    /*! \see DataSync::StoragePlugin::deleteItems()
     *
     */
    virtual QList<StoragePluginStatus> deleteItems( const QList<DataSync::SyncItemKey>& aKeys );

protected:

private:

    DataSync::StoragePlugin::StoragePluginStatus convertStatus( Buteo::StoragePlugin::OperationStatus aStatus ) const;

    Buteo::StorageItem* toStorageItem( const DataSync::SyncItem* aSyncItem ) const;


    Buteo::StoragePlugin*               iPlugin;

    QString                             iType;

    DataSync::StorageContentFormatInfo  iFormats;
    QString                             iSourceDB;
    QString                             iTargetDB;

    ItemIdMapper                        iIdMapper;

};

#endif  //  STORAGEADAPTER_H