Added some docu to the interface and now using the cache infrastucture by zecke.. :)

8 files changed, 98 insertions, 174 deletions

diff --git a/libopie/pim/ocontactaccess.cpp b/libopie/pim/ocontactaccess.cpp
index e8c0a45..2ca0283 100644
--- a/libopie/pim/ocontactaccess.cpp
+++ b/libopie/pim/ocontactaccess.cpp
@@ -22,4 +22,7 @@
  * History:
  * $Log$
+ * Revision 1.5  2002/10/16 10:52:40  eilers
+ * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
+ *
  * Revision 1.4  2002/10/14 16:21:54  eilers
  * Some minor interface updates
@@ -63,6 +66,5 @@
 OContactAccess::OContactAccess ( const QString appname, const QString ,
 			 OContactAccessBackend* end, bool autosync ):
-	OPimAccessTemplate<OContact>( end ),
-	m_changed ( false )
+	OPimAccessTemplate<OContact>( end )
 {
         /* take care of the backend. If there is no one defined, we 
@@ -95,13 +97,8 @@ OContactAccess::~OContactAccess ()
 	 * do it for him..
 	 */
-	if ( m_changed ) 
 		save();
 	// delete m_backEnd; is done by template..
 }
 
-bool OContactAccess::load()
-{
-	return ( m_backEnd->load() );
-}
 
 bool OContactAccess::save ()
@@ -111,18 +108,14 @@ bool OContactAccess::save ()
 	 * Therefore: Reload database and merge the data...
 	 */
-	if ( m_backEnd->wasChangedExternally() )
+	if ( OPimAccessTemplate<OContact>::wasChangedExternally() )
 		reload();
 
-	if ( m_changed ){ 
-		bool status = m_backEnd->save();
+	bool status = OPimAccessTemplate<OContact>::save();
 		if ( !status ) return false;
 
-		m_changed = false;
 		/* Now tell everyone that new data is available.
 		 */
 		QCopEnvelope e( "QPE/PIM", "addressbookUpdated()" );
 
-	}
-
 	return true;
 }
@@ -138,27 +131,4 @@ bool OContactAccess::hasQuerySettings ( int querySettings ) const
 }
 
-bool OContactAccess::add ( const OContact& newcontact )
-{
-	m_changed = true;
-	return ( m_backEnd->add ( newcontact ) );
-}
-
-bool OContactAccess::replace ( const OContact& contact )
-{
-	m_changed = true;
-	return ( m_backEnd->replace ( contact ) );
-}
-
-bool OContactAccess::remove ( const OContact& t )
-{
-	m_changed = true;
-	return ( m_backEnd->remove ( t.uid() ) );
-}
-
-bool OContactAccess::remove ( int uid )
-{
-	m_changed = true;
-	return ( m_backEnd->remove ( uid ) );
-}
 
 bool OContactAccess::wasChangedExternally()const
@@ -168,9 +138,4 @@ bool OContactAccess::wasChangedExternally()const
 
 
-bool OContactAccess::reload()
-{
-	return ( m_backEnd->reload() );
-}
-
 void OContactAccess::copMessage( const QCString &msg, const QByteArray & )
 {
diff --git a/libopie/pim/ocontactaccess.h b/libopie/pim/ocontactaccess.h
index adc66cf..da9c942 100644
--- a/libopie/pim/ocontactaccess.h
+++ b/libopie/pim/ocontactaccess.h
@@ -18,4 +18,7 @@
  * History:
  * $Log$
+ * Revision 1.3  2002/10/16 10:52:40  eilers
+ * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
+ *
  * Revision 1.2  2002/10/14 16:21:54  eilers
  * Some minor interface updates
@@ -92,36 +95,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 	bool hasQuerySettings ( int querySettings ) const;
 
-	/** Add Contact to database.
-	 * @param newcontact The contact to add.
-	 * @return <i>true</i> if added successfully.
-	 */
-	bool add (const OContact& newcontact);
-
-	/** Replace contact.
-	 * Replaces given contact with contact with the user id <i>uid</i>.
-	 * @param uid The user ID
-	 * @param contact The new contact
-	 * @return <i>true</i> if successful.
-	 */
-	bool replace ( const OContact& contact );
-
-	/** Remove contact.
-	 * Removes contact with the user id <i>uid</i>.
-	 * @param The contact to remove
-	 * @return <i>true</i> if successful.
-	 */
-	bool remove ( const OContact& t );
-
-	/** Remove contact.
-	 * Removes contact with the user id <i>uid</i>.
-	 * @param The user id of the contact to remove
-	 * @return <i>true</i> if successful.
-	 */
-	bool remove ( int uid );
-
-	/** Load Database *
-	 */
-	bool load();
-	
 	/**
 	 * if the resource was changed externally.
@@ -130,11 +101,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 	bool wasChangedExternally()const;
 
-	/** Reload database.
-	 * You should execute this function if the external database
-	 * was changed.
-	 * This function will load the external database and afterwards
-	 * rejoin the local changes. Therefore the local database will be set consistent.
-	 */
-	bool reload();
 
 	/** Save contacts database.
@@ -159,5 +123,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
         OContactAccessBackend *m_backEnd;
         bool m_loading:1;
-	bool m_changed;
 
  private slots:
diff --git a/libopie/pim/ocontactaccessbackend_xml.h b/libopie/pim/ocontactaccessbackend_xml.h
index 50ea329..12a75ba 100644
--- a/libopie/pim/ocontactaccessbackend_xml.h
+++ b/libopie/pim/ocontactaccessbackend_xml.h
@@ -18,4 +18,7 @@
  * History:
  * $Log$
+ * Revision 1.4  2002/10/16 10:52:40  eilers
+ * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
+ *
  * Revision 1.3  2002/10/14 16:21:54  eilers
  * Some minor interface updates
@@ -57,5 +60,6 @@ using namespace Opie;
 class OContactAccessBackend_XML : public OContactAccessBackend {
  public:
-	OContactAccessBackend_XML ( QString appname, QString filename = 0l )
+	OContactAccessBackend_XML ( QString appname, QString filename = 0l ):
+		m_changed( false )
 		{
 			m_appName = appname;
@@ -76,4 +80,8 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	
 	bool save() {
+
+		if ( !m_changed )
+			return true;
+
 		QString strNewFile = m_fileName + ".new";
 		QFile f( strNewFile );
@@ -124,4 +132,6 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 		/* The journalfile should be removed now... */
 		removeJournal();
+
+		m_changed = false;
 		return true;
 	}
