[KLF Application][KLF Tools][KLF Backend][KLF Home]
KLatexFormula Project
klflibdbengine.h
Go to the documentation of this file.
1 /***************************************************************************
2  * file klflibdbengine.h
3  * This file is part of the KLatexFormula Project.
4  * Copyright (C) 2011 by Philippe Faist
5  * philippe.faist at bluewin.ch
6  * *
7  * This program is free software; you can redistribute it and/or modify *
8  * it under the terms of the GNU General Public License as published by *
9  * the Free Software Foundation; either version 2 of the License, or *
10  * (at your option) any later version. *
11  * *
12  * This program is distributed in the hope that it will be useful, *
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15  * GNU General Public License for more details. *
16  * *
17  * You should have received a copy of the GNU General Public License *
18  * along with this program; if not, write to the *
19  * Free Software Foundation, Inc., *
20  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
21  ***************************************************************************/
22 /* $Id: klflibdbengine.h 603 2011-02-26 23:14:55Z phfaist $ */
23 
24 #ifndef KLFLIBDBENGINE_H
25 #define KLFLIBDBENGINE_H
26 
27 #include <QSqlDatabase>
28 #include <QSqlQuery>
29 
30 #include <klfdefs.h>
31 #include <klflib.h>
32 #include <klflibview.h> // KLFLibLocalFileSchemeGuesser
33 
35 
40 class KLF_EXPORT KLFLibDBConnectionClassUser {
41 public:
42  KLFLibDBConnectionClassUser();
43  virtual ~KLFLibDBConnectionClassUser();
44 
45  inline bool autoDisconnectDB() const { return pAutoDisconnectDB; }
46  inline void setAutoDisconnectDB(bool autodisconnectDB) { pAutoDisconnectDB = autodisconnectDB; }
47  inline QString dbConnectionName() const { return pDBConnectionName; }
48  inline void setDBConnectionName(const QString& name) { pDBConnectionName = name; }
49 
50 protected:
51  bool pAutoDisconnectDB;
52  QString pDBConnectionName;
53 };
54 
55 
56 class KLFLibDBEnginePropertyChangeNotifier;
57 
72 class KLF_EXPORT KLFLibDBEngine : public KLFLibResourceEngine, private KLFLibDBConnectionClassUser
73 {
74  Q_OBJECT
75 
76 public:
83  static KLFLibDBEngine * openUrl(const QUrl& url, QObject *parent = NULL);
84 
96  static KLFLibDBEngine * createSqlite(const QString& fileName, const QString& subresourcename,
97  const QString& subresourcetitle, QObject *parent = NULL);
98 
99 
102  virtual ~KLFLibDBEngine();
103 
104  virtual uint compareUrlTo(const QUrl& other, uint interestFlags = 0xfffffff) const;
105 
106  virtual bool compareDefaultSubResourceEquals(const QString& subResourceName) const;
107 
108  virtual bool canModifyData(const QString& subRes, ModifyType modifytype) const;
109  virtual bool canModifyProp(int propid) const;
110  virtual bool canRegisterProperty(const QString& propName) const;
111 
114  virtual bool validDatabase() const;
116  virtual void setDatabase(const QSqlDatabase& db_connection);
117 
118 
119  virtual QList<KLFLib::entryId> allIds(const QString& subResource);
120  virtual bool hasEntry(const QString&, entryId id);
121  virtual QList<KLFLibEntryWithId> entries(const QString&, const QList<KLFLib::entryId>& idList,
122  const QList<int>& wantedEntryProperties = QList<int>());
123 
124  virtual int query(const QString& subResource, const Query& query, QueryResult *result);
125  virtual QList<QVariant> queryValues(const QString& subResource, int entryPropId);
126 
127  virtual KLFLibEntry entry(const QString& subRes, entryId id);
128  virtual QList<KLFLibEntryWithId> allEntries(const QString& subRes,
129  const QList<int>& wantedEntryProperties = QList<int>());
130 
131  virtual bool canCreateSubResource() const;
132  virtual bool canRenameSubResource() const { return false; }
133  virtual bool canDeleteSubResource(const QString& subResource) const;
134 
135  virtual QVariant subResourceProperty(const QString& subResource, int propId) const;
136 
137  virtual QList<int> subResourcePropertyIdList() const
138  { return QList<int>() << SubResPropTitle << SubResPropViewType << SubResPropLocked; }
139 
140  virtual bool hasSubResource(const QString& subRes) const;
141  virtual QStringList subResourceList() const;
142 
143 public slots:
144 
145  virtual bool createSubResource(const QString& subResource, const QString& subResourceTitle);
146  virtual bool deleteSubResource(const QString& subResource);
147 
148  virtual QList<entryId> insertEntries(const QString& subRes, const KLFLibEntryList& entries);
149  virtual bool changeEntries(const QString& subRes, const QList<entryId>& idlist,
150  const QList<int>& properties, const QList<QVariant>& values);
151  virtual bool deleteEntries(const QString& subRes, const QList<entryId>& idlist);
152 
153  virtual bool saveTo(const QUrl& newPath);
154 
155  virtual bool setSubResourceProperty(const QString& subResource, int propId, const QVariant& value);
156 
157 protected:
158  virtual bool saveResourceProperty(int propId, const QVariant& value);
159 
160 private slots:
163  void resourcePropertyUpdate(int propId);
166  void subResourcePropertyUpdate(const QString& subResource, int propId);
167 
169 
170  void readResourceProperty(int propId);
171 
172  void readDbMetaInfo();
173 
174  void readAvailColumns(const QString& subResource);
175 
176 private:
177  KLFLibDBEngine(const QSqlDatabase& db, bool autoDisconnectDB, const QUrl& url,
178  bool accessshared, QObject *parent);
179 
180  QSqlDatabase pDB;
181 
182  int pDBVersion;
183 
185  QMap<QString,QStringList> pDBAvailColumns;
186 
187  QStringList columnNameList(const QString& subResource, const QList<int>& entryPropList,
188  bool wantIdFirst = true);
189  QStringList detectEntryColumns(const QSqlQuery& q);
190  KLFLibEntry readEntry(const QSqlQuery& q, const QStringList& columns);
191 
192  QVariant dbMakeEntryPropertyValue(const QVariant& entryValue, int entryPropertyId);
193  QVariant dbReadEntryPropertyValue(const QVariant& dbdata, int entryPropertyId);
194 
195  QVariant convertVariantToDBData(const QVariant& value) const;
196  QVariant convertVariantFromDBData(const QVariant& dbdata) const;
197  QVariant encaps(const char *ts, const QString& data) const;
198  QVariant encaps(const char *ts, const QByteArray& data) const;
199  QVariant decaps(const QString& string) const;
200  QVariant decaps(const QByteArray& data) const;
201 
202  bool ensureDataTableColumnsExist(const QString& subResource, const QStringList& columnList);
205  bool ensureDataTableColumnsExist(const QString& subResource);
206 
208  static bool initFreshDatabase(QSqlDatabase db);
211  static bool createFreshDataTable(QSqlDatabase db, const QString& subresource);
212 
213  bool tableExists(const QString& subResource) const;
214 
215  static QString dataTableName(const QString& subResource);
216  static QString quotedDataTableName(const QString& subResource);
217 
218  static QMap<QString,KLFLibDBEnginePropertyChangeNotifier*> pDBPropertyNotifiers;
219  static KLFLibDBEnginePropertyChangeNotifier *dbPropertyNotifierInstance(const QString& dbname);
220 };
221 
222 
223 
224 class KLF_EXPORT KLFLibDBLocalFileSchemeGuesser : public QObject, public KLFLibLocalFileSchemeGuesser
225 {
226 public:
227  KLFLibDBLocalFileSchemeGuesser(QObject *parent) : QObject(parent) { }
228 
229  QString guessScheme(const QString& fileName) const;
230 };
231 
232 
234 class KLF_EXPORT KLFLibDBEngineFactory : public KLFLibEngineFactory
235 {
236  Q_OBJECT
237 public:
238  KLFLibDBEngineFactory(QObject *parent = NULL);
239  virtual ~KLFLibDBEngineFactory() { }
240 
241  virtual QStringList supportedTypes() const;
242  virtual QString schemeTitle(const QString& scheme) const ;
243  virtual uint schemeFunctions(const QString& scheme) const ;
244 
245  virtual QString correspondingWidgetType(const QString& scheme) const;
246  virtual KLFLibResourceEngine *openResource(const QUrl& location, QObject *parent = NULL);
247 
248  virtual KLFLibResourceEngine *createResource(const QString& scheme, const Parameters& parameters,
249  QObject *parent = NULL);
250 };
251 
252 
253 
254 #endif
Generated by doxygen 1.8.2