mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-16 00:03:12 -04:00
Since it's safe to evaluate parameters in background threads now, it's usually going to be ok to evaluate everything in the processAlgorithm step. This keeps the algorithm code as simple as possible, and will make porting faster. Note that the prepare/postProcess virtual methods still exist and can be used when an algorithm MUST do setup/cleanup work in the main thread.
139 lines
5.5 KiB
Python
139 lines
5.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
SelectByAttribute.py
|
|
---------------------
|
|
Date : May 2010
|
|
Copyright : (C) 2010 by Michael Minn
|
|
Email : pyqgis at michaelminn 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__ = 'Michael Minn'
|
|
__date__ = 'May 2010'
|
|
__copyright__ = '(C) 2010, Michael Minn'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
from qgis.core import (QgsApplication)
|
|
from qgis.PyQt.QtCore import QVariant
|
|
from qgis.core import (QgsExpression,
|
|
QgsProcessingUtils,
|
|
QgsProcessingParameterVectorLayer,
|
|
QgsProcessingParameterField,
|
|
QgsProcessingParameterEnum,
|
|
QgsProcessingParameterString,
|
|
QgsProcessingOutputVectorLayer)
|
|
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
|
|
from processing.core.GeoAlgorithmExecutionException import GeoAlgorithmExecutionException
|
|
|
|
|
|
class SelectByAttribute(QgisAlgorithm):
|
|
INPUT = 'INPUT'
|
|
FIELD = 'FIELD'
|
|
OPERATOR = 'OPERATOR'
|
|
VALUE = 'VALUE'
|
|
OUTPUT = 'OUTPUT'
|
|
|
|
OPERATORS = ['=',
|
|
'!=',
|
|
'>',
|
|
'>=',
|
|
'<',
|
|
'<=',
|
|
'begins with',
|
|
'contains',
|
|
'is null',
|
|
'is not null',
|
|
'does not contain'
|
|
]
|
|
STRING_OPERATORS = ['begins with',
|
|
'contains',
|
|
'does not contain']
|
|
|
|
def tags(self):
|
|
return self.tr('select,attribute,value,contains,null,field').split(',')
|
|
|
|
def group(self):
|
|
return self.tr('Vector selection tools')
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
self.i18n_operators = ['=',
|
|
'!=',
|
|
'>',
|
|
'>=',
|
|
'<',
|
|
'<=',
|
|
self.tr('begins with'),
|
|
self.tr('contains'),
|
|
self.tr('is null'),
|
|
self.tr('is not null'),
|
|
self.tr('does not contain')
|
|
]
|
|
|
|
self.addParameter(QgsProcessingParameterVectorLayer(self.INPUT, self.tr('Input layer')))
|
|
|
|
self.addParameter(QgsProcessingParameterField(self.FIELD,
|
|
self.tr('Selection attribute'), parentLayerParameterName=self.INPUT))
|
|
self.addParameter(QgsProcessingParameterEnum(self.OPERATOR,
|
|
self.tr('Operator'), self.i18n_operators))
|
|
self.addParameter(QgsProcessingParameterString(self.VALUE, self.tr('Value')))
|
|
|
|
self.addOutput(QgsProcessingOutputVectorLayer(self.OUTPUT, self.tr('Selected (attribute)')))
|
|
|
|
def name(self):
|
|
return 'selectbyattribute'
|
|
|
|
def displayName(self):
|
|
return self.tr('Select by attribute')
|
|
|
|
def processAlgorithm(self, parameters, context, feedback):
|
|
layer = self.parameterAsVectorLayer(parameters, self.INPUT, context)
|
|
|
|
fieldName = self.parameterAsString(parameters, self.FIELD, context)
|
|
operator = self.OPERATORS[self.parameterAsEnum(parameters, self.OPERATOR, context)]
|
|
value = self.parameterAsString(parameters, self.VALUE, context)
|
|
|
|
fields = layer.fields()
|
|
|
|
idx = layer.fields().lookupField(fieldName)
|
|
fieldType = fields[idx].type()
|
|
|
|
if fieldType != QVariant.String and operator in self.STRING_OPERATORS:
|
|
op = ''.join(['"%s", ' % o for o in self.STRING_OPERATORS])
|
|
raise GeoAlgorithmExecutionException(
|
|
self.tr('Operators {0} can be used only with string fields.').format(op))
|
|
|
|
field_ref = QgsExpression.quotedColumnRef(fieldName)
|
|
quoted_val = QgsExpression.quotedValue(value)
|
|
if operator == 'is null':
|
|
expression_string = '{} IS NULL'.format(field_ref)
|
|
elif operator == 'is not null':
|
|
expression_string = '{} IS NOT NULL'.format(field_ref)
|
|
elif operator == 'begins with':
|
|
expression_string = """%s LIKE '%s%%'""" % (field_ref, value)
|
|
elif operator == 'contains':
|
|
expression_string = """%s LIKE '%%%s%%'""" % (field_ref, value)
|
|
elif operator == 'does not contain':
|
|
expression_string = """%s NOT LIKE '%%%s%%'""" % (field_ref, value)
|
|
else:
|
|
expression_string = '{} {} {}'.format(field_ref, operator, quoted_val)
|
|
|
|
expression = QgsExpression(expression_string)
|
|
if expression.hasParserError():
|
|
raise GeoAlgorithmExecutionException(expression.parserErrorString())
|
|
|
|
layer.selectByExpression(expression_string)
|
|
return {self.OUTPUT: parameters[self.INPUT]}
|