20#include <QRegularExpression>
24QString QgsSaveFeaturesAlgorithm::name()
const
26 return QStringLiteral(
"savefeatures" );
29QString QgsSaveFeaturesAlgorithm::displayName()
const
31 return QObject::tr(
"Save vector features to file" );
34QStringList QgsSaveFeaturesAlgorithm::tags()
const
36 return QObject::tr(
"save,write,export" ).split(
',' );
39QString QgsSaveFeaturesAlgorithm::group()
const
41 return QObject::tr(
"Vector general" );
44QString QgsSaveFeaturesAlgorithm::groupId()
const
46 return QStringLiteral(
"vectorgeneral" );
49QString QgsSaveFeaturesAlgorithm::shortHelpString()
const
51 return QObject::tr(
"This algorithm saves vector features to a specified file dataset.\n\n"
52 "For dataset formats supporting layers, an optional layer name parameter can be used to specify a custom string.\n\n"
53 "Optional GDAL-defined dataset and layer options can be specified. For more information on this, "
54 "read the online GDAL documentation." );
57QgsSaveFeaturesAlgorithm *QgsSaveFeaturesAlgorithm::createInstance()
const
59 return new QgsSaveFeaturesAlgorithm();
62void QgsSaveFeaturesAlgorithm::initAlgorithm(
const QVariantMap & )
67 std::unique_ptr< QgsProcessingParameterString > param = std::make_unique< QgsProcessingParameterString >( QStringLiteral(
"LAYER_NAME" ), QObject::tr(
"Layer name" ), QVariant(),
false,
true );
69 addParameter( param.release() );
70 param = std::make_unique< QgsProcessingParameterString >( QStringLiteral(
"DATASOURCE_OPTIONS" ), QObject::tr(
"GDAL dataset options (separate individual options with semicolons)" ), QVariant(),
false,
true );
72 addParameter( param.release() );
73 param = std::make_unique< QgsProcessingParameterString >( QStringLiteral(
"LAYER_OPTIONS" ), QObject::tr(
"GDAL layer options (separate individual options with semicolons)" ), QVariant(),
false,
true );
75 addParameter( param.release() );
77 std::unique_ptr< QgsProcessingParameterEnum > paramEnum = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral(
"ACTION_ON_EXISTING_FILE" ), QObject::tr(
"Action to take on pre-existing file" ), QStringList() << QObject::tr(
"Create or overwrite file" ) << QObject::tr(
"Create or overwrite layer" ) << QObject::tr(
"Append features to existing layer, but do not create new fields" ) << QObject::tr(
"Append features to existing layer, and create new fields if needed" ),
false, 0 );
79 addParameter( paramEnum.release() );
87 std::unique_ptr< QgsProcessingFeatureSource > source( parameterAsSource( parameters, QStringLiteral(
"INPUT" ), context ) );
91 QString layerName = parameterAsString( parameters, QStringLiteral(
"LAYER_NAME" ), context ).trimmed();
92 QVariantMap createOptions;
93 if ( !layerName.isEmpty() )
95 createOptions[QStringLiteral(
"layerName" )] = layerName;
98 const QStringList datasourceOptions = parameterAsString( parameters, QStringLiteral(
"DATASOURCE_OPTIONS" ), context ).trimmed().split(
';', Qt::SkipEmptyParts );
99 const QStringList layerOptions = parameterAsString( parameters, QStringLiteral(
"LAYER_OPTIONS" ), context ).trimmed().split(
';', Qt::SkipEmptyParts );
101 QString destination = parameterAsString( parameters, QStringLiteral(
"OUTPUT" ), context );
106 QString finalFileName;
107 QString finalLayerName;
118 if ( writer->hasError() )
120 throw QgsProcessingException( QObject::tr(
"Could not create layer %1: %2" ).arg( destination, writer->errorMessage() ) );
125 for (
const QgsField &field : source->fields() )
128 feedback->
pushWarning( QObject::tr(
"%1: Aliases are not supported by %2" ).arg( field.name(), writer->driverLongName() ) );
130 feedback->
pushWarning( QObject::tr(
"%1: Comments are not supported by %2" ).arg( field.name(), writer->driverLongName() ) );
134 destination = finalFileName;
135 if ( !saveOptions.
layerName.isEmpty() && !finalLayerName.isEmpty() )
136 destination += QStringLiteral(
"|layername=%1" ).arg( finalLayerName );
138 std::unique_ptr< QgsFeatureSink > sink(
new QgsProcessingFeatureSink( writer.release(), destination, context,
true ) );
142 const double step = source->featureCount() > 0 ? 100.0 / source->featureCount() : 1;
161 finalFileName = destination;
162 finalLayerName.clear();
163 const int separatorIndex = destination.indexOf(
'|' );
164 if ( separatorIndex > -1 )
166 const thread_local QRegularExpression layerNameRx( QStringLiteral(
"\\|layername=([^\\|]*)" ) );
167 const QRegularExpressionMatch match = layerNameRx.match( destination );
168 if ( match.hasMatch() )
170 finalLayerName = match.captured( 1 );
172 finalFileName = destination.mid( 0, separatorIndex );
176 outputs.insert( QStringLiteral(
"OUTPUT" ), destination );
177 outputs.insert( QStringLiteral(
"FILE_PATH" ), finalFileName );
178 outputs.insert( QStringLiteral(
"LAYER_NAME" ), finalLayerName );
@ Vector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ FieldComments
Writer can support field comments.
@ FieldAliases
Writer can support field aliases.
@ SkipGeometryValidityChecks
Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always...
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
@ NoSymbology
Export only data.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QFlags< SinkFlag > SinkFlags
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
bool isCanceled() const
Tells whether the operation has been canceled already.
void setProgress(double progress)
Sets the current progress for the feedback object.
Encapsulate a field in an attribute table or data source.
Contains information about the context in which a processing algorithm is executed.
QString defaultEncoding() const
Returns the default encoding to use for newly created files.
QgsProcessingFeedback * feedback()
Returns the associated feedback object.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
Custom exception class for processing related exceptions.
QgsProxyFeatureSink subclass which reports feature addition errors to a QgsProcessingContext.
Base class for providing feedback from a processing algorithm.
virtual void pushWarning(const QString &warning)
Pushes a warning informational message from the algorithm.
A string output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
Options to pass to writeAsVectorFormat()
QString fileEncoding
Encoding to use.
QString driverName
OGR driver to use.
QString layerName
Layer name. If let empty, it will be derived from the filename.
QStringList layerOptions
List of OGR layer creation options.
Qgis::FeatureSymbologyExport symbologyExport
Symbology to export.
QgsVectorFileWriter::ActionOnExistingFile actionOnExistingFile
Action on existing file.
QStringList datasourceOptions
List of OGR data source creation options.
static QString driverForExtension(const QString &extension)
Returns the OGR driver name for a specified file extension.
static QgsVectorFileWriter * create(const QString &fileName, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &srs, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QString *newFilename=nullptr, QString *newLayer=nullptr)
Create a new vector file writer.
static QString fileFilterString(VectorFormatOptions options=SortRecommended)
Returns filter string that can be used for dialogs.
ActionOnExistingFile
Enumeration to describe how to handle existing files.