mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-13 00:03:09 -04:00
1e13d733c2
initAlgorithm() method This allows 2 benefits: - algorithms can be subclassed and have subclasses add additional parameters/outputs to the algorithm. With the previous approach of declaring parameters/outputs in the constructor, it's not possible to call virtual methods to add additional parameters/ outputs (since you can't call virtual methods from a constructor). - initAlgorithm takes a variant map argument, allowing the algorithm to dynamically adjust its declared parameters and outputs according to this configuration map. This potentially allows model algorithms which can be configured to have variable numbers of parameters and outputs at run time. E.g. a "router" algorithm which directs features to one of any number of output sinks depending on some user configured criteria.
82 lines
3.3 KiB
Python
82 lines
3.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
CreateAttributeIndex.py
|
|
-----------------------
|
|
Date : November 2016
|
|
Copyright : (C) 2016 by Nyall Dawson
|
|
Email : nyall dot dawson at gmail dot com
|
|
***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
|
|
__author__ = 'Nyall Dawson'
|
|
__date__ = 'November 2016'
|
|
__copyright__ = '(C) 2016, Nyall Dawson'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
from qgis.core import (QgsVectorDataProvider,
|
|
QgsFields,
|
|
QgsApplication,
|
|
QgsProcessingParameterVectorLayer,
|
|
QgsProcessingParameterField,
|
|
QgsProcessingParameterDefinition,
|
|
QgsProcessingOutputVectorLayer)
|
|
|
|
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
|
|
|
|
|
|
class CreateAttributeIndex(QgisAlgorithm):
|
|
|
|
INPUT = 'INPUT'
|
|
FIELD = 'FIELD'
|
|
OUTPUT = 'OUTPUT'
|
|
|
|
def group(self):
|
|
return self.tr('Vector general tools')
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def initAlgorithm(self, config=None):
|
|
self.addParameter(QgsProcessingParameterVectorLayer(self.INPUT,
|
|
self.tr('Input Layer')))
|
|
self.addParameter(QgsProcessingParameterField(self.FIELD,
|
|
self.tr('Attribute to index'), None, self.INPUT))
|
|
self.addOutput(QgsProcessingOutputVectorLayer(self.OUTPUT, self.tr('Indexed layer')))
|
|
|
|
def name(self):
|
|
return 'createattributeindex'
|
|
|
|
def displayName(self):
|
|
return self.tr('Create attribute index')
|
|
|
|
def processAlgorithm(self, parameters, context, feedback):
|
|
layer = self.parameterAsVectorLayer(parameters, self.INPUT, context)
|
|
field = self.parameterAsString(parameters, self.FIELD, context)
|
|
provider = layer.dataProvider()
|
|
|
|
field_index = layer.fields().lookupField(field)
|
|
if field_index < 0 or layer.fields().fieldOrigin(field_index) != QgsFields.OriginProvider:
|
|
feedback.pushInfo(self.tr('Can not create attribute index on "{}"').format(field))
|
|
else:
|
|
provider_index = layer.fields().fieldOriginIndex(field_index)
|
|
if provider.capabilities() & QgsVectorDataProvider.CreateAttributeIndex:
|
|
if not provider.createAttributeIndex(provider_index):
|
|
feedback.pushInfo(self.tr('Could not create attribute index'))
|
|
else:
|
|
feedback.pushInfo(self.tr("Layer's data provider does not support "
|
|
"creating attribute indexes"))
|
|
|
|
return {self.OUTPUT: layer.id()}
|