Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmbatchgeocode.h
       3                 :            :                          ------------------
       4                 :            :     begin                : August 2020
       5                 :            :     copyright            : (C) 2020 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSALGORITHMBATCHGEOCODE_H
      19                 :            : #define QGSALGORITHMBATCHGEOCODE_H
      20                 :            : 
      21                 :            : #include "qgis_sip.h"
      22                 :            : #include "qgis_analysis.h"
      23                 :            : #include "qgsprocessingalgorithm.h"
      24                 :            : 
      25                 :            : class QgsGeocoderInterface;
      26                 :            : 
      27                 :            : /**
      28                 :            :  * \ingroup analysis
      29                 :            :  *
      30                 :            :  * \brief A base class for batch geocoder algorithms, which takes a QgsGeocoderInterface object and exposes it as
      31                 :            :  * a Processing algorithm for batch geocoding operations.
      32                 :            :  *
      33                 :            :  * ### Example
      34                 :            :  *
      35                 :            :  * \code{.py}
      36                 :            :  *   # create a class which implements the QgsGeocoderInterface interface:
      37                 :            :  *   class MyGeocoder(QgsGeocoderInterface):
      38                 :            :  *
      39                 :            :  *      def geocodeString(self, string, context, feedback):
      40                 :            :  *         # calculate and return results...
      41                 :            :  *
      42                 :            :  *   my_geocoder = MyGeocoder()
      43                 :            :  *
      44                 :            :  *   # create an algorithm which allows for batch geocoding operations using the custom geocoder interface
      45                 :            :  *   # and implement the few required pure virtual methods
      46                 :            :  *   class MyGeocoderAlgorithm(QgsBatchGeocodeAlgorithm):
      47                 :            :  *
      48                 :            :  *       def __init__(self):
      49                 :            :  *           super().__init__(my_geocoder)
      50                 :            :  *
      51                 :            :  *       def displayName(self):
      52                 :            :  *           return "My Geocoder"
      53                 :            :  *
      54                 :            :  *       def name(self):
      55                 :            :  *           return "my_geocoder_alg"
      56                 :            :  *
      57                 :            :  *       def createInstance(self):
      58                 :            :  *           return MyGeocoderAlgorithm()
      59                 :            :  *
      60                 :            :  *       # optionally, the group(), groupId(), tags(), shortHelpString() and other metadata style methods can be overridden and customized:
      61                 :            :  *       def tags(self):
      62                 :            :  *           return 'geocode,my service,batch'
      63                 :            :  *
      64                 :            :  * \endcode
      65                 :            :  *
      66                 :            :  * \since QGIS 3.18
      67                 :            :  */
      68                 :          0 : class ANALYSIS_EXPORT QgsBatchGeocodeAlgorithm : public QgsProcessingFeatureBasedAlgorithm
      69                 :            : {
      70                 :            : 
      71                 :            :   public:
      72                 :            : 
      73                 :            :     /**
      74                 :            :      * Constructor for QgsBatchGeocodeAlgorithm.
      75                 :            :      *
      76                 :            :      * The \a geocoder must specify an instance of a class which implements the QgsGeocoderInterface
      77                 :            :      * interface. Ownership of \a geocoder is not transferred, and the caller must ensure that \a geocoder
      78                 :            :      * exists for the lifetime of this algorithm.
      79                 :            :      */
      80                 :            :     QgsBatchGeocodeAlgorithm( QgsGeocoderInterface *geocoder );
      81                 :            : 
      82                 :            :     void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
      83                 :            :     QStringList tags() const override;
      84                 :            :     QString group() const override;
      85                 :            :     QString groupId() const override;
      86                 :            :     QList<int> inputLayerTypes() const override;
      87                 :            :     bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
      88                 :            : 
      89                 :            :   protected:
      90                 :            :     QString outputName() const override;
      91                 :            :     bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
      92                 :            :     QgsFeatureList processFeature( const QgsFeature &feature,  QgsProcessingContext &, QgsProcessingFeedback *feedback ) override;
      93                 :            :     QgsCoordinateReferenceSystem outputCrs( const QgsCoordinateReferenceSystem &inputCrs ) const override;
      94                 :            :     QgsFields outputFields( const QgsFields &inputFields ) const override;
      95                 :            :     QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type inputWkbType ) const override;
      96                 :            : 
      97                 :            :   private:
      98                 :            :     bool mIsInPlace = false;
      99                 :            :     QString mAddressField;
     100                 :            :     QgsGeocoderInterface *mGeocoder = nullptr;
     101                 :            :     QgsStringMap mInPlaceFieldMap;
     102                 :            :     mutable QgsCoordinateReferenceSystem mOutputCrs;
     103                 :            :     mutable QStringList mAdditionalFields;
     104                 :            : 
     105                 :            : };
     106                 :            : 
     107                 :            : ///@endcond PRIVATE
     108                 :            : 
     109                 :            : #endif // QGSALGORITHMBATCHGEOCODE_H
     110                 :            : 
     111                 :            :