QgsDataSourceURI Class Reference
[QGIS core library]

Class for storing the component parts of a PostgreSQL/RDBMS datasource URI. More...

#include <qgsdatasourceuri.h>

List of all members.

Public Types

enum  SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire }

Public Member Functions

 QgsDataSourceURI ()
 default constructor
 QgsDataSourceURI (QString uri)
 constructor which parses input URI
QString connectionInfo () const
 return connection part of URI
QString uri () const
 return complete uri
QString quotedTablename () const
 quoted table name
void setConnection (const QString &aHost, const QString &aPort, const QString &aDatabase, const QString &aUsername, const QString &aPassword, SSLmode sslmode=SSLprefer)
 Set all connection related members at once.
void setDatabase (const QString &database)
 Set database.
void setDataSource (const QString &aSchema, const QString &aTable, const QString &aGeometryColumn, const QString &aSql=QString(), const QString &aKeyColumn=QString())
 Set all data source related members at once.
void setUsername (QString username)
 set username
void setPassword (QString password)
 set password
QString username () const
QString schema () const
QString table () const
QString sql () const
QString geometryColumn () const
void setUseEstimatedMetadata (bool theFlag)
 set use Estimated Metadata
bool useEstimatedMetadata () const
void clearSchema ()
void setSql (QString sql)
QString host () const
QString database () const
QString port () const
QString password () const
enum SSLmode sslMode () const
QString keyColumn () const
void setKeyColumn (QString column)

Static Public Member Functions

static QString removePassword (const QString &aUri)
 Removes password element from uris.

Private Member Functions

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

Private Attributes

QString mHost
 host name
QString mDatabase
 database name
QString mPort
 port the database server listens on
QString mSchema
 schema
QString mTable
 spatial table
QString mGeometryColumn
 geometry column
QString mSql
 SQL query or where clause used to limit features returned from the layer.
QString mUsername
 username
QString mPassword
 password
enum SSLmode mSSLmode
 ssl mode
QString mKeyColumn
 key column
bool mUseEstimatedMetadata


Detailed Description

Class 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

Definition at line 30 of file qgsdatasourceuri.h.


Member Enumeration Documentation

Note:
enumeration added in version 1.1
Enumerator:
SSLprefer 
SSLdisable 
SSLallow 
SSLrequire 

Definition at line 34 of file qgsdatasourceuri.h.


Constructor & Destructor Documentation

QgsDataSourceURI::QgsDataSourceURI (  ) 

default constructor

Definition at line 26 of file qgsdatasourceuri.cpp.

QgsDataSourceURI::QgsDataSourceURI ( QString  uri  ) 


Member Function Documentation

QString QgsDataSourceURI::connectionInfo (  )  const

return connection part of URI

Definition at line 397 of file qgsdatasourceuri.cpp.

References escape(), mDatabase, mHost, mPassword, mPort, mSSLmode, mUsername, SSLallow, SSLdisable, SSLprefer, and SSLrequire.

Referenced by uri().

QString QgsDataSourceURI::uri (  )  const

QString QgsDataSourceURI::quotedTablename (  )  const

quoted table name

Definition at line 454 of file qgsdatasourceuri.cpp.

References escape(), mSchema, and mTable.

Referenced by uri().

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

Set all connection related members at once.

Note:
This optional sslmode parameter has been added in version 1.1

Definition at line 465 of file qgsdatasourceuri.cpp.

References mDatabase, mHost, mPassword, mPort, mSSLmode, and mUsername.

Referenced by QgsMapLayer::writeXML().

void QgsDataSourceURI::setDatabase ( const QString &  database  ) 

Set database.

Definition at line 493 of file qgsdatasourceuri.cpp.

References mDatabase.

Referenced by QgsMapLayer::readXML().

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

Set all data source related members at once.

Definition at line 480 of file qgsdatasourceuri.cpp.

References mGeometryColumn, mKeyColumn, mSchema, mSql, and mTable.

void QgsDataSourceURI::setUsername ( QString  username  ) 

set username

Definition at line 227 of file qgsdatasourceuri.cpp.

References mUsername.

void QgsDataSourceURI::setPassword ( QString  password  ) 

set password

Definition at line 247 of file qgsdatasourceuri.cpp.

References mPassword.

QString QgsDataSourceURI::removePassword ( const QString &  aUri  )  [static]

Removes password element from uris.

Definition at line 193 of file qgsdatasourceuri.cpp.

Referenced by QgsMapLayer::publicSource().

QString QgsDataSourceURI::username (  )  const

Definition at line 222 of file qgsdatasourceuri.cpp.

References mUsername.

Referenced by QgsMapLayer::writeXML().

QString QgsDataSourceURI::schema (  )  const

Definition at line 262 of file qgsdatasourceuri.cpp.

References mSchema.

QString QgsDataSourceURI::table (  )  const

Definition at line 267 of file qgsdatasourceuri.cpp.

References mTable.

QString QgsDataSourceURI::sql (  )  const

Definition at line 272 of file qgsdatasourceuri.cpp.

References mSql.

QString QgsDataSourceURI::geometryColumn (  )  const

Definition at line 277 of file qgsdatasourceuri.cpp.

References mGeometryColumn.