@@ -146,4 +156,5 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	void clear () {
 		m_contactList.clear();
+		m_changed = false;
 
 	}
@@ -276,4 +287,7 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 			updateJournal (newcontact, OContact::ACTION_ADD);
 			addContact_p( newcontact );
+			
+			m_changed = true;
+
 			return true;
 		}
@@ -281,4 +295,6 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	bool replace ( const OContact &contact )
 		{
+			m_changed = true;
+
 			bool found = false;
 			
@@ -301,4 +317,6 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	bool remove ( int uid )
 		{
+			m_changed = true;
+
 			bool found = false;
 			QValueListIterator<OContact> it;
@@ -554,4 +572,5 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	
  protected:
+	bool m_changed;
 	QString m_journalName;
 	QString m_fileName;
diff --git a/libopie/pim/opimaccesstemplate.h b/libopie/pim/opimaccesstemplate.h
index 3e1f393..50cb1e4 100644
--- a/libopie/pim/opimaccesstemplate.h
+++ b/libopie/pim/opimaccesstemplate.h
@@ -38,11 +38,15 @@ public:
     virtual bool load();
 
-    /**
-     * reload from the backend
+    /** Reload database.
+     * You should execute this function if the external database
+     * was changed.
+     * This function will load the external database and afterwards
+     * rejoin the local changes. Therefore the local database will be set consistent.
      */
     virtual bool reload();
 
-    /**
-     * save to the backend
+    /** Save contacts database.
+     * Save is more a "commit". After calling this function, all changes are public available.
+     * @return true if successful
      */
     virtual bool save();
@@ -50,4 +54,6 @@ public:
     /**
      * if the resource was changed externally
+     * You should use the signal handling instead of polling possible changes !
+     * zecke: Do you implement a signal for otodoaccess ?
      */
     bool wasChangedExternally()const;
@@ -60,5 +66,5 @@ public:
 
     /**
-     * queryByExample)
+     * queryByExample. 
      * @see otodoaccess, ocontactaccess
      */
@@ -84,4 +90,6 @@ public:
     /**
      * add T to the backend
+     * @param t The item to add.
+     * @return <i>true</i> if added successfully.
      */
     virtual bool add( const T& t ) ;
@@ -90,4 +98,6 @@ public:
     /**
      * remove T from the backend
+     * @param t The item to remove
+     * @return <i>true</i> if successful.
      */
     virtual bool remove( const T& t );
@@ -95,4 +105,6 @@ public:
     /**
      * remove the OPimRecord with uid
+     * @param uid The ID of the item to remove
+     * @return <i>true</i> if successful.
      */
     virtual bool remove( int uid );
@@ -100,4 +112,6 @@ public:
     /**
      * replace T from backend
+     * @param t The item to replace
+     * @return <i>true</i> if successful.
      */
     virtual bool replace( const T& t) ;
@@ -143,4 +157,5 @@ bool OPimAccessTemplate<T>::load() {
 template <class T>
 bool OPimAccessTemplate<T>::reload() {
+	invalidateCache();  // zecke: I think this should be added (se)
     return m_backEnd->reload();
 }
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
index 50ea329..12a75ba 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
+++ b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
@@ -18,4 +18,7 @@
  * History:
  * $Log$
+ * Revision 1.4  2002/10/16 10:52:40  eilers
+ * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
+ *
  * Revision 1.3  2002/10/14 16:21:54  eilers
  * Some minor interface updates
@@ -57,5 +60,6 @@ using namespace Opie;
 class OContactAccessBackend_XML : public OContactAccessBackend {
  public:
-	OContactAccessBackend_XML ( QString appname, QString filename = 0l )
+	OContactAccessBackend_XML ( QString appname, QString filename = 0l ):
+		m_changed( false )
 		{
 			m_appName = appname;
@@ -76,4 +80,8 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	
 	bool save() {
+
+		if ( !m_changed )
+			return true;
+
 		QString strNewFile = m_fileName + ".new";
 		QFile f( strNewFile );
@@ -124,4 +132,6 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 		/* The journalfile should be removed now... */
 		removeJournal();
+
+		m_changed = false;
 		return true;
 	}
@@ -146,4 +156,5 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	void clear () {
 		m_contactList.clear();
+		m_changed = false;
 
 	}
@@ -276,4 +287,7 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 			updateJournal (newcontact, OContact::ACTION_ADD);
 			addContact_p( newcontact );
+			
+			m_changed = true;
+
 			return true;
 		}
@@ -281,4 +295,6 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	bool replace ( const OContact &contact )
 		{
+			m_changed = true;
+
 			bool found = false;
 			
@@ -301,4 +317,6 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	bool remove ( int uid )
 		{
+			m_changed = true;
+
 			bool found = false;
 			QValueListIterator<OContact> it;
@@ -554,4 +572,5 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 	
  protected:
+	bool m_changed;
 	QString m_journalName;
 	QString m_fileName;
diff --git a/libopie2/opiepim/core/ocontactaccess.cpp b/libopie2/opiepim/core/ocontactaccess.cpp
index e8c0a45..2ca0283 100644
--- a/libopie2/opiepim/core/ocontactaccess.cpp
+++ b/libopie2/opiepim/core/ocontactaccess.cpp
@@ -22,4 +22,7 @@
  * History:
  * $Log$
+ * Revision 1.5  2002/10/16 10:52:40  eilers
+ * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
+ *
  * Revision 1.4  2002/10/14 16:21:54  eilers
  * Some minor interface updates
@@ -63,6 +66,5 @@
 OContactAccess::OContactAccess ( const QString appname, const QString ,
 			 OContactAccessBackend* end, bool autosync ):
-	OPimAccessTemplate<OContact>( end ),
-	m_changed ( false )
+	OPimAccessTemplate<OContact>( end )
 {
         /* take care of the backend. If there is no one defined, we 
@@ -95,13 +97,8 @@ OContactAccess::~OContactAccess ()
 	 * do it for him..
 	 */
-	if ( m_changed ) 
 		save();
 	// delete m_backEnd; is done by template..
 }
 
-bool OContactAccess::load()
-{
-	return ( m_backEnd->load() );
-}
 
 bool OContactAccess::save ()
@@ -111,18 +108,14 @@ bool OContactAccess::save ()
 	 * Therefore: Reload database and merge the data...
 	 */
-	if ( m_backEnd->wasChangedExternally() )
+	if ( OPimAccessTemplate<OContact>::wasChangedExternally() )
 		reload();
 
-	if ( m_changed ){ 
-		bool status = m_backEnd->save();
+	bool status = OPimAccessTemplate<OContact>::save();
 		if ( !status ) return false;
 
-		m_changed = false;
 		/* Now tell everyone that new data is available.
 		 */
 		QCopEnvelope e( "QPE/PIM", "addressbookUpdated()" );
 
-	}
-
 	return true;
 }
@@ -138,27 +131,4 @@ bool OContactAccess::hasQuerySettings ( int querySettings ) const
 }
 
-bool OContactAccess::add ( const OContact& newcontact )
-{
-	m_changed = true;
-	return ( m_backEnd->add ( newcontact ) );
-}
-
-bool OContactAccess::replace ( const OContact& contact )
-{
-	m_changed = true;
-	return ( m_backEnd->replace ( contact ) );
-}
-
-bool OContactAccess::remove ( const OContact& t )
-{
-	m_changed = true;
-	return ( m_backEnd->remove ( t.uid() ) );
-}
-
-bool OContactAccess::remove ( int uid )
-{
-	m_changed = true;
-	return ( m_backEnd->remove ( uid ) );
-}
 
 bool OContactAccess::wasChangedExternally()const
@@ -168,9 +138,4 @@ bool OContactAccess::wasChangedExternally()const
 
 
-bool OContactAccess::reload()
-{
-	return ( m_backEnd->reload() );
-}
-
 void OContactAccess::copMessage( const QCString &msg, const QByteArray & )
 {
diff --git a/libopie2/opiepim/core/ocontactaccess.h b/libopie2/opiepim/core/ocontactaccess.h
index adc66cf..da9c942 100644
--- a/libopie2/opiepim/core/ocontactaccess.h
+++ b/libopie2/opiepim/core/ocontactaccess.h
@@ -18,4 +18,7 @@
  * History:
  * $Log$
+ * Revision 1.3  2002/10/16 10:52:40  eilers
+ * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
+ *
  * Revision 1.2  2002/10/14 16:21:54  eilers
  * Some minor interface updates
@@ -92,36 +95,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 	bool hasQuerySettings ( int querySettings ) const;
 
-	/** Add Contact to database.
-	 * @param newcontact The contact to add.
-	 * @return <i>true</i> if added successfully.
-	 */
-	bool add (const OContact& newcontact);
-
-	/** Replace contact.
-	 * Replaces given contact with contact with the user id <i>uid</i>.
-	 * @param uid The user ID
-	 * @param contact The new contact
-	 * @return <i>true</i> if successful.
-	 */
-	bool replace ( const OContact& contact );
-
-	/** Remove contact.
-	 * Removes contact with the user id <i>uid</i>.
-	 * @param The contact to remove
-	 * @return <i>true</i> if successful.
-	 */
-	bool remove ( const OContact& t );
-
-	/** Remove contact.
-	 * Removes contact with the user id <i>uid</i>.
-	 * @param The user id of the contact to remove
-	 * @return <i>true</i> if successful.
-	 */
-	bool remove ( int uid );
-
-	/** Load Database *
-	 */
-	bool load();
-	
 	/**
 	 * if the resource was changed externally.
@@ -130,11 +101,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 	bool wasChangedExternally()const;
 
-	/** Reload database.
-	 * You should execute this function if the external database
-	 * was changed.
-	 * This function will load the external database and afterwards
-	 * rejoin the local changes. Therefore the local database will be set consistent.
-	 */
-	bool reload();
 
 	/** Save contacts database.
@@ -159,5 +123,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
         OContactAccessBackend *m_backEnd;
         bool m_loading:1;
-	bool m_changed;
 
  private slots:
diff --git a/libopie2/opiepim/core/opimaccesstemplate.h b/libopie2/opiepim/core/opimaccesstemplate.h
index 3e1f393..50cb1e4 100644
--- a/libopie2/opiepim/core/opimaccesstemplate.h
+++ b/libopie2/opiepim/core/opimaccesstemplate.h
@@ -38,11 +38,15 @@ public:
     virtual bool load();
 
-    /**
-     * reload from the backend
+    /** Reload database.
+     * You should execute this function if the external database
+     * was changed.
+     * This function will load the external database and afterwards
+     * rejoin the local changes. Therefore the local database will be set consistent.
      */
     virtual bool reload();
 
-    /**
-     * save to the backend
+    /** Save contacts database.
+     * Save is more a "commit". After calling this function, all changes are public available.
+     * @return true if successful
      */
     virtual bool save();
@@ -50,4 +54,6 @@ public:
     /**
      * if the resource was changed externally
+     * You should use the signal handling instead of polling possible changes !
+     * zecke: Do you implement a signal for otodoaccess ?
      */
     bool wasChangedExternally()const;
@@ -60,5 +66,5 @@ public:
 
     /**
-     * queryByExample)
+     * queryByExample. 
      * @see otodoaccess, ocontactaccess
      */
@@ -84,4 +90,6 @@ public:
     /**
      * add T to the backend
+     * @param t The item to add.
+     * @return <i>true</i> if added successfully.
      */
     virtual bool add( const T& t ) ;
@@ -90,4 +98,6 @@ public:
     /**
      * remove T from the backend
+     * @param t The item to remove
+     * @return <i>true</i> if successful.
      */
     virtual bool remove( const T& t );
@@ -95,4 +105,6 @@ public:
     /**
      * remove the OPimRecord with uid
+     * @param uid The ID of the item to remove
+     * @return <i>true</i> if successful.
      */
     virtual bool remove( int uid );
@@ -100,4 +112,6 @@ public:
     /**
      * replace T from backend
+     * @param t The item to replace
+     * @return <i>true</i> if successful.
      */
     virtual bool replace( const T& t) ;
@@ -143,4 +157,5 @@ bool OPimAccessTemplate<T>::load() {
 template <class T>
 bool OPimAccessTemplate<T>::reload() {
+	invalidateCache();  // zecke: I think this should be added (se)
     return m_backEnd->reload();
 }