| -rw-r--r-- | libopie2/opiepim/backend/obackendfactory.h | 6 | ||||
| -rw-r--r-- | libopie2/opiepim/core/opimaccessfactory.h | 22 |
2 files changed, 16 insertions, 12 deletions
diff --git a/libopie2/opiepim/backend/obackendfactory.h b/libopie2/opiepim/backend/obackendfactory.h index c8a4627..6f46652 100644 --- a/libopie2/opiepim/backend/obackendfactory.h +++ b/libopie2/opiepim/backend/obackendfactory.h @@ -1,222 +1,224 @@ /* This file is part of the Opie Project Copyright (C) Stefan Eilers <eilers.stefan@epost.de> =. Copyright (C) The Opie Team <opie-devel@handhelds.org> .=l. .>+-= _;:, .> :=|. This program is free software; you can .> <`_, > . <= redistribute it and/or modify it under :`=1 )Y*s>-.-- : the terms of the GNU Library General Public .="- .-=="i, .._ License as published by the Free Software - . .-<_> .<> Foundation; either version 2 of the License, ._= =} : or (at your option) any later version. .%`+i> _;_. .i_,=:_. -<s. This program 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 ..}^=.= = ; Library General Public License for more ++= -. .` .: details. : = ...= . :.=- -. .:....=;==+<; You should have received a copy of the GNU -_. . . )=. = Library General Public License along with -- :-=` this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /* * ===================================================================== * ToDo: Use plugins * ===================================================================== */ #ifndef OPIE_BACKENDFACTORY_H_ #define OPIE_BACKENDFACTORY_H_ #include <qstring.h> #include <qasciidict.h> #include <qpe/config.h> #include <opie2/opimaccessbackend.h> #include <opie2/opimglobal.h> #include <opie2/otodoaccessxml.h> #include <opie2/otodoaccessvcal.h> #include <opie2/ocontactaccessbackend_xml.h> #include <opie2/ocontactaccessbackend_vcard.h> #include <opie2/odatebookaccessbackend_xml.h> #ifdef __USE_SQL #include <opie2/otodoaccesssql.h> #include <opie2/ocontactaccessbackend_sql.h> #include <opie2/odatebookaccessbackend_sql.h> #endif using namespace Opie; using namespace Opie::Pim; namespace Opie { class OBackendPrivate; /** * This class is our factory. It will give us the default implementations * of at least Todolist, Contacts and Datebook. In the future this class will * allow users to switch the backend with ( XML->SQLite ) without the need * to recompile.# * This class - as the whole PIM Api - is making use of templates * * <pre> - * OPimTodoAccessBackend* backend = OBackEndFactory<OPimTodoAccessBackend>::Default("todo", QString::null ); + * OPimTodoAccessBackend* backend = OBackEndFactory<OPimTodoAccessBackend>::Default( OPimGlobal::TODOLIST, QString::null ); * backend->load(); * </pre> * * @author Stefan Eilers * @version 0.1 */ template<class T> class OBackendFactory { public: OBackendFactory() {}; /** * Returns a selected backend implementation * @param type the type of the backend * @param database the type of the used database * @param appName The name of your application. It will be passed on to the backend. * @param filename Filename of the database file if you don't want to access the default + * @see OPimGlobal() */ static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle database, const QString& appName, const QString& filename = QString::null ){ qWarning("Selected backend for %d is: %d", type, database ); // If we should use the dafult database style, we have to request it OPimGlobal::DatabaseStyle use_database = database; if ( use_database == OPimGlobal::DEFAULT ){ use_database = defaultDB( type ); } switch ( type ){ case OPimGlobal::TODOLIST: switch ( use_database ){ default: // Use SQL if something weird is given. // Fall through !! case OPimGlobal::SQL: #ifdef __USE_SQL return (T*) new OPimTodoAccessBackendSQL( filename ); break; #else qWarning ("OBackendFactory:: sql Backend for TODO not implemented! Using XML instead!"); // Fall through !! #endif case OPimGlobal::XML: return (T*) new OPimTodoAccessXML( appName, filename ); break; case OPimGlobal::VCARD: return (T*) new OPimTodoAccessVCal( filename ); break; } case OPimGlobal::CONTACTLIST: switch ( use_database ){ default: // Use SQL if something weird is given. // Fall through !! case OPimGlobal::SQL: #ifdef __USE_SQL return (T*) new OPimContactAccessBackend_SQL( appName, filename ); break; #else qWarning ("OBackendFactory:: sql Backend for CONTACT not implemented! Using XML instead!"); // Fall through !! #endif case OPimGlobal::XML: return (T*) new OPimContactAccessBackend_XML( appName, filename ); break; case OPimGlobal::VCARD: return (T*) new OPimContactAccessBackend_VCard( appName, filename ); break; } case OPimGlobal::DATEBOOK: switch ( use_database ){ default: // Use SQL if something weird is given. // Fall through !! case OPimGlobal::SQL: #ifdef __USE_SQL return (T*) new ODateBookAccessBackend_SQL( appName, filename ); break; #else qWarning("OBackendFactory:: sql Backend for DATEBOOK not implemented! Using XML instead!"); // Fall through !! #endif case OPimGlobal::XML: return (T*) new ODateBookAccessBackend_XML( appName, filename ); break; case OPimGlobal::VCARD: qWarning("OBackendFactory:: VCal Backend for DATEBOOK not implemented!"); return (T*) NULL; break; } default: return (T*) NULL; } } /** * Returns the style of the default database which is used to contact PIM data. * @param type the type of the backend - * @see OPimGlobal + * @see OPimGlobal() */ static OPimGlobal::DatabaseStyle defaultDB( OPimGlobal::PimType type ){ QString group_name; switch ( type ){ case OPimGlobal::TODOLIST: group_name = "todo"; break; case OPimGlobal::CONTACTLIST: group_name = "contact"; break; case OPimGlobal::DATEBOOK: group_name = "datebook"; break; default: group_name = "unknown"; } Config config( "pimaccess" ); config.setGroup ( group_name ); QString db_String = config.readEntry( "usebackend", "xml" ); QAsciiDict<int> dictDbTypes( OPimGlobal::_END_DatabaseStyle ); dictDbTypes.setAutoDelete( TRUE ); dictDbTypes.insert( "xml", new int (OPimGlobal::XML) ); dictDbTypes.insert( "sql", new int (OPimGlobal::SQL) ); dictDbTypes.insert( "vcard", new int (OPimGlobal::VCARD) ); int* db_find = dictDbTypes[ db_String ]; if ( !db_find ) return OPimGlobal::UNKNOWN; return (OPimGlobal::DatabaseStyle) *db_find; } /** * Returns the default backend implementation for backendName. Which one is used, is defined * by the configfile "pimaccess.conf". * @param type The type of the backend (@see OPimGlobal()) * @param appName The name of your application. It will be passed on to the backend + * @see OPimGlobal() */ static T* defaultBackend( OPimGlobal::PimType type, const QString& appName ){ return create( type, OPimGlobal::DEFAULT, appName ); } private: OBackendPrivate* d; }; } #endif diff --git a/libopie2/opiepim/core/opimaccessfactory.h b/libopie2/opiepim/core/opimaccessfactory.h index ee55ba5..3cd448e 100644 --- a/libopie2/opiepim/core/opimaccessfactory.h +++ b/libopie2/opiepim/core/opimaccessfactory.h @@ -1,120 +1,122 @@ /* This file is part of the Opie Project Copyright (C) Stefan Eilers <eilers.stefan@epost.de> =. Copyright (C) The Opie Team <opie-devel@handhelds.org> .=l. .>+-= _;:, .> :=|. This program is free software; you can .> <`_, > . <= redistribute it and/or modify it under :`=1 )Y*s>-.-- : the terms of the GNU Library General Public .="- .-=="i, .._ License as published by the Free Software - . .-<_> .<> Foundation; either version 2 of the License, ._= =} : or (at your option) any later version. .%`+i> _;_. .i_,=:_. -<s. This program 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 ..}^=.= = ; Library General Public License for more ++= -. .` .: details. : = ...= . :.=- -. .:....=;==+<; You should have received a copy of the GNU -_. . . )=. = Library General Public License along with -- :-=` this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef __OPIE_OPIMACCESSFACTORY_H_ #define __OPIE_OPIMACCESSFACTORY_H_ #include <opie2/opimglobal.h> #include <opie2/obackendfactory.h> #include <opie2/ocontactaccess.h> #include <opie2/otodoaccess.h> #include <opie2/odatebookaccess.h> using namespace Opie::Pim; namespace Opie { /** * This class is our factory for creating PIM access objects. You should use these objects to load, store and search * information in our PIM databases. Currently we support objects for accessing the datebook, the contact- and the * todolist. * @see OPimGlobal for more information of used values. * * This class - as the whole PIM Api - is making use of templates * * Example for getting an access object for the XML database of todolist: * <pre> * OPimTodoAccess* access = OPimAccessFactory<OPimTodoAccess>::create( OPimGlobal::TODOLIST, OPimGlobal::XML, "example" ); * </pre> * * @author Stefan Eilers * @version 0.1 */ template<class T> class OPimAccessFactory { public: - - // Maybe we should introduce a global class for storing such global enums - // (something like opimglobal.h) ? (eilers) - OPimAccessFactory() {}; /** * Returns the selected PIM access-object. * @param type Type of the selected database (addressbook, todolist or datebook) * @param dbStyle Which database style should be used (xml, sql, vcard) * @param appName "Name" of your application. This should be any constant string which is used * by some backends for creating special files (i.e.journal files). Please keep the * string unique for your application ! - * @see OPimGlobal + * @param fileName Filename of database if something different as the default should be used. + * @see OPimGlobal() */ - static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, const QString& appName ){ + static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, const QString& appName, + const QString& fileName = QString::null ){ OPimBase *base; switch ( type ){ case OPimGlobal::TODOLIST: - base = new OPimTodoAccess( OBackendFactory<OPimTodoAccessBackend>::create( type, dbStyle, appName ) ); + base = new OPimTodoAccess( OBackendFactory<OPimTodoAccessBackend>::create( type, dbStyle, + appName, fileName ) ); break; case OPimGlobal::CONTACTLIST: - base = new OPimContactAccess( QString::null, QString::null, OBackendFactory<OPimContactAccessBackend>::create( type, dbStyle, appName ) ); + base = new OPimContactAccess( QString::null, QString::null, + OBackendFactory<OPimContactAccessBackend>::create( type, dbStyle, + appName, fileName ) ); break; case OPimGlobal::DATEBOOK: - base = new ODateBookAccess( OBackendFactory<ODateBookAccessBackend>::create( type, dbStyle, appName ) ); + base = new ODateBookAccess( OBackendFactory<ODateBookAccessBackend>::create( type, dbStyle, + appName, fileName ) ); break; default: return 0l; } return static_cast<T*>( base ); } /** * Returns the selected PIM access-object, using the default database style * Which style is selected is defined in the configfile "pimaccess.conf" in * the directory "Settings" * @param type Type of the selected database (addressbook, todolist or datebook) * @param appName "Name" of your application. This should be any constant string which is used * by some backends for creating special files (i.e.journal files). Please keep the * string unique for your application ! - * @see OPimGlobal + * @see OPimGlobal() * */ static T* defaultAccess( typename OPimGlobal::PimType type, const QString& appName ){ return create( type, OPimGlobal::DEFAULT, appName ); } }; } #endif |