qgsalgorithmbatchgeocode.cpp

Go to the documentation of this file.

/***************************************************************************
                         qgsalgorithmbatchgeocode.cpp
                         ------------------
    begin                : August 2020
    copyright            : (C) 2020 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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsalgorithmbatchgeocode.h"
 
#include "qgsgeocoder.h"
#include "qgsgeocodercontext.h"
#include "qgsgeocoderresult.h"
#include "qgsvectorlayer.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
QgsBatchGeocodeAlgorithm::QgsBatchGeocodeAlgorithm( QgsGeocoderInterface *geocoder )
  : QgsProcessingFeatureBasedAlgorithm()
  , mGeocoder( geocoder )
{}
 
QStringList QgsBatchGeocodeAlgorithm::tags() const
{
  return QObject::tr( "geocode" ).split( ',' );
}
 
QString QgsBatchGeocodeAlgorithm::group() const
{
  return QObject::tr( "Vector general" );
}
 
QString QgsBatchGeocodeAlgorithm::groupId() const
{
  return u"vectorgeneral"_s;
}
 
void QgsBatchGeocodeAlgorithm::initParameters( const QVariantMap &configuration )
{
  mIsInPlace = configuration.value( u"IN_PLACE"_s ).toBool();
 
  addParameter( new QgsProcessingParameterField( u"FIELD"_s, QObject::tr( "Address field" ), QVariant(), u"INPUT"_s, Qgis::ProcessingFieldParameterDataType::String ) );
 
  if ( mIsInPlace )
  {
    const QgsFields newFields = mGeocoder->appendedFields();
    for ( const QgsField &newField : newFields )
      addParameter(
        new QgsProcessingParameterField( newField.name(), QObject::tr( "%1 field" ).arg( newField.name() ), newField.name(), u"INPUT"_s, Qgis::ProcessingFieldParameterDataType::Any, false, true )
      );
  }
}
 
QList<int> QgsBatchGeocodeAlgorithm::inputLayerTypes() const
{
  return QList<int>() << static_cast<int>( Qgis::ProcessingSourceType::Vector );
}
 
bool QgsBatchGeocodeAlgorithm::supportInPlaceEdit( const QgsMapLayer *layer ) const
{
  if ( const QgsVectorLayer *vl = qobject_cast<const QgsVectorLayer *>( layer ) )
  {
    return vl->geometryType() == Qgis::GeometryType::Point;
  }
  return false;
}
 
QString QgsBatchGeocodeAlgorithm::outputName() const
{
  return QObject::tr( "Geocoded" );
}
 
bool QgsBatchGeocodeAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
{
  mAddressField = parameterAsString( parameters, u"FIELD"_s, context );
 
  if ( mIsInPlace )
  {
    const QgsFields newFields = mGeocoder->appendedFields();
    for ( const QgsField &newField : newFields )
      mInPlaceFieldMap.insert( newField.name(), parameterAsString( parameters, newField.name(), context ) );
  }
 
  return true;
}
 
Qgis::WkbType QgsBatchGeocodeAlgorithm::outputWkbType( Qgis::WkbType ) const
{
  return Qgis::WkbType::Point;
}
 
QgsCoordinateReferenceSystem QgsBatchGeocodeAlgorithm::outputCrs( const QgsCoordinateReferenceSystem &inputCrs ) const
{
  mOutputCrs = inputCrs;
  return mOutputCrs;
}
 
QgsFields QgsBatchGeocodeAlgorithm::outputFields( const QgsFields &inputFields ) const
{
  if ( !mIsInPlace )
  {
    // append any additional fields created by the geocoder
    const QgsFields newFields = mGeocoder->appendedFields();
    mAdditionalFields = newFields.names();
 
    return QgsProcessingUtils::combineFields( inputFields, newFields );
  }
  else
  {
    return inputFields;
  }
}
 
QgsFeatureList QgsBatchGeocodeAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
{
  QGS_MARK_ALGORITHM_SOURCE
 
  QgsFeature f = feature;
 
  const QString address = f.attribute( mAddressField ).toString();
  if ( address.isEmpty() )
  {
    f.padAttributes( mAdditionalFields.count() );
    feedback->pushWarning( QObject::tr( "Empty address field for feature %1" ).arg( feature.id() ) );
    return QgsFeatureList() << f;
  }
 
  const QgsGeocoderContext geocodeContext( context.transformContext() );
  const QList<QgsGeocoderResult> results = mGeocoder->geocodeString( address, geocodeContext, feedback );
  if ( results.empty() )
  {
    f.padAttributes( mAdditionalFields.count() );
    feedback->pushWarning( QObject::tr( "No result for %1" ).arg( address ) );
    return QgsFeatureList() << f;
  }
 
  if ( !results.at( 0 ).isValid() )
  {
    f.padAttributes( mAdditionalFields.count() );
    feedback->reportError( QObject::tr( "Error geocoding %1: %2" ).arg( address, results.at( 0 ).error() ) );
    return QgsFeatureList() << f;
  }
 
  QgsAttributes attr = f.attributes();
  const QVariantMap additionalAttributes = results.at( 0 ).additionalAttributes();
  if ( !mIsInPlace )
  {
    for ( const QString &additionalField : mAdditionalFields )
    {
      attr.append( additionalAttributes.value( additionalField ) );
    }
    f.setAttributes( attr );
  }
  else
  {
    for ( auto it = mInPlaceFieldMap.constBegin(); it != mInPlaceFieldMap.constEnd(); ++it )
    {
      if ( !it.value().isEmpty() )
      {
        f.setAttribute( it.value(), additionalAttributes.value( it.key() ) );
      }
    }
  }
 
  const QgsCoordinateTransform transform = QgsCoordinateTransform( results.at( 0 ).crs(), mOutputCrs, context.transformContext() );
  QgsGeometry g = results.at( 0 ).geometry();
  try
  {
    g.transform( transform );
  }
  catch ( QgsCsException & )
  {
    feedback->reportError( QObject::tr( "Error transforming %1 to layer CRS" ).arg( address ) );
    return QgsFeatureList() << f;
  }
 
  f.setGeometry( g );
  return QgsFeatureList() << f;
}