Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmspatialindex.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : November 2019
       5                 :            :     copyright            : (C) 2019 by Alexander Bruy
       6                 :            :     email                : alexander dot bruy 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                 :            : #include "qgsalgorithmspatialindex.h"
      19                 :            : #include "qgsvectorlayer.h"
      20                 :            : #include "qgsvectordataprovider.h"
      21                 :            : 
      22                 :            : ///@cond PRIVATE
      23                 :            : 
      24                 :          0 : QString QgsSpatialIndexAlgorithm::name() const
      25                 :            : {
      26                 :          0 :   return QStringLiteral( "createspatialindex" );
      27                 :            : }
      28                 :            : 
      29                 :          0 : QString QgsSpatialIndexAlgorithm::displayName() const
      30                 :            : {
      31                 :          0 :   return QObject::tr( "Create spatial index" );
      32                 :            : }
      33                 :            : 
      34                 :          0 : QStringList QgsSpatialIndexAlgorithm::tags() const
      35                 :            : {
      36                 :          0 :   return QObject::tr( "table,spatial,geometry,index,create,vector" ).split( ',' );
      37                 :          0 : }
      38                 :            : 
      39                 :          0 : QString QgsSpatialIndexAlgorithm::group() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "Vector general" );
      42                 :            : }
      43                 :            : 
      44                 :          0 : QString QgsSpatialIndexAlgorithm::groupId() const
      45                 :            : {
      46                 :          0 :   return QStringLiteral( "vectorgeneral" );
      47                 :            : }
      48                 :            : 
      49                 :          0 : QgsProcessingAlgorithm::Flags QgsSpatialIndexAlgorithm::flags() const
      50                 :            : {
      51                 :          0 :   return QgsProcessingAlgorithm::flags() | QgsProcessingAlgorithm::FlagNoThreading;
      52                 :            : }
      53                 :            : 
      54                 :            : 
      55                 :          0 : QString QgsSpatialIndexAlgorithm::shortHelpString() const
      56                 :            : {
      57                 :          0 :   return QObject::tr( "Creates an index to speed up access to the features "
      58                 :            :                       "in a layer based on their spatial location. Support "
      59                 :            :                       "for spatial index creation is dependent on the layer's "
      60                 :            :                       "data provider." );
      61                 :            : }
      62                 :            : 
      63                 :          0 : QgsSpatialIndexAlgorithm *QgsSpatialIndexAlgorithm::createInstance() const
      64                 :            : {
      65                 :          0 :   return new QgsSpatialIndexAlgorithm();
      66                 :            : }
      67                 :            : 
      68                 :          0 : void QgsSpatialIndexAlgorithm::initAlgorithm( const QVariantMap & )
      69                 :            : {
      70                 :          0 :   addParameter( new QgsProcessingParameterVectorLayer( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
      71                 :            : 
      72                 :          0 :   addOutput( new QgsProcessingOutputVectorLayer( QStringLiteral( "OUTPUT" ), QObject::tr( "Indexed layer" ) ) );
      73                 :          0 : }
      74                 :            : 
      75                 :          0 : QVariantMap QgsSpatialIndexAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      76                 :            : {
      77                 :          0 :   QgsVectorLayer *layer = parameterAsVectorLayer( parameters, QStringLiteral( "INPUT" ), context );
      78                 :            : 
      79                 :          0 :   if ( !layer )
      80                 :          0 :     throw QgsProcessingException( QObject::tr( "Could not load source layer for %1." ).arg( QLatin1String( "INPUT" ) ) );
      81                 :            : 
      82                 :          0 :   QgsVectorDataProvider *provider = layer->dataProvider();
      83                 :            : 
      84                 :          0 :   if ( provider->capabilities() & QgsVectorDataProvider::CreateSpatialIndex )
      85                 :            :   {
      86                 :          0 :     if ( !provider->createSpatialIndex() )
      87                 :            :     {
      88                 :          0 :       feedback->pushInfo( QObject::tr( "Could not create spatial index" ) );
      89                 :          0 :     }
      90                 :          0 :   }
      91                 :            :   else
      92                 :            :   {
      93                 :          0 :     feedback->pushInfo( QObject::tr( "Layer's data provider does not support spatial indexes" ) );
      94                 :            :   }
      95                 :            : 
      96                 :          0 :   QVariantMap outputs;
      97                 :          0 :   outputs.insert( QStringLiteral( "OUTPUT" ), layer->id() );
      98                 :          0 :   return outputs;
      99                 :          0 : }
     100                 :            : 
     101                 :            : ///@endcond