void QgsDataSourceURI::setUseEstimatedMetadata ( bool  theFlag  ) 

set use Estimated Metadata

Definition at line 293 of file qgsdatasourceuri.cpp.

References mUseEstimatedMetadata.

bool QgsDataSourceURI::useEstimatedMetadata (  )  const

Definition at line 298 of file qgsdatasourceuri.cpp.

References mUseEstimatedMetadata.

void QgsDataSourceURI::clearSchema (  ) 

Definition at line 308 of file qgsdatasourceuri.cpp.

References mSchema.

void QgsDataSourceURI::setSql ( QString  sql  ) 

Definition at line 303 of file qgsdatasourceuri.cpp.

References mSql.

QString QgsDataSourceURI::host (  )  const

Definition at line 232 of file qgsdatasourceuri.cpp.

References mHost.

Referenced by QgsMapLayer::writeXML().

QString QgsDataSourceURI::database (  )  const

Definition at line 237 of file qgsdatasourceuri.cpp.

References mDatabase.

Referenced by QgsMapLayer::readXML(), and QgsMapLayer::writeXML().

QString QgsDataSourceURI::port (  )  const

Definition at line 252 of file qgsdatasourceuri.cpp.

References mPort.

Referenced by QgsMapLayer::writeXML().

QString QgsDataSourceURI::password (  )  const

Definition at line 242 of file qgsdatasourceuri.cpp.

References mPassword.

Referenced by QgsMapLayer::writeXML().

QgsDataSourceURI::SSLmode QgsDataSourceURI::sslMode (  )  const

Definition at line 257 of file qgsdatasourceuri.cpp.

References mSSLmode.

QString QgsDataSourceURI::keyColumn (  )  const

Definition at line 282 of file qgsdatasourceuri.cpp.

References mKeyColumn.

void QgsDataSourceURI::setKeyColumn ( QString  column  ) 

Definition at line 287 of file qgsdatasourceuri.cpp.

References mKeyColumn.

void QgsDataSourceURI::skipBlanks ( const QString &  uri,
int &  i 
) [private]

Definition at line 323 of file qgsdatasourceuri.cpp.

Referenced by getValue(), and QgsDataSourceURI().

QString QgsDataSourceURI::getValue ( const QString &  uri,
int &  i 
) [private]

Definition at line 330 of file qgsdatasourceuri.cpp.

References QgsDebugMsg, and skipBlanks().

Referenced by QgsDataSourceURI().

QString QgsDataSourceURI::escape ( const QString &  uri,
QChar  delim = '\'' 
) const [private]

Definition at line 313 of file qgsdatasourceuri.cpp.

Referenced by connectionInfo(), quotedTablename(), and uri().


Member Data Documentation

QString QgsDataSourceURI::mHost [private]

host name

Definition at line 115 of file qgsdatasourceuri.h.

Referenced by connectionInfo(), host(), QgsDataSourceURI(), and setConnection().

QString QgsDataSourceURI::mDatabase [private]

database name

Definition at line 117 of file qgsdatasourceuri.h.

Referenced by connectionInfo(), database(), QgsDataSourceURI(), setConnection(), and setDatabase().

QString QgsDataSourceURI::mPort [private]

port the database server listens on

Definition at line 119 of file qgsdatasourceuri.h.

Referenced by connectionInfo(), port(), QgsDataSourceURI(), and setConnection().

QString QgsDataSourceURI::mSchema [private]

schema

Definition at line 121 of file qgsdatasourceuri.h.

Referenced by clearSchema(), QgsDataSourceURI(), quotedTablename(), schema(), and setDataSource().

QString QgsDataSourceURI::mTable [private]

spatial table

Definition at line 123 of file qgsdatasourceuri.h.

Referenced by QgsDataSourceURI(), quotedTablename(), setDataSource(), and table().

geometry column

Definition at line 125 of file qgsdatasourceuri.h.

Referenced by geometryColumn(), QgsDataSourceURI(), setDataSource(), and uri().

QString QgsDataSourceURI::mSql [private]

SQL query or where clause used to limit features returned from the layer.

Definition at line 127 of file qgsdatasourceuri.h.

Referenced by QgsDataSourceURI(), setDataSource(), setSql(), sql(), and uri().

QString QgsDataSourceURI::mUsername [private]

username

Definition at line 129 of file qgsdatasourceuri.h.

Referenced by connectionInfo(), QgsDataSourceURI(), setConnection(), setUsername(), and username().

QString QgsDataSourceURI::mPassword [private]

password

Definition at line 131 of file qgsdatasourceuri.h.

Referenced by connectionInfo(), password(), QgsDataSourceURI(), setConnection(), and setPassword().

ssl mode

Definition at line 133 of file qgsdatasourceuri.h.

Referenced by connectionInfo(), QgsDataSourceURI(), setConnection(), and sslMode().

QString QgsDataSourceURI::mKeyColumn [private]

key column

Definition at line 135 of file qgsdatasourceuri.h.

Referenced by keyColumn(), QgsDataSourceURI(), setDataSource(), setKeyColumn(), and uri().


The documentation for this class was generated from the following files:

Generated on Sat Feb 4 19:17:32 2012 for Quantum GIS API Documentation by  doxygen 1.5.6