22#include <QStandardItemModel>
24#include <QItemSelectionModel>
41QgsProcessingAggregatePanelWidget::QgsProcessingAggregatePanelWidget( QWidget *parent )
46 mModel = mFieldsView->model();
48 mLayerCombo->setAllowEmptyLayer(
true );
51 connect( mResetButton, &QPushButton::clicked,
this, &QgsProcessingAggregatePanelWidget::loadFieldsFromLayer );
52 connect( mAddButton, &QPushButton::clicked,
this, &QgsProcessingAggregatePanelWidget::addField );
56 connect( mLoadLayerFieldsButton, &QPushButton::clicked,
this, &QgsProcessingAggregatePanelWidget::loadLayerFields );
60 if ( !mBlockChangedSignal )
67void QgsProcessingAggregatePanelWidget::setLayer(
QgsVectorLayer *layer )
69 if ( layer == mLayer )
73 mFieldsView->setSourceLayer( mLayer );
74 if ( mModel->rowCount() == 0 )
76 loadFieldsFromLayer();
80 QMessageBox dlg(
this );
81 dlg.setText( tr(
"Do you want to reset the field mapping?" ) );
82 dlg.setStandardButtons(
83 QMessageBox::StandardButtons( QMessageBox::Yes |
85 dlg.setDefaultButton( QMessageBox::No );
86 if ( dlg.exec() == QMessageBox::Yes )
88 loadFieldsFromLayer();
97QVariant QgsProcessingAggregatePanelWidget::value()
const
99 const QList<QgsAggregateMappingModel::Aggregate> mapping = mFieldsView->mapping();
101 QVariantList results;
102 results.reserve( mapping.size() );
106 def.insert( QStringLiteral(
"name" ), aggregate.field.name() );
107 def.insert( QStringLiteral(
"type" ),
static_cast< int >( aggregate.field.type() ) );
108 def.insert( QStringLiteral(
"type_name" ), aggregate.field.typeName() );
109 def.insert( QStringLiteral(
"length" ), aggregate.field.length() );
110 def.insert( QStringLiteral(
"precision" ), aggregate.field.precision() );
111 def.insert( QStringLiteral(
"sub_type" ),
static_cast< int >( aggregate.field.subType() ) );
112 def.insert( QStringLiteral(
"input" ), aggregate.source );
113 def.insert( QStringLiteral(
"aggregate" ), aggregate.aggregate );
114 def.insert( QStringLiteral(
"delimiter" ), aggregate.delimiter );
115 results.append( def );
120void QgsProcessingAggregatePanelWidget::setValue(
const QVariant &value )
122 if ( value.userType() != QMetaType::Type::QVariantList )
125 QList< QgsAggregateMappingModel::Aggregate > aggregates;
127 const QVariantList fields = value.toList();
128 aggregates.reserve( fields.size() );
129 for (
const QVariant &field : fields )
131 const QVariantMap map = field.toMap();
132 const QgsField f( map.value( QStringLiteral(
"name" ) ).toString(),
133 static_cast< QMetaType::Type
>( map.value( QStringLiteral(
"type" ),
static_cast< int >( QMetaType::Type::UnknownType ) ).toInt() ),
134 map.value( QStringLiteral(
"type_name" ), QVariant::typeToName(
static_cast< QMetaType::Type
>( map.value( QStringLiteral(
"type" ),
static_cast< int >( QMetaType::Type::UnknownType ) ).toInt() ) ) ).toString(),
135 map.value( QStringLiteral(
"length" ), 0 ).toInt(),
136 map.value( QStringLiteral(
"precision" ), 0 ).toInt(),
143 aggregate.
source = map.value( QStringLiteral(
"input" ) ).toString();
144 aggregate.
aggregate = map.value( QStringLiteral(
"aggregate" ) ).toString();
145 aggregate.
delimiter = map.value( QStringLiteral(
"delimiter" ) ).toString();
147 aggregates.append( aggregate );
150 mBlockChangedSignal =
true;
152 if ( aggregates.size() > 0 )
153 mFieldsView->setMapping( aggregates );
155 mBlockChangedSignal =
false;
162 mFieldsView->registerExpressionContextGenerator( generator );
165void QgsProcessingAggregatePanelWidget::loadFieldsFromLayer()
169 mFieldsView->setSourceFields( mLayer->fields() );
173void QgsProcessingAggregatePanelWidget::addField()
175 const int rowCount = mModel->rowCount();
176 mModel->appendField(
QgsField( QStringLiteral(
"new_field" ) ) );
177 const QModelIndex index = mModel->index( rowCount, 0 );
178 mFieldsView->selectionModel()->select(
180 QItemSelectionModel::SelectionFlags(
181 QItemSelectionModel::Clear |
182 QItemSelectionModel::Select |
183 QItemSelectionModel::Current |
184 QItemSelectionModel::Rows ) );
185 mFieldsView->scrollTo( index );
188void QgsProcessingAggregatePanelWidget::loadLayerFields()
190 if (
QgsVectorLayer *vl = qobject_cast< QgsVectorLayer * >( mLayerCombo->currentLayer() ) )
192 mFieldsView->setSourceFields( vl->fields() );
203 QVBoxLayout *vlayout =
new QVBoxLayout();
204 vlayout->setContentsMargins( 0, 0, 0, 0 );
206 vlayout->addWidget(
new QLabel( tr(
"Parent layer" ) ) );
208 mParentLayerComboBox =
new QComboBox();
209 mParentLayerComboBox->addItem( tr(
"None" ), QVariant() );
211 QString initialParent;
213 initialParent = aggregateParam->parentLayerParameterName();
215 if (
auto *lModel = widgetContext.
model() )
218 const QMap<QString, QgsProcessingModelParameter> components = lModel->parameterComponents();
219 for (
auto it = components.constBegin(); it != components.constEnd(); ++it )
223 mParentLayerComboBox-> addItem( definition->
description(), definition->
name() );
224 if ( !initialParent.isEmpty() && initialParent == definition->
name() )
226 mParentLayerComboBox->setCurrentIndex( mParentLayerComboBox->count() - 1 );
231 mParentLayerComboBox-> addItem( definition->
description(), definition->
name() );
232 if ( !initialParent.isEmpty() && initialParent == definition->
name() )
234 mParentLayerComboBox->setCurrentIndex( mParentLayerComboBox->count() - 1 );
240 if ( mParentLayerComboBox->count() == 1 && !initialParent.isEmpty() )
243 mParentLayerComboBox->addItem( initialParent, initialParent );
244 mParentLayerComboBox->setCurrentIndex( mParentLayerComboBox->count() - 1 );
247 vlayout->addWidget( mParentLayerComboBox );
248 setLayout( vlayout );
253 auto param = std::make_unique< QgsProcessingParameterAggregate >( name, description, mParentLayerComboBox->currentData().toString() );
254 param->setFlags( flags );
255 return param.release();
267QString QgsProcessingAggregateWidgetWrapper::parameterType()
const
274 return new QgsProcessingAggregateWidgetWrapper( parameter, type );
277QWidget *QgsProcessingAggregateWidgetWrapper::createWidget()
279 mPanel =
new QgsProcessingAggregatePanelWidget(
nullptr );
280 mPanel->setToolTip( parameterDefinition()->toolTip() );
281 mPanel->registerExpressionContextGenerator(
this );
283 connect( mPanel, &QgsProcessingAggregatePanelWidget::changed,
this, [ = ]
285 emit widgetValueHasChanged(
this );
293 return new QgsProcessingAggregateParameterDefinitionWidget( context, widgetContext, definition,
algorithm );
296void QgsProcessingAggregateWidgetWrapper::postInitialize(
const QList<QgsAbstractProcessingParameterWidgetWrapper *> &wrappers )
306 if ( wrapper->parameterDefinition()->name() ==
static_cast< const QgsProcessingParameterAggregate *
>( parameterDefinition() )->parentLayerParameterName() )
308 setParentLayerWrapperValue( wrapper );
311 setParentLayerWrapperValue( wrapper );
324int QgsProcessingAggregateWidgetWrapper::stretch()
const
333 std::unique_ptr< QgsProcessingContext > tmpContext;
334 if ( mProcessingContextGenerator )
335 context = mProcessingContextGenerator->processingContext();
339 tmpContext = std::make_unique< QgsProcessingContext >();
340 context = tmpContext.get();
347 mPanel->setLayer(
nullptr );
353 std::unique_ptr< QgsMapLayer > ownedLayer( context->
takeResultLayer( layer->
id() ) );
356 mParentLayer.reset( qobject_cast< QgsVectorLayer * >( ownedLayer.release() ) );
357 layer = mParentLayer.get();
365 mPanel->setLayer( layer );
368void QgsProcessingAggregateWidgetWrapper::setWidgetValue(
const QVariant &value,
QgsProcessingContext & )
371 mPanel->setValue( value );
374QVariant QgsProcessingAggregateWidgetWrapper::widgetValue()
const
376 return mPanel ? mPanel->value() : QVariant();
379QStringList QgsProcessingAggregateWidgetWrapper::compatibleParameterTypes()
const
385QStringList QgsProcessingAggregateWidgetWrapper::compatibleOutputTypes()
const
387 return QStringList();
390QString QgsProcessingAggregateWidgetWrapper::modelerExpressionFormatString()
const
392 return tr(
"an array of map items, each containing a 'name', 'type', 'aggregate' and 'input' value (and optional 'length' and 'precision' values)." );
395const QgsVectorLayer *QgsProcessingAggregateWidgetWrapper::linkedVectorLayer()
const
397 if ( mPanel && mPanel->layer() )
398 return mPanel->layer();
QFlags< ProcessingParameterFlag > ProcessingParameterFlags
Flags which dictate the behavior of Processing parameters.
Abstract interface for generating an expression context.
Encapsulate a field in an attribute table or data source.
Abstract base class for processing algorithms.
Contains information about the context in which a processing algorithm is executed.
QgsMapLayer * takeResultLayer(const QString &id)
Takes the result map layer with matching id from the context and transfers ownership of it back to th...
WidgetType
Types of dialogs which Processing widgets can be created for.
@ Standard
Standard algorithm dialog.
@ Batch
Batch processing dialog.
A parameter for "aggregate" configurations, which consist of a definition of desired output fields,...
static QString typeName()
Returns the type name for the parameter class.
Base class for the definition of processing parameters.
QString description() const
Returns the description for the parameter.
QString name() const
Returns the name of the parameter.
An input feature source (such as vector layers) parameter for processing algorithms.
A vector layer (with or without geometry) parameter for processing algorithms.
Contains settings which reflect the context in which a Processing parameter widget is shown,...
QgsProcessingModelAlgorithm * model() const
Returns the model which the parameter widget is associated with.
static QgsVectorLayer * parameterAsVectorLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a vector layer.
static QVariant createNullVariant(QMetaType::Type metaType)
Helper method to properly create a null QVariant from a metaType Returns the created QVariant.
Represents a vector layer which manages a vector based data sets.
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 allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
The Aggregate struct holds information about an aggregate column.
QString source
The source expression used as the input for the aggregate calculation.
QString delimiter
Delimiter string.
QString aggregate
Aggregate name.
QgsField field
The field in its current status (it might have been renamed)