QGIS API Documentation 3.29.0-Master (19d7edcfed)
qgsprovidermetadata.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsprovidermetadata.cpp - Metadata class for
3 describing a data provider.
4 -------------------
5 begin : Sat Jan 10 2004
6 copyright : (C) 2004 by Gary E.Sherman
7 email : sherman at mrcc.com
8 ***************************************************************************/
9
10/***************************************************************************
11 * *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
16 * *
17 ***************************************************************************/
18
19#include "qgsprovidermetadata.h"
20#include "qgsdataprovider.h"
21#include "qgsmaplayer.h"
22#include "qgsexception.h"
25
27 QString const &description,
28 QString const &library )
29 : mKey( key )
30 , mDescription( description )
31 , mLibrary( library )
32{}
33
34QgsProviderMetadata::QgsProviderMetadata( const QString &key, const QString &description, const CreateDataProviderFunction &createFunc )
35 : mKey( key )
36 , mDescription( description )
37 , mCreateFunction( createFunc )
38{}
39
41{
42 qDeleteAll( mProviderConnections );
43}
44
46{
47 return mKey;
48}
49
51{
52 return mDescription;
53}
54
56{
57 return QIcon();
58}
59
60QgsProviderMetadata::ProviderMetadataCapabilities QgsProviderMetadata::capabilities() const
61{
62 return QgsProviderMetadata::ProviderMetadataCapabilities();
63}
64
65QgsProviderMetadata::ProviderCapabilities QgsProviderMetadata::providerCapabilities() const
66{
67 return QgsProviderMetadata::ProviderCapabilities();
68}
69
70QList<QgsMapLayerType> QgsProviderMetadata::supportedLayerTypes() const
71{
72 return {};
73}
74
76{
77 return mLibrary;
78}
79
80QString QgsProviderMetadata::suggestGroupNameForUri( const QString & /*uri*/ ) const
81{
82 return QString();
83}
84
86{
87 return mCreateFunction;
88}
89
91{
92
93}
94
96{
97
98}
99
101{
102 return QString();
103}
104
105QList<QgsMeshDriverMetadata> QgsProviderMetadata::meshDriversMetadata()
106{
107 return QList<QgsMeshDriverMetadata>();
108}
109
110int QgsProviderMetadata::priorityForUri( const QString & ) const
111{
112 return 0;
113}
114
115QList<QgsMapLayerType> QgsProviderMetadata::validLayerTypesForUri( const QString & ) const
116{
117 return QList<QgsMapLayerType>();
118}
119
120bool QgsProviderMetadata::uriIsBlocklisted( const QString & ) const
121{
122 return false;
123}
124
125QStringList QgsProviderMetadata::sidecarFilesForUri( const QString & ) const
126{
127 return QStringList();
128}
129
130QList<QgsProviderSublayerDetails> QgsProviderMetadata::querySublayers( const QString &, Qgis::SublayerQueryFlags, QgsFeedback * ) const
131{
132 return QList<QgsProviderSublayerDetails>();
133}
134
137 QgsDataProvider::ReadFlags flags )
138{
139 if ( mCreateFunction )
140 {
141 return mCreateFunction( uri, options, flags );
142 }
143 return nullptr;
144}
145
146void QgsProviderMetadata::setBoolParameter( QVariantMap &uri, const QString &parameter, const QVariant &value )
147{
148 if ( value.toString().compare( QStringLiteral( "yes" ), Qt::CaseInsensitive ) == 0 ||
149 value.toString().compare( QStringLiteral( "1" ), Qt::CaseInsensitive ) == 0 ||
150 value.toString().compare( QStringLiteral( "true" ), Qt::CaseInsensitive ) == 0 )
151 {
152 uri[ parameter ] = true;
153 }
154 else if ( value.toString().compare( QStringLiteral( "no" ), Qt::CaseInsensitive ) == 0 ||
155 value.toString().compare( QStringLiteral( "0" ), Qt::CaseInsensitive ) == 0 ||
156 value.toString().compare( QStringLiteral( "false" ), Qt::CaseInsensitive ) == 0 )
157 {
158 uri[ parameter ] = false;
159 }
160}
161
162bool QgsProviderMetadata::boolParameter( const QVariantMap &uri, const QString &parameter, bool defaultValue )
163{
164 if ( uri.value( parameter, QString() ).toString().compare( QStringLiteral( "yes" ), Qt::CaseInsensitive ) == 0 ||
165 uri.value( parameter, QString() ).toString().compare( QStringLiteral( "1" ), Qt::CaseInsensitive ) == 0 ||
166 uri.value( parameter, QString() ).toString().compare( QStringLiteral( "true" ), Qt::CaseInsensitive ) == 0 )
167 {
168 return true;
169 }
170 else if ( uri.value( parameter, QString() ).toString().compare( QStringLiteral( "no" ), Qt::CaseInsensitive ) == 0 ||
171 uri.value( parameter, QString() ).toString().compare( QStringLiteral( "0" ), Qt::CaseInsensitive ) == 0 ||
172 uri.value( parameter, QString() ).toString().compare( QStringLiteral( "false" ), Qt::CaseInsensitive ) == 0 )
173 {
174 return false;
175 }
176
177 return defaultValue;
178}
179
180QVariantMap QgsProviderMetadata::decodeUri( const QString & ) const
181{
182 return QVariantMap();
183}
184
185QString QgsProviderMetadata::encodeUri( const QVariantMap & ) const
186{
187 return QString();
188}
189
191 const QString &, const QgsFields &,
193 bool, QMap<int, int> &,
194 QString &errorMessage, const QMap<QString, QVariant> * )
195{
196 errorMessage = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createEmptyLayer" ) );
197 return Qgis::VectorExportResult::ErrorProviderUnsupportedFeature;
198}
199
200bool QgsProviderMetadata::createDatabase( const QString &, QString &errorMessage )
201{
202 errorMessage = QObject::tr( "The %1 provider does not support database creation" ).arg( key() );
203 return false;
204}
205
207 const QString &, const QString &,
208 int, Qgis::DataType, int,
209 int, double *,
211 const QStringList & )
212{
213 return nullptr;
214}
215
217 const QString &,
218 const QString &,
219 const QgsCoordinateReferenceSystem & ) const
220{
221 return false;
222}
223
225 const QString &,
226 const QgsCoordinateReferenceSystem & ) const
227{
228 return false;
229}
230
231QList<QPair<QString, QString> > QgsProviderMetadata::pyramidResamplingMethods()
232{
233 return QList<QPair<QString, QString> >();
234}
235
236QList<QgsDataItemProvider *> QgsProviderMetadata::dataItemProviders() const
237{
238 return QList<QgsDataItemProvider *>();
239}
240
241int QgsProviderMetadata::listStyles( const QString &, QStringList &, QStringList &,
242 QStringList &, QString &errCause )
243{
244 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "listStyles" ) );
245 return -1;
246}
247
248
249bool QgsProviderMetadata::styleExists( const QString &, const QString &, QString &errorCause )
250{
251 errorCause.clear();
252 return false;
253}
254
255QString QgsProviderMetadata::getStyleById( const QString &, const QString &, QString &errCause )
256{
257 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "getStyleById" ) );
258 return QString();
259}
260
261bool QgsProviderMetadata::deleteStyleById( const QString &, const QString &, QString &errCause )
262{
263 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "deleteStyleById" ) );
264 return false;
265}
266
267bool QgsProviderMetadata::saveStyle( const QString &, const QString &, const QString &, const QString &,
268 const QString &, const QString &, bool, QString &errCause )
269{
270 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "saveStyle" ) );
271 return false;
272}
273
274QString QgsProviderMetadata::loadStyle( const QString &, QString &errCause )
275{
276 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "loadStyle" ) );
277 return QString();
278}
279
280QString QgsProviderMetadata::loadStoredStyle( const QString &, QString &, QString &errCause )
281{
282 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "loadStoredStyle" ) );
283 return QString();
284}
285
286bool QgsProviderMetadata::saveLayerMetadata( const QString &, const QgsLayerMetadata &, QString & )
287{
288 throw QgsNotSupportedException( QObject::tr( "Provider %1 does not support writing layer metadata" ).arg( key() ) );
289}
290
291bool QgsProviderMetadata::createDb( const QString &, QString &errCause )
292{
293 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createDb" ) );
294 return false;
295}
296
298{
299 return nullptr;
300}
301
302QMap<QString, QgsAbstractProviderConnection *> QgsProviderMetadata::connections( bool cached )
303{
304 Q_UNUSED( cached );
305 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "connections" ) ) );
306}
307
308QMap<QString, QgsAbstractDatabaseProviderConnection *> QgsProviderMetadata::dbConnections( bool cached )
309{
310 return connections<QgsAbstractDatabaseProviderConnection>( cached ) ;
311}
312
314{
315 const QMap<QString, QgsAbstractProviderConnection *> constConns { connections( cached ) };
316 const QStringList constKeys { constConns.keys( ) };
317 for ( const QString &key : constKeys )
318 {
319 if ( key == name )
320 {
321 return constConns.value( key );
322 }
323 }
324 return nullptr;
325}
326
328{
329 Q_UNUSED( name );
330 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createConnection" ) ) );
331}
332
333
334QgsAbstractProviderConnection *QgsProviderMetadata::createConnection( const QString &uri, const QVariantMap &configuration )
335{
336 Q_UNUSED( configuration );
337 Q_UNUSED( uri );
338 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createConnection" ) ) );
339}
340
341void QgsProviderMetadata::deleteConnection( const QString &name )
342{
343 Q_UNUSED( name );
344 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "deleteConnection" ) ) );
345}
346
347void QgsProviderMetadata::saveConnection( const QgsAbstractProviderConnection *connection, const QString &name )
348{
349 Q_UNUSED( connection )
350 Q_UNUSED( name )
351 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "saveConnection" ) ) );
352}
353
355void QgsProviderMetadata::saveConnectionProtected( const QgsAbstractProviderConnection *conn, const QString &name )
356{
357 const bool isNewConnection = !connections().contains( name );
358 conn->store( name );
359 mProviderConnections.clear();
360
361 if ( !isNewConnection )
362 emit connectionChanged( name );
363 else
364 emit connectionCreated( name );
365}
367
368template<typename T>
369QMap<QString, T *> QgsProviderMetadata::connections( bool cached )
370{
371 QMap<QString, T *> result;
372 const auto constConns { connections( cached ) };
373 const QStringList constConnKeys { constConns.keys() };
374 for ( const auto &c : constConnKeys )
375 {
376 T *casted { static_cast<T *>( constConns.value( c ) ) };
377 if ( casted )
378 {
379 result.insert( c, casted );
380 }
381 }
382 return result;
383}
384
386
388 const QString &description,
389 const MeshDriverCapabilities &capabilities,
390 const QString &writeDatasetOnfileSuffix )
391 : mName( name )
392 , mDescription( description )
393 , mCapabilities( capabilities )
394 , mWriteDatasetOnFileSuffix( writeDatasetOnfileSuffix )
395{
396}
397
399 const QString &description,
400 const MeshDriverCapabilities &capabilities,
401 const QString &writeDatasetOnfileSuffix,
402 const QString &writeMeshFrameOnFileSuffix,
403 int maxVerticesPerface )
404 : mName( name )
405 , mDescription( description )
406 , mCapabilities( capabilities )
407 , mWriteDatasetOnFileSuffix( writeDatasetOnfileSuffix )
408 , mWriteMeshFrameOnFileSuffix( ( writeMeshFrameOnFileSuffix ) )
409 , mMaxVerticesPerFace( maxVerticesPerface )
410{
411}
412
413QgsMeshDriverMetadata::MeshDriverCapabilities QgsMeshDriverMetadata::capabilities() const
414{
415 return mCapabilities;
416}
417
419{
420 return mName;
421}
422
424{
425 return mDescription;
426}
427
429{
430 return mWriteDatasetOnFileSuffix;
431}
432
434{
435 return mWriteMeshFrameOnFileSuffix;
436}
437
439{
440 return mMaxVerticesPerFace;
441}
VectorExportResult
Vector layer export result codes.
Definition: qgis.h:481
DataType
Raster data types.
Definition: qgis.h:129
The QgsAbstractProviderConnection provides an interface for data provider connections.
virtual void store(const QString &name) const =0
Stores the connection in the settings.
This class represents a coordinate reference system (CRS).
Abstract base class for spatial data provider implementations.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
Container of fields for a vector layer.
Definition: qgsfields.h:45
A structured metadata store for a map layer.
int maximumVerticesCountPerFace() const
Returns the maximum number of vertices per face supported by the driver.
QString writeDatasetOnFileSuffix() const
Returns the suffix used to write datasets on file.
MeshDriverCapabilities capabilities() const
Returns the capabilities for this driver.
QString writeMeshFrameOnFileSuffix() const
Returns the suffix used to write mesh on file.
QString description() const
Returns the description for this driver.
QgsMeshDriverMetadata()
Constructs default metadata without any capabilities.
QString name() const
Returns the name (key) for this driver.
Custom exception class which is raised when an operation is not supported.
Definition: qgsexception.h:118
Custom exception class for provider connection related exceptions.
Definition: qgsexception.h:101
virtual bool uriIsBlocklisted(const QString &uri) const
Returns true if the specified uri is known by this provider to be something which should be blocklist...
virtual QgsProviderMetadata::ProviderCapabilities providerCapabilities() const
Returns the provider's capabilities.
static void setBoolParameter(QVariantMap &uri, const QString &parameter, const QVariant &value)
Sets the value into the uri parameter as a bool.
virtual QgsRasterDataProvider * createRasterDataProvider(const QString &uri, const QString &format, int nBands, Qgis::DataType type, int width, int height, double *geoTransform, const QgsCoordinateReferenceSystem &crs, const QStringList &createOptions=QStringList())
Creates a new instance of the raster data provider.
Q_DECL_DEPRECATED CreateDataProviderFunction createFunction() const
Returns a pointer to the direct provider creation function, if supported by the provider.
QgsAbstractProviderConnection * findConnection(const QString &name, bool cached=true) SIP_THROW(QgsProviderConnectionException)
Searches and returns a (possibly NULL) connection from the stored provider connections.
virtual QIcon icon() const
Returns an icon representing the provider.
virtual int priorityForUri(const QString &uri) const
Returns an integer representing the priority which this provider should have when opening a dataset w...
FilterType
Type of file filters.
static bool boolParameter(const QVariantMap &uri, const QString &parameter, bool defaultValue=false)
Returns the parameter value in the uri as a bool.
std::function< QgsDataProvider *(const QString &, const QgsDataProvider::ProviderOptions &, QgsDataProvider::ReadFlags &) > CreateDataProviderFunction
Typedef for data provider creation function.
virtual bool deleteStyleById(const QString &uri, const QString &styleId, QString &errCause)
Deletes a layer style defined by styleId.
virtual ~QgsProviderMetadata()
dtor
virtual bool saveStyle(const QString &uri, const QString &qmlStyle, const QString &sldStyle, const QString &styleName, const QString &styleDescription, const QString &uiFileContent, bool useAsDefault, QString &errCause)
Saves a layer style to provider.
virtual QString suggestGroupNameForUri(const QString &uri) const
Returns a name that can be used as a group name for sublayers retrieved from the specified uri.
virtual QgsDataProvider * createProvider(const QString &uri, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags=QgsDataProvider::ReadFlags())
Class factory to return a pointer to a newly created QgsDataProvider object.
virtual QString filters(FilterType type)
Builds the list of file filter strings (supported formats)
virtual bool saveLayerMetadata(const QString &uri, const QgsLayerMetadata &metadata, QString &errorMessage) SIP_THROW(QgsNotSupportedException)
Saves metadata to the layer corresponding to the specified uri.
virtual QString encodeUri(const QVariantMap &parts) const
Reassembles a provider data source URI from its component paths (e.g.
QMap< QString, QgsAbstractDatabaseProviderConnection * > dbConnections(bool cached=true) SIP_THROW(QgsProviderConnectionException)
Returns a dictionary of database provider connections, the dictionary key is the connection identifie...
QString description() const
This returns descriptive text for the provider.
virtual bool createMeshData(const QgsMesh &mesh, const QString &fileName, const QString &driverName, const QgsCoordinateReferenceSystem &crs) const
Creates mesh data source from a file name fileName and a driver driverName, that is the mesh frame st...
virtual bool styleExists(const QString &uri, const QString &styleId, QString &errorCause)
Returns true if a layer style with the specified styleId exists in the provider defined by uri.
void connectionChanged(const QString &name)
Emitted when the connection with the specified name is changed, e.g.
virtual QStringList sidecarFilesForUri(const QString &uri) const
Given a uri, returns any sidecar files which are associated with the URI and this provider.
void connectionCreated(const QString &name)
Emitted when a connection with the specified name is created.
virtual void saveConnection(const QgsAbstractProviderConnection *connection, const QString &name) SIP_THROW(QgsProviderConnectionException)
Stores the connection in the settings.
virtual QgsAbstractProviderConnection * createConnection(const QString &uri, const QVariantMap &configuration) SIP_THROW(QgsProviderConnectionException)
Creates a new connection from uri and configuration, the newly created connection is not automaticall...
virtual Qgis::VectorExportResult createEmptyLayer(const QString &uri, const QgsFields &fields, QgsWkbTypes::Type wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, QMap< int, int > &oldToNewAttrIdxMap, QString &errorMessage, const QMap< QString, QVariant > *options)
Creates new empty vector layer.
virtual void deleteConnection(const QString &name) SIP_THROW(QgsProviderConnectionException)
Removes the connection with the given name from the settings.
QString key() const
This returns the unique key associated with the provider.
virtual QgsTransaction * createTransaction(const QString &connString)
Returns new instance of transaction.
virtual void initProvider()
Initialize the provider.
virtual QString getStyleById(const QString &uri, const QString &styleId, QString &errCause)
Gets a layer style defined by uri.
virtual QString loadStoredStyle(const QString &uri, QString &styleName, QString &errCause)
Loads a layer style from the provider storage, reporting its name.
virtual QList< QgsMapLayerType > supportedLayerTypes() const
Returns a list of the map layer types supported by the provider.
QgsProviderMetadata(const QString &key, const QString &description, const QString &library=QString())
Constructor for provider metadata.
virtual bool createDatabase(const QString &uri, QString &errorMessage)
Creates a new empty database at the specified uri.
virtual QList< QgsProviderSublayerDetails > querySublayers(const QString &uri, Qgis::SublayerQueryFlags flags=Qgis::SublayerQueryFlags(), QgsFeedback *feedback=nullptr) const
Queries the specified uri and returns a list of any valid sublayers found in the dataset which can be...
virtual QgsProviderMetadata::ProviderMetadataCapabilities capabilities() const
Returns the provider metadata capabilities.
virtual void cleanupProvider()
Cleanup the provider.
virtual QString loadStyle(const QString &uri, QString &errCause)
Loads a layer style defined by uri.
virtual int listStyles(const QString &uri, QStringList &ids, QStringList &names, QStringList &descriptions, QString &errCause)
Lists stored layer styles in the provider defined by uri.
virtual QList< QPair< QString, QString > > pyramidResamplingMethods()
Returns pyramid resampling methods available for provider.
virtual QList< QgsMapLayerType > validLayerTypesForUri(const QString &uri) const
Returns a list of valid layer types which the provider can be used with when opening the specified ur...
virtual QList< QgsDataItemProvider * > dataItemProviders() const
Returns data item providers.
virtual QMap< QString, QgsAbstractProviderConnection * > connections(bool cached=true) SIP_THROW(QgsProviderConnectionException)
Returns a dictionary of stored provider connections, the dictionary key is the connection identifier.
virtual QList< QgsMeshDriverMetadata > meshDriversMetadata()
Builds the list of available mesh drivers metadata.
virtual QVariantMap decodeUri(const QString &uri) const
Breaks a provider data source URI into its component paths (e.g.
Q_DECL_DEPRECATED QString library() const
This returns the library file name.
virtual bool createDb(const QString &dbPath, QString &errCause)
Creates database by the provider on the path.
Base class for raster data providers.
This class allows including a set of layers in a database-side transaction, provided the layer data p...
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
Setting options for creating vector data providers.
Mesh - vertices, edges and faces.