/**

\struct QgsDataSourceURI

\brief Structure for storing the component parts of a PostgreSQL/RDBMS datasource URI.

This structure stores the database connection information, including host, database,

user name, password, schema, password, and sql where clause

*/

class QgsDataSourceURI

{

%TypeHeaderCode

#include <qgsdatasourceuri.h>

%End

public:

//! \note enumeration added in version 1.1

enum SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire };

//! default constructor

QgsDataSourceURI();

//! constructor which parses input URI

QgsDataSourceURI(QString uri);

//! connection info

QString connectionInfo() const;

//! complete uri

QString uri() const;

//! quoted table name

QString quotedTablename() const;

//! Set all connection related members at once

//! \note This optional sslmode parameter has been added in version 1.1

void setConnection(const QString& aHost,

const QString& aPort,

const QString& aDatabase,

const QString& aUsername,

const QString& aPassword,

SSLmode sslmode = SSLprefer );

//! Set all data source related members at once

void setDataSource(const QString& aSchema,

const QString& aTable,

const QString& aGeometryColumn,

const QString& aSql = QString(),

const QString& aKeyColumn = QString());

/** Removes password from uris

* @note this method was added in QGIS 1.1

*/

static QString removePassword( const QString& aUri);

QString username() const;

QString schema() const;

QString table() const;

QString sql() const;

QString geometryColumn() const;

// added in 1.1

QString host() const;

QString database() const;

QString password() const;

QString port() const;

SSLmode sslMode() const;

void setSql(QString sql);

// added in 1.2

QString keyColumn() const;

void setKeyColumn(QString column);

};

/** canonical manager of data providers

This is a Singleton class that manages data provider access.

*/

class QgsProviderRegistry

{

%TypeHeaderCode

#include <qgsproviderregistry.h>

%End

public:

/** means of accessing canonical single instance */

static QgsProviderRegistry* instance(QString pluginPath = QString::null);

/** Virtual dectructor */

virtual ~QgsProviderRegistry();

QString library(const QString & providerKey) const;

QString pluginList(bool asHtml = false) const;

/** return library directory where plugins are found */

const QDir & libraryDirectory() const;

void setLibraryDirectory(const QDir & path);

QgsDataProvider * getProvider( const QString & providerKey,

const QString & dataSource );

/** Return list of available providers by their keys */

QStringList providerList() const;

/** Return metadata of the provider or NULL if not found */

const QgsProviderMetadata* providerMetadata(const QString& providerKey) const;

/** return vector file filter string

Returns a string suitable for a QFileDialog of vector file formats

supported by all data providers.

This walks through all data providers appending calls to their

fileVectorFilters to a string, which is then returned.

@note

It'd be nice to eventually be raster/vector neutral.

*/

virtual QString fileVectorFilters() const;

/** return a string containing the available database drivers

* @note this method was added in QGIS 1.1

*/

virtual QString databaseDrivers() const;

/** return a string containing the available directory drivers

* @note this method was added in QGIS 1.1

*/

virtual QString directoryDrivers() const;

/** return a string containing the available protocol drivers

* @note this method was added in QGIS 1.1

*/

virtual QString protocolDrivers() const;

private:

/** ctor private since instance() creates it */

QgsProviderRegistry(QString pluginPath) /Default/ ;

}; // class QgsProviderRegistry