summaryrefslogtreecommitdiff
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiepim/backend/obackendfactory.h103
-rw-r--r--libopie2/opiepim/core/opimaccessfactory.h100
-rw-r--r--libopie2/opiepim/core/opimglobal.h62
3 files changed, 224 insertions, 41 deletions
diff --git a/libopie2/opiepim/backend/obackendfactory.h b/libopie2/opiepim/backend/obackendfactory.h
index 06421d1..d101373 100644
--- a/libopie2/opiepim/backend/obackendfactory.h
+++ b/libopie2/opiepim/backend/obackendfactory.h
@@ -1,15 +1,15 @@
/*
This file is part of the Opie Project
- Copyright (C) The Main Author <main-author@whereever.org>
+ 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;
@@ -29,122 +29,143 @@
/*
* =====================================================================
* ToDo: Use plugins
* =====================================================================
*/
#ifndef OPIE_BACKENDFACTORY_H_
#define OPIE_BACKENDFACTORY_H_
#include <qstring.h>
#include <qasciidict.h>
#include <qpe/config.h>
+#include <opie2/opimglobal.h>
#include <opie2/otodoaccessxml.h>
#include <opie2/ocontactaccessbackend_xml.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
+ * This class - as the whole PIM Api - is making use of templates
*
* <pre>
* OPimTodoAccessBackend* backend = OBackEndFactory<OPimTodoAccessBackend>::Default("todo", QString::null );
* backend->load();
* </pre>
*
* @author Stefan Eilers
* @version 0.1
*/
template<class T>
class OBackendFactory
{
public:
OBackendFactory() {};
- enum BACKENDS {
- TODO,
- CONTACT,
- DATE
- };
-
/**
- * Returns a backend implementation for backendName
- * @param backendName the type of the backend
- * @param appName will be passed on to the backend
+ * Returns a 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.
*/
- static T* Default( const QString backendName, const QString& appName ){
-
- // __asm__("int3");
-
- Config config( "pimaccess" );
- config.setGroup ( backendName );
- QString backend = config.readEntry( "usebackend" );
+ static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle database,
+ const QString& appName ){
+ qWarning("Selected backend for %d is: %d", type, database );
- qWarning("Selected backend for %s is: %s", backendName.latin1(), backend.latin1() );
-
- QAsciiDict<int> dict ( 3 );
- dict.setAutoDelete ( TRUE );
-
- dict.insert( "todo", new int (TODO) );
- dict.insert( "contact", new int (CONTACT) );
- dict.insert( "datebook", new int(DATE) );
-
- int *find = dict[ backendName ];
- if (!find ) return 0;
-
- switch ( *find ){
- case TODO:
+ switch ( type ){
+ case OPimGlobal::TODOLIST:
#ifdef __USE_SQL
- if ( backend == "sql" )
+ if ( database == OPimGlobal::SQL )
return (T*) new OPimTodoAccessBackendSQL("");
#else
- if ( backend == "sql" )
+ if ( database == OPimGlobal::SQL )
qWarning ("OBackendFactory:: sql Backend for TODO not implemented! Using XML instead!");
#endif
return (T*) new OPimTodoAccessXML( appName );
- case CONTACT:
+ case OPimGlobal::CONTACTLIST:
#ifdef __USE_SQL
- if ( backend == "sql" )
+ if ( database == OPimGlobal::SQL )
return (T*) new OPimContactAccessBackend_SQL("");
#else
- if ( backend == "sql" )
+ if ( database == OPimGlobal::SQL )
qWarning ("OBackendFactory:: sql Backend for CONTACT not implemented! Using XML instead!");
#endif
return (T*) new OPimContactAccessBackend_XML( appName );
- case DATE:
+ case OPimGlobal::DATEBOOK:
#ifdef __USE_SQL
- if ( backend == "sql" )
+ if ( database == OPimGlobal::SQL )
return (T*) new ODateBookAccessBackend_SQL("");
#else
- if ( backend == "sql" )
+ if ( database == OPimGlobal::SQL )
qWarning("OBackendFactory:: sql Backend for DATEBOOK not implemented! Using XML instead!");
#endif
return (T*) new ODateBookAccessBackend_XML( appName );
default:
- return NULL;
+ return (T*) NULL;
}
}
+
+ /**
+ * Returns the default backend implementation for backendName. Which one is used, is defined
+ * by the configfile "pimaccess.conf".
+ * @param backendName the type of the backend (use "todo", "contact" or "datebook" )
+ * @param appName The name of your application. It will be passed on to the backend
+ */
+ static T* Default( const QString backendName, const QString& appName ){
+
+ QAsciiDict<int> dictBackends( OPimGlobal::_END_PimType );
+ dictBackends.setAutoDelete ( TRUE );
+
+ dictBackends.insert( "todo", new int (OPimGlobal::TODOLIST) );
+ dictBackends.insert( "contact", new int (OPimGlobal::CONTACTLIST) );
+ dictBackends.insert( "datebook", new int(OPimGlobal::DATEBOOK) );
+
+ 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) );
+
+ Config config( "pimaccess" );
+ config.setGroup ( backendName );
+ QString db_String = config.readEntry( "usebackend" );
+
+ int* db_find = dictDbTypes[ db_String ];
+ int* backend_find = dictBackends[ backendName ];
+ if ( !backend_find || !db_find ) return NULL;
+
+ qDebug( "OBackendFactory::Default -> Backend is %s, Database is %s", backendName.latin1(),
+ db_String.latin1() );
+
+ return create( (OPimGlobal::PimType) *backend_find, (OPimGlobal::DatabaseStyle) *db_find, appName );
+
+ }
private:
OBackendPrivate* d;
+
};
}
#endif
diff --git a/libopie2/opiepim/core/opimaccessfactory.h b/libopie2/opiepim/core/opimaccessfactory.h
new file mode 100644
index 0000000..ba99a15
--- a/dev/null
+++ b/libopie2/opiepim/core/opimaccessfactory.h
@@ -0,0 +1,100 @@
+/*
+ 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
+ */
+ static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, const QString& appName ){
+
+ switch ( type ){
+ case OPimGlobal::TODOLIST:
+ return dynamic_cast<T*>( new OPimTodoAccess( OBackendFactory<OPimTodoAccessBackend>::create( type, dbStyle, appName ) ) );
+ case OPimGlobal::CONTACTLIST:
+ return dynamic_cast<T*>( new OPimContactAccess( QString::null, QString::null, OBackendFactory<OPimContactAccessBackend>::create( type, dbStyle, appName ) ) );
+ case OPimGlobal::DATEBOOK:
+ return dynamic_cast<T*>( new ODateBookAccess( OBackendFactory<ODateBookAccessBackend>::create( type, dbStyle, appName ) ) );
+ default:
+ return 0l;
+
+ }
+ }
+};
+
+}
+
+
+#endif
diff --git a/libopie2/opiepim/core/opimglobal.h b/libopie2/opiepim/core/opimglobal.h
new file mode 100644
index 0000000..2d336b4
--- a/dev/null
+++ b/libopie2/opiepim/core/opimglobal.h
@@ -0,0 +1,62 @@
+/*
+ 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 __OPIMGLOBAL_H_
+#define __OPIMGLOBAL_H_
+
+namespace Opie{
+namespace Pim{
+
+
+ /**
+ * Contains global types and enums for the PIM-API
+ */
+class OPimGlobal{
+ public:
+ enum PimType {
+ TODOLIST,
+ CONTACTLIST,
+ DATEBOOK,
+ _END_PimType
+ };
+
+ enum DatabaseStyle {
+ XML,
+ SQL,
+ VCARD,
+ _END_DatabaseStyle
+ };
+
+
+};
+
+}
+}
+
+
+#endif