Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmjoinbylocation.h
       3                 :            :                          ---------------------
       4                 :            :     begin                : January 2020
       5                 :            :     copyright            : (C) 2020 by Alexis Roy-Lizotte
       6                 :            :     email                : roya2 at premiertech 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 QGSALGORITHMJOINBYLOCATION_H
      19                 :            : #define QGSALGORITHMJOINBYLOCATION_H
      20                 :            : 
      21                 :            : #define SIP_NO_FILE
      22                 :            : 
      23                 :            : #include "qgis.h"
      24                 :            : #include "qgsprocessingalgorithm.h"
      25                 :            : #include "qgsfeature.h"
      26                 :            : 
      27                 :            : 
      28                 :            : ///@cond PRIVATE
      29                 :            : 
      30                 :            : /**
      31                 :            :  * Native join by location algorithm
      32                 :            :  *
      33                 :            :  * \ since QGIS 3.12
      34                 :            :  */
      35                 :          0 : class QgsJoinByLocationAlgorithm : public QgsProcessingAlgorithm
      36                 :            : {
      37                 :            : 
      38                 :            :   public:
      39                 :            : 
      40                 :          0 :     QgsJoinByLocationAlgorithm() = default;
      41                 :            :     void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
      42                 :            :     QString name() const override;
      43                 :            :     QString displayName() const override;
      44                 :            :     QStringList tags() const override;
      45                 :            :     QString group() const override;
      46                 :            :     QString groupId() const override;
      47                 :            :     QString shortHelpString() const override;
      48                 :            :     QString shortDescription() const override;
      49                 :            :     QgsJoinByLocationAlgorithm *createInstance() const override SIP_FACTORY;
      50                 :            : 
      51                 :            :   protected:
      52                 :            :     QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
      53                 :            :     bool processFeatureFromJoinSource( QgsFeature &joinFeature, QgsProcessingFeedback *feedback );
      54                 :            :     bool processFeatureFromInputSource( QgsFeature &inputFeature, QgsProcessingContext &context, QgsProcessingFeedback *feedback );
      55                 :            :     bool featureFilter( const QgsFeature &feature, QgsGeometryEngine *engine, bool comparingToJoinedFeature ) const;
      56                 :            : 
      57                 :            :   private:
      58                 :            : 
      59                 :            :     void processAlgorithmByIteratingOverJoinedSource( QgsProcessingContext &context, QgsProcessingFeedback *feedback );
      60                 :            :     void processAlgorithmByIteratingOverInputSource( QgsProcessingContext &context, QgsProcessingFeedback *feedback );
      61                 :            : 
      62                 :            :     enum JoinMethod
      63                 :            :     {
      64                 :            :       OneToMany = 0,
      65                 :            :       JoinToFirst = 1,
      66                 :            :       JoinToLargestOverlap = 2
      67                 :            :     };
      68                 :          0 :     long mJoinedCount = 0;
      69                 :            :     std::unique_ptr< QgsProcessingFeatureSource > mBaseSource;
      70                 :            :     std::unique_ptr< QgsProcessingFeatureSource > mJoinSource;
      71                 :            :     QgsAttributeList mJoinedFieldIndices;
      72                 :          0 :     bool mDiscardNonMatching = false;
      73                 :            :     std::unique_ptr< QgsFeatureSink > mJoinedFeatures;
      74                 :            :     QgsFeatureIds mAddedIds;
      75                 :            :     std::unique_ptr< QgsFeatureSink > mUnjoinedFeatures;
      76                 :          0 :     JoinMethod mJoinMethod = OneToMany;
      77                 :            :     QList<int> mPredicates;
      78                 :            : 
      79                 :            :     static void sortPredicates( QList<int > &predicates );
      80                 :            : };
      81                 :            : 
      82                 :            : ///@endcond PRIVATE
      83                 :            : 
      84                 :            : #endif // QGSALGORITHMJOINBYLOCATION_H
      85                 :            : 
      86                 :            :