qgsdatasourceuri.h

Go to the documentation of this file.

/***************************************************************************
      qgsdatasourceuri.h  -  Structure to contain the component parts
                             of a data source URI
                             -------------------
    begin                : Dec 5, 2004
    copyright            : (C) 2004 by Gary E.Sherman
    email                : sherman at mrcc.com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSDATASOURCEURI_H
#define QGSDATASOURCEURI_H

#include "qgis.h"

#include <QMap>

class CORE_EXPORT QgsDataSourceURI
{
  public:
    enum SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire };

    QgsDataSourceURI();

    QgsDataSourceURI( QString uri );

    // \note added in 1.9
    QgsDataSourceURI( const QByteArray & uri );

    QString connectionInfo() const;

    QString uri() const;

    // \note added in 1.9
    QByteArray encodedUri() const;

    // \note added in 1.9
    // \note not available in python bindings
    void setEncodedUri( const QByteArray & uri );

    // \note added in 1.9
    void setEncodedUri( const QString & uri );

    QString quotedTablename() const;

    // \note if key exists, another is inserted
    // \note added in 1.9
    void setParam( const QString &key, const QString &value );
    void setParam( const QString &key, const QStringList &value );

    // \note remove all occurrences of key, returns number of params removed
    // \note added in 1.9
    int removeParam( const QString &key );

    // \note added in 1.9
    QString param( const QString &key ) const;

    // \note added in 1.9
    QStringList params( const QString &key ) const;

    // \note added in 1.9
    bool hasParam( const QString &key ) const;

    void setConnection( const QString& aHost,
                        const QString& aPort,
                        const QString& aDatabase,
                        const QString& aUsername,
                        const QString& aPassword,
                        SSLmode sslmode = SSLprefer );

    void setConnection( const QString& aService,
                        const QString& aDatabase,
                        const QString& aUsername,
                        const QString& aPassword,
                        SSLmode sslmode = SSLprefer );

    // \note added in 1.4
    void setDatabase( const QString &database );

    void setDataSource( const QString& aSchema,
                        const QString& aTable,
                        const QString& aGeometryColumn,
                        const QString& aSql = QString(),
                        const QString& aKeyColumn = QString() );

    // added in 1.5
    void setUsername( QString username );

    // added in 1.5
    void setPassword( QString password );

    static QString removePassword( const QString& aUri );

    QString username() const;
    QString schema() const;
    QString table() const;
    QString sql() const;
    QString geometryColumn() const;

    // added in 1.5
    void setUseEstimatedMetadata( bool theFlag );
    bool useEstimatedMetadata() const;

    void disableSelectAtId( bool theFlag );
    bool selectAtIdDisabled() const;

    void clearSchema();
    void setSql( QString sql );

    // added in version 1.1
    QString host() const;
    QString database() const;
    QString port() const;
    QString password() const;
    enum SSLmode sslMode() const;

    // added in 1.7
    QString service() const;

    // added in version 1.2
    QString keyColumn() const;
    void setKeyColumn( QString column );

    // added in 1.9
    QGis::WkbType wkbType() const;
    void setWkbType( QGis::WkbType type );

    // added in 1.9
    QString srid() const;
    void setSrid( QString srid );

  private:
    void skipBlanks( const QString &uri, int &i );
    QString getValue( const QString &uri, int &i );
    QString escape( const QString &uri, QChar delim ) const;

    /* data */

    QString mHost;
    QString mPort;
    QString mService;
    QString mDatabase;
    QString mSchema;
    QString mTable;
    QString mGeometryColumn;
    QString mSql;
    QString mUsername;
    QString mPassword;
    enum SSLmode mSSLmode;
    QString mKeyColumn;
    bool mUseEstimatedMetadata;
    bool mSelectAtIdDisabled;
    QGis::WkbType mWkbType;
    QString mSrid;
    QMap<QString, QString> mParams;
};

#endif //QGSDATASOURCEURI_H