Kexi API Documentation (2.0 alpha)

KexiMigration::MigrateManager Class Reference

#include <migratemanager.h>

Inheritance diagram for KexiMigration::MigrateManager:

KexiDB::Object List of all members.

Detailed Description

Migration library management, for finding and loading mogration drivers.

Definition at line 38 of file migratemanager.h.

Public Types

typedef QMap< QString, KService::Ptr > ServicesMap

Public Member Functions

 MigrateManager ()
virtual ~MigrateManager ()
KexiMigratedriver (const QString &name)
const QStringList driverNames ()
QString driverForMimeType (const QString &mimeType)
virtual QString serverErrorMsg ()
 server error is set if there is error at KService level (useful for debugging)
virtual int serverResult ()
virtual QString serverResultName ()
QString possibleProblemsInfoMsg () const

Protected Member Functions

virtual void drv_clearServerResult ()


Member Typedef Documentation

typedef QMap<QString, KService::Ptr> KexiMigration::MigrateManager::ServicesMap
 

Definition at line 41 of file migratemanager.h.


Constructor & Destructor Documentation

MigrateManager::MigrateManager  ) 
 

Definition at line 254 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::incRefCount().

MigrateManager::~MigrateManager  )  [virtual]
 

Definition at line 265 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::decRefCount(), KexiDBDbg, and KexiMigration::MigrateManagerInternal::m_refCount.


Member Function Documentation

KexiMigrate * MigrateManager::driver const QString name  ) 
 

Tries to load db driver with named name name. The name is case insensitive.

Returns:
db driver, or 0 if error (then error message is also set)

Definition at line 324 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::driver(), KexiDB::Object::error(), KexiDB::Object::errorMsg(), and KexiDB::Object::setError().

Referenced by KexiMigration::ImportWizard::next().

QString MigrateManager::driverForMimeType const QString mimeType  ) 
 

Looks up a drivers list by MIME type of database file. Only file-based database drivers are checked. The lookup is case insensitive.

Returns:
driver name or null string if no driver found.

Definition at line 307 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::lookupDrivers(), KexiMigration::MigrateManagerInternal::m_services_by_mimetype, and KexiDB::Object::setError().

const QStringList MigrateManager::driverNames  ) 
 

returns list of available drivers names. That drivers can be loaded by first use of driver() method.

Definition at line 287 of file migratemanager.cpp.

References KexiDB::Object::error(), KexiDB::Object::errorMsg(), KexiMigration::MigrateManagerInternal::lookupDrivers(), and KexiMigration::MigrateManagerInternal::m_services.

void MigrateManager::drv_clearServerResult  )  [protected, virtual]
 

Clears number of last server operation's result stored as a single integer. Formally, this integer should be set to value that means "NO ERRORS" or "OK". This method is called by clearError(). For reimplementation. By default does nothing.

See also:
serverErrorMsg()

Reimplemented from KexiDB::Object.

Definition at line 349 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::m_serverErrMsg, KexiMigration::MigrateManagerInternal::m_serverResultName, and KexiMigration::MigrateManagerInternal::m_serverResultNum.

QString MigrateManager::possibleProblemsInfoMsg  )  const
 

HTML information about possible problems encountered. It's displayed in 'details' section, if an error encountered. Currently it contains a list of incompatible migration drivers.

Definition at line 356 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::possibleProblems.

QString MigrateManager::serverErrorMsg  )  [virtual]
 

server error is set if there is error at KService level (useful for debugging)

Reimplemented from KexiDB::Object.

Definition at line 334 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::m_serverErrMsg.

int MigrateManager::serverResult  )  [virtual]
 

Returns:
engine-specific last server-side operation result number. Use this in your application to give users more information on what's up.
Reimplement this for your driver - default implementation just returns 0. Note that this result value is not the same as the one returned by errorNum() (Object::m_errno member)
See also:
serverErrorMsg(), drv_clearServerResult()

Reimplemented from KexiDB::Object.

Definition at line 339 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::m_serverResultNum.

QString MigrateManager::serverResultName  )  [virtual]
 

Returns:
engine-specific last server-side operation result name, (name for serverResult()). Use this in your application to give users more information on what's up.
Reimplement this for your driver - default implementation just returns null string. Note that this result name is not the same as the error message returned by serverErorMsg() or erorMsg()
See also:
serverErrorMsg(), drv_clearServerResult()

Reimplemented from KexiDB::Object.

Definition at line 344 of file migratemanager.cpp.

References KexiMigration::MigrateManagerInternal::m_serverResultName.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for Kexi 2.0 alpha.
Documentation copyright © 2002-2007 the Kexi Team.
Generated on Tue Apr 1 20:50:52 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003