25QString QgsSplitVectorLayerAlgorithm::name()
const
27 return QStringLiteral(
"splitvectorlayer" );
30QString QgsSplitVectorLayerAlgorithm::displayName()
const
32 return QObject::tr(
"Split vector layer" );
35QStringList QgsSplitVectorLayerAlgorithm::tags()
const
37 return QObject::tr(
"vector,split,field,unique" ).split(
',' );
40QString QgsSplitVectorLayerAlgorithm::group()
const
42 return QObject::tr(
"Vector general" );
45QString QgsSplitVectorLayerAlgorithm::groupId()
const
47 return QStringLiteral(
"vectorgeneral" );
50QString QgsSplitVectorLayerAlgorithm::shortHelpString()
const
52 return QObject::tr(
"Splits input vector layer into multiple layers by specified unique ID field." )
53 + QStringLiteral(
"\n\n" )
54 + QObject::tr(
"Each of the layers created in the output folder contains all features from "
55 "the input layer with the same value for the specified attribute. The number "
56 "of files generated is equal to the number of different values found for the "
57 "specified attribute." );
60QgsSplitVectorLayerAlgorithm *QgsSplitVectorLayerAlgorithm::createInstance()
const
62 return new QgsSplitVectorLayerAlgorithm();
65void QgsSplitVectorLayerAlgorithm::initAlgorithm(
const QVariantMap & )
69 QVariant(), QStringLiteral(
"INPUT" ) ) );
70 std::unique_ptr< QgsProcessingParameterBoolean > prefixFieldParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"PREFIX_FIELD" ),
71 QObject::tr(
"Add field prefix to file names" ),
true );
72 addParameter( prefixFieldParam.release() );
75 auto fileTypeParam = std::make_unique < QgsProcessingParameterEnum >( QStringLiteral(
"FILE_TYPE" ), QObject::tr(
"Output file type" ), options,
false, 0,
true );
77 addParameter( fileTypeParam.release() );
85 std::unique_ptr< QgsProcessingFeatureSource > source( parameterAsSource( parameters, QStringLiteral(
"INPUT" ), context ) );
89 const QString fieldName = parameterAsString( parameters, QStringLiteral(
"FIELD" ), context );
90 const QString outputDir = parameterAsString( parameters, QStringLiteral(
"OUTPUT" ), context );
92 if ( parameters.value( QStringLiteral(
"FILE_TYPE" ) ).isValid() )
94 const int idx = parameterAsEnum( parameters, QStringLiteral(
"FILE_TYPE" ), context );
101 outputFormat = QStringLiteral(
"gpkg" );
104 if ( !QDir().mkpath( outputDir ) )
107 const QgsFields fields = source->fields();
110 const int fieldIndex = fields.
lookupField( fieldName );
111 const QSet< QVariant > uniqueValues = source->uniqueValues( fieldIndex );
112 QString baseName = outputDir + QDir::separator();
114 if ( parameterAsBool( parameters, QStringLiteral(
"PREFIX_FIELD" ), context ) )
116 baseName.append( fieldName +
"_" );
120 const double step = uniqueValues.size() > 0 ? 100.0 / uniqueValues.size() : 1;
124 QStringList outputLayers;
125 std::unique_ptr< QgsFeatureSink > sink;
127 for (
auto it = uniqueValues.constBegin(); it != uniqueValues.constEnd(); ++it )
135 fileName = QStringLiteral(
"%1NULL.%2" ).arg( baseName ).arg( outputFormat );
137 else if ( ( *it ).toString().isEmpty() )
139 fileName = QStringLiteral(
"%1EMPTY.%2" ).arg( baseName ).arg( outputFormat );
145 feedback->
pushInfo( QObject::tr(
"Creating layer: %1" ).arg( fileName ) );
161 feedback->
pushInfo( QObject::tr(
"Added %n feature(s) to layer",
nullptr, count ) );
162 outputLayers << fileName;
169 outputs.insert( QStringLiteral(
"OUTPUT" ), outputDir );
170 outputs.insert( QStringLiteral(
"OUTPUT_LAYERS" ), outputLayers );
@ Vector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ SkipGeometryValidityChecks
Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always...
WkbType
The WKB type describes the number of dimensions a geometry has.
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
This class represents a coordinate reference system (CRS).
static QString createFieldEqualityExpression(const QString &fieldName, const QVariant &value, QMetaType::Type fieldType=QMetaType::Type::UnknownType)
Create an expression allowing to evaluate if a field is equal to a value.
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).
@ 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.
Container of fields for a vector layer.
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
static QString stringToSafeFilename(const QString &string)
Converts a string to a safe filename, replacing characters which are not safe for filenames with an '...
Contains information about the context in which a processing algorithm is executed.
QString preferredVectorFormat() const
Returns the preferred vector format to use for vector outputs.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
A multi-layer output for processing algorithms which create map layers, when the number and nature of...
An input feature source (such as vector layers) parameter for processing algorithms.
A vector layer or feature source field parameter for processing algorithms.
A folder destination parameter, for specifying the destination path for a folder created by the algor...
static QgsFeatureSink * createFeatureSink(QString &destination, QgsProcessingContext &context, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs, const QVariantMap &createOptions=QVariantMap(), const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList(), QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QgsRemappingSinkDefinition *remappingDefinition=nullptr)
Creates a feature sink ready for adding features.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
static QStringList supportedFormatExtensions(VectorFormatOptions options=SortRecommended)
Returns a list of file extensions for supported formats, e.g "shp", "gpkg".
const QgsCoordinateReferenceSystem & crs