QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgsauxiliarystorage.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsauxiliarystorage.h - description
3 -------------------
4 begin : Aug 28, 2017
5 copyright : (C) 2017 by Paul Blottiere
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSAUXILIARYSTORAGE_H
19#define QGSAUXILIARYSTORAGE_H
20
21#include "qgis_core.h"
22#include "qgsdatasourceuri.h"
23#include "qgspallabeling.h"
24#include "qgsdiagramrenderer.h"
26#include "qgsproperty.h"
27#include "qgssqliteutils.h"
28#include "qgsvectorlayer.h"
29#include "qgscallout.h"
30#include <QString>
31
32class QgsProject;
33
60class CORE_EXPORT QgsAuxiliaryLayer : public QgsVectorLayer
61{
62 Q_OBJECT
63
64 public:
65
74 QgsAuxiliaryLayer( const QString &pkField, const QString &filename, const QString &table, QgsVectorLayer *vlayer );
75
76 QgsAuxiliaryLayer( const QgsAuxiliaryLayer &rhs ) = delete;
77
79
80#ifdef SIP_RUN
81 SIP_PYOBJECT __repr__();
82 % MethodCode
83 QString str = QStringLiteral( "<QgsAuxiliaryLayer: '%1'>" ).arg( sipCpp->name() );
84 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
85 % End
86#endif
87
88#ifndef SIP_RUN
90#endif
91
100
108
115 bool clear();
116
121
130 bool exists( const QgsPropertyDefinition &definition ) const;
131
141 bool addAuxiliaryField( const QgsPropertyDefinition &definition );
142
147
153 bool save();
154
163 bool deleteAttribute( int attr ) override;
164
171 bool isHiddenProperty( int index ) const;
172
181 int indexOfPropertyDefinition( const QgsPropertyDefinition &definition ) const;
182
191 int propertyFromIndex( int index ) const;
192
199
210 static int createProperty( QgsPalLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting = true );
211
222 static int createProperty( QgsDiagramLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting = true );
223
235 static int createProperty( QgsCallout::Property property, QgsVectorLayer *vlayer, bool overwriteExisting = true );
236
243
249 static QgsField createAuxiliaryField( const QgsField &field );
250
257 static QString nameFromProperty( const QgsPropertyDefinition &def, bool joined = false );
258
265
266 private:
267 QgsVectorLayerJoinInfo mJoinInfo;
268 QString mFileName;
269 QString mTable;
270 QgsVectorLayer *mLayer = nullptr;
271};
272
273
282class CORE_EXPORT QgsAuxiliaryStorage
283{
284 public:
285
297 QgsAuxiliaryStorage( const QgsProject &project, bool copy = true );
298
320 QgsAuxiliaryStorage( const QString &filename = QString(), bool copy = true );
321
323
329 bool isValid() const;
330
334 QString fileName() const;
335
340 QString currentFileName() const;
341
348 QString errorString() const;
349
355 bool saveAs( const QString &filename );
356
364 bool saveAs( const QgsProject &project );
365
371 bool save() const;
372
384
392 static bool deleteTable( const QgsDataSourceUri &uri );
393
402 static bool duplicateTable( const QgsDataSourceUri &uri, const QString &newTable );
403
407 static QString extension();
408
416 static bool exists( const QgsProject &project );
417
418 private:
419 sqlite3_database_unique_ptr open( const QString &filename = QString() );
420 sqlite3_database_unique_ptr open( const QgsProject &project );
421
422 void initTmpFileName();
423
424 static QString filenameForProject( const QgsProject &project );
425 static sqlite3_database_unique_ptr createDB( const QString &filename );
426 static sqlite3_database_unique_ptr openDB( const QString &filename );
427 static bool tableExists( const QString &table, sqlite3 *handler );
428 static bool createTable( const QString &type, const QString &table, sqlite3 *handler, QString &errorMsg );
429
430 static bool exec( const QString &sql, sqlite3 *handler );
431 static QString debugMsg( const QString &sql, sqlite3 *handler );
432
433 static QgsDataSourceUri parseOgrUri( const QgsDataSourceUri &uri );
434
435 bool mValid = false;
436 QString mFileName; // original filename
437 QString mTmpFileName; // temporary filename used in copy mode
438 bool mCopy = false;
439 mutable QString mErrorString;
440};
441
442#endif
Class allowing to manage the auxiliary storage for a vector layer.
static QString nameFromProperty(const QgsPropertyDefinition &def, bool joined=false)
Returns the name of the auxiliary field for a property definition.
static QgsField createAuxiliaryField(const QgsPropertyDefinition &definition)
Creates a new auxiliary field from a property definition.
static QgsPropertyDefinition propertyDefinitionFromField(const QgsField &field)
Returns the property definition from an auxiliary field.
bool clear()
Deletes all features from the layer.
bool addAuxiliaryField(const QgsPropertyDefinition &definition)
Adds an auxiliary field for the given property.
bool isHiddenProperty(int index) const
Returns true if the underlying field has to be hidden from editing tools like attribute table,...
QgsVectorLayer * toSpatialLayer() const
An auxiliary layer is not spatial.
bool deleteAttribute(int attr) override
Removes attribute from the layer and commits changes.
QgsFields auxiliaryFields() const
Returns a list of all auxiliary fields currently managed by the layer.
QgsAuxiliaryLayer(const QString &pkField, const QString &filename, const QString &table, QgsVectorLayer *vlayer)
Constructor.
bool save()
Commits changes and starts editing then.
int propertyFromIndex(int index) const
Returns the underlying property key for the field index.
static int createProperty(QgsDiagramLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting=true)
Creates if necessary a new auxiliary field for a diagram's property and activates this property in se...
QgsVectorLayerJoinInfo joinInfo() const
Returns information to use for joining with primary key and so on.
QgsPropertyDefinition propertyDefinitionFromIndex(int index) const
Returns the property definition for the underlying field index.
bool exists(const QgsPropertyDefinition &definition) const
Returns true if the property is stored in the layer already, false otherwise.
static int createProperty(QgsCallout::Property property, QgsVectorLayer *vlayer, bool overwriteExisting=true)
Creates if necessary a new auxiliary field for a callout's property and activates this property in se...
static int createProperty(QgsPalLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting=true)
Creates if necessary a new auxiliary field for a PAL property and activates this property in settings...
QgsAuxiliaryLayer & operator=(QgsAuxiliaryLayer const &rhs)=delete
QgsAuxiliaryLayer * clone(QgsVectorLayer *layer) const
Returns a new instance equivalent to this one.
static QgsField createAuxiliaryField(const QgsField &field)
Creates a new auxiliary field from a field.
int indexOfPropertyDefinition(const QgsPropertyDefinition &definition) const
Returns the index of the auxiliary field for a specific property definition.
QgsAuxiliaryLayer(const QgsAuxiliaryLayer &rhs)=delete
Class providing some utility methods to manage auxiliary storage.
QgsAuxiliaryStorage(const QString &filename=QString(), bool copy=true)
Constructor.
static QString extension()
Returns the extension used for auxiliary databases.
QString errorString() const
Returns the underlying error string describing potential errors happening in saveAs().
bool save() const
Saves the current database.
static bool exists(const QgsProject &project)
Returns true if the auxiliary database yet exists for a project, false otherwise.
QgsAuxiliaryLayer * createAuxiliaryLayer(const QgsField &field, QgsVectorLayer *layer) const
Creates an auxiliary layer for a vector layer.
virtual ~QgsAuxiliaryStorage()
bool saveAs(const QString &filename)
Saves the current database to a new path.
bool isValid() const
Returns the status of the auxiliary storage currently defined.
QString currentFileName() const
Returns the path of the current database used.
QgsAuxiliaryStorage(const QgsProject &project, bool copy=true)
Constructor.
QString fileName() const
Returns the target filename of the database.
static bool deleteTable(const QgsDataSourceUri &uri)
Removes a table from the auxiliary storage.
bool saveAs(const QgsProject &project)
Saves the current database to a new path for a specific project.
static bool duplicateTable(const QgsDataSourceUri &uri, const QString &newTable)
Duplicates a table and its content.
Property
Data definable properties.
Definition qgscallout.h:86
Class for storing the component parts of a RDBMS data source URI (e.g.
Property
Data definable properties.
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
Container of fields for a vector layer.
Definition qgsfields.h:46
Property
Data definable properties.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
Definition for a property.
Definition qgsproperty.h:45
Defines left outer join from our vector layer to some other vector layer.
Represents a vector layer which manages a vector based data sets.
QgsVectorLayer * clone() const override
Returns a new instance equivalent to this one.
Unique pointer for sqlite3 databases, which automatically closes the database when the pointer goes o...
#define str(x)
Definition qgis.cpp:38
#define SIP_FACTORY
Definition qgis_sip.h:76
struct sqlite3 sqlite3