QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
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<Qgis::LayerType> 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<Qgis::LayerType> QgsProviderMetadata::validLayerTypesForUri( const QString & ) const
116{
117 return QList<Qgis::LayerType>();
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
190QString QgsProviderMetadata::absoluteToRelativeUri( const QString &uri, const QgsReadWriteContext &context ) const
191{
192 return context.pathResolver().writePath( uri );
193}
194
195QString QgsProviderMetadata::relativeToAbsoluteUri( const QString &uri, const QgsReadWriteContext &context ) const
196{
197 return context.pathResolver().readPath( uri );
198}
199
202 bool, QMap<int, int> &,
203 QString &errorMessage, const QMap<QString, QVariant> * )
204{
205 errorMessage = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createEmptyLayer" ) );
206 return Qgis::VectorExportResult::ErrorProviderUnsupportedFeature;
207}
208
209bool QgsProviderMetadata::createDatabase( const QString &, QString &errorMessage )
210{
211 errorMessage = QObject::tr( "The %1 provider does not support database creation" ).arg( key() );
212 return false;
213}
214
216 const QString &, const QString &,
217 int, Qgis::DataType, int,
218 int, double *,
220 const QStringList & )
221{
222 return nullptr;
223}
224
226 const QString &,
227 const QString &,
228 const QgsCoordinateReferenceSystem & ) const
229{
230 return false;
231}
232
234 const QString &,
235 const QgsCoordinateReferenceSystem & ) const
236{
237 return false;
238}
239
240QList<QPair<QString, QString> > QgsProviderMetadata::pyramidResamplingMethods()
241{
242 return QList<QPair<QString, QString> >();
243}
244
245QList<QgsDataItemProvider *> QgsProviderMetadata::dataItemProviders() const
246{
247 return QList<QgsDataItemProvider *>();
248}
249
250int QgsProviderMetadata::listStyles( const QString &, QStringList &, QStringList &,
251 QStringList &, QString &errCause )
252{
253 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "listStyles" ) );
254 return -1;
255}
256
257
258bool QgsProviderMetadata::styleExists( const QString &, const QString &, QString &errorCause )
259{
260 errorCause.clear();
261 return false;
262}
263
264QString QgsProviderMetadata::getStyleById( const QString &, const QString &, QString &errCause )
265{
266 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "getStyleById" ) );
267 return QString();
268}
269
270bool QgsProviderMetadata::deleteStyleById( const QString &, const QString &, QString &errCause )
271{
272 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "deleteStyleById" ) );
273 return false;
274}
275
276bool QgsProviderMetadata::saveStyle( const QString &, const QString &, const QString &, const QString &,
277 const QString &, const QString &, bool, QString &errCause )
278{
279 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "saveStyle" ) );
280 return false;
281}
282
283QString QgsProviderMetadata::loadStyle( const QString &, QString &errCause )
284{
285 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "loadStyle" ) );
286 return QString();
287}
288
289QString QgsProviderMetadata::loadStoredStyle( const QString &, QString &, QString &errCause )
290{
291 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "loadStoredStyle" ) );
292 return QString();
293}
294
295bool QgsProviderMetadata::saveLayerMetadata( const QString &, const QgsLayerMetadata &, QString & )
296{
297 throw QgsNotSupportedException( QObject::tr( "Provider %1 does not support writing layer metadata" ).arg( key() ) );
298}
299
300bool QgsProviderMetadata::createDb( const QString &, QString &errCause )
301{
302 errCause = QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createDb" ) );
303 return false;
304}
305
307{
308 return nullptr;
309}
310
311QMap<QString, QgsAbstractProviderConnection *> QgsProviderMetadata::connections( bool cached )
312{
313 Q_UNUSED( cached );
314 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "connections" ) ) );
315}
316
317QMap<QString, QgsAbstractDatabaseProviderConnection *> QgsProviderMetadata::dbConnections( bool cached )
318{
319 return connections<QgsAbstractDatabaseProviderConnection>( cached ) ;
320}
321
323{
324 const QMap<QString, QgsAbstractProviderConnection *> constConns { connections( cached ) };
325 const QStringList constKeys { constConns.keys( ) };
326 for ( const QString &key : constKeys )
327 {
328 if ( key == name )
329 {
330 return constConns.value( key );
331 }
332 }
333 return nullptr;
334}
335
337{
338 Q_UNUSED( name );
339 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createConnection" ) ) );
340}
341
342
343QgsAbstractProviderConnection *QgsProviderMetadata::createConnection( const QString &uri, const QVariantMap &configuration )
344{
345 Q_UNUSED( configuration );
346 Q_UNUSED( uri );
347 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "createConnection" ) ) );
348}
349
350void QgsProviderMetadata::deleteConnection( const QString &name )
351{
352 Q_UNUSED( name );
353 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "deleteConnection" ) ) );
354}
355
356void QgsProviderMetadata::saveConnection( const QgsAbstractProviderConnection *connection, const QString &name )
357{
358 Q_UNUSED( connection )
359 Q_UNUSED( name )
360 throw QgsProviderConnectionException( QObject::tr( "Provider %1 has no %2 method" ).arg( key(), QStringLiteral( "saveConnection" ) ) );
361}
362
364void QgsProviderMetadata::saveConnectionProtected( const QgsAbstractProviderConnection *conn, const QString &name )
365{
366 const bool isNewConnection = !connections().contains( name );
367 conn->store( name );
368 mProviderConnections.clear();
369
370 if ( !isNewConnection )
371 emit connectionChanged( name );
372 else
373 emit connectionCreated( name );
374}
376
377template<typename T>
378QMap<QString, T *> QgsProviderMetadata::connections( bool cached )
379{
380 QMap<QString, T *> result;
381 const auto constConns { connections( cached ) };
382 const QStringList constConnKeys { constConns.keys() };
383 for ( const auto &c : constConnKeys )
384 {
385 T *casted { static_cast<T *>( constConns.value( c ) ) };
386 if ( casted )
387 {
388 result.insert( c, casted );
389 }
390 }
391 return result;
392}
393
395
397 const QString &description,
398 const MeshDriverCapabilities &capabilities,
399 const QString &writeDatasetOnfileSuffix )
400 : mName( name )
401 , mDescription( description )
402 , mCapabilities( capabilities )
403 , mWriteDatasetOnFileSuffix( writeDatasetOnfileSuffix )
404{
405}
406
408 const QString &description,
409 const MeshDriverCapabilities &capabilities,
410 const QString &writeDatasetOnfileSuffix,
411 const QString &writeMeshFrameOnFileSuffix,
412 int maxVerticesPerface )
413 : mName( name )
414 , mDescription( description )
415 , mCapabilities( capabilities )
416 , mWriteDatasetOnFileSuffix( writeDatasetOnfileSuffix )
417 , mWriteMeshFrameOnFileSuffix( ( writeMeshFrameOnFileSuffix ) )
418 , mMaxVerticesPerFace( maxVerticesPerface )
419{
420}
421
422QgsMeshDriverMetadata::MeshDriverCapabilities QgsMeshDriverMetadata::capabilities() const
423{
424 return mCapabilities;
425}
426
428{
429 return mName;
430}
431
433{
434 return mDescription;
435}
436
438{
439 return mWriteDatasetOnFileSuffix;
440}
441
443{
444 return mWriteMeshFrameOnFileSuffix;
445}
446
448{
449 return mMaxVerticesPerFace;
450}
VectorExportResult
Vector layer export result codes.
Definition: qgis.h:620
DataType
Raster data types.
Definition: qgis.h:242
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition: qgis.h:155
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
QString writePath(const QString &filename) const
Prepare a filename to save it to the project file.
QString readPath(const QString &filename) const
Turn filename read from the project file to an absolute path.
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.
virtual QList< Qgis::LayerType > validLayerTypesForUri(const QString &uri) const
Returns a list of valid layer types which the provider can be used with when opening the specified ur...
QMap< QString, QgsAbstractDatabaseProviderConnection * > dbConnections(bool cached=true) SIP_THROW(QgsProviderConnectionException)
Returns a dictionary of database provider connections, the dictionary key is the connection identifie...
virtual QString absoluteToRelativeUri(const QString &uri, const QgsReadWriteContext &context) const
Converts absolute path(s) to relative path(s) in the given provider-specific URI.
QString description() const
This returns descriptive text for the provider.
virtual Qgis::VectorExportResult createEmptyLayer(const QString &uri, const QgsFields &fields, Qgis::WkbType wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, QMap< int, int > &oldToNewAttrIdxMap, QString &errorMessage, const QMap< QString, QVariant > *options)
Creates new empty vector layer.
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 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< Qgis::LayerType > 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 QString relativeToAbsoluteUri(const QString &uri, const QgsReadWriteContext &context) const
Converts relative path(s) to absolute path(s) in the given provider-specific URI.
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< 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.
The class is used as a container of context for various read/write operations on other objects.
const QgsPathResolver & pathResolver() const
Returns path resolver for conversion between relative and absolute paths.
This class allows including a set of layers in a database-side transaction, provided the layer data p...
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.