Delete features (feature service)

// [WriteFile Name=DeleteFeaturesFeatureService, Category=EditData]
// [Legal]
// Copyright 2016 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

// sample headers
#include "DeleteFeaturesFeatureService.h"

// ArcGIS Maps SDK headers
#include "ArcGISFeature.h"
#include "AttributeListModel.h"
#include "Basemap.h"
#include "CalloutData.h"
#include "Envelope.h"
#include "Feature.h"
#include "FeatureEditResult.h"
#include "FeatureIterator.h"
#include "FeatureLayer.h"
#include "FeatureQueryResult.h"
#include "IdentifyLayerResult.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "MapViewTypes.h"
#include "Point.h"
#include "QueryParameters.h"
#include "ServiceFeatureTable.h"
#include "SpatialReference.h"
#include "Viewpoint.h"

// Qt headers
#include <QFuture>
#include <QMouseEvent>
#include <QString>
#include <QUrl>
#include <QUuid>

// STL headers
#include <memory>

using namespace Esri::ArcGISRuntime;

DeleteFeaturesFeatureService::DeleteFeaturesFeatureService(QQuickItem* parent) :
  QQuickItem(parent)
{
}

DeleteFeaturesFeatureService::~DeleteFeaturesFeatureService() = default;

void DeleteFeaturesFeatureService::init()
{
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<DeleteFeaturesFeatureService>("Esri.Samples", 1, 0, "DeleteFeaturesFeatureServiceSample");
  qmlRegisterUncreatableType<CalloutData>("Esri.Samples", 1, 0, "CalloutData", "CalloutData is an uncreatable type");
}

void DeleteFeaturesFeatureService::componentComplete()
{
  QQuickItem::componentComplete();

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");
  m_mapView->setWrapAroundMode(WrapAroundMode::Disabled);

  // create a Map by passing in the Basemap
  m_map = new Map(BasemapStyle::ArcGISStreets, this);
  m_map->setInitialViewpoint(Viewpoint(Point(-10800000, 4500000, SpatialReference(102100)), 3e7));

  // set map on the map view
  m_mapView->setMap(m_map);

  // create the ServiceFeatureTable
  m_featureTable = new ServiceFeatureTable(QUrl("https://sampleserver6.arcgisonline.com/arcgis/rest/services/DamageAssessment/FeatureServer/0"), this);

  // create the FeatureLayer with the ServiceFeatureTable and add it to the Map
  m_featureLayer = new FeatureLayer(m_featureTable, this);
  m_map->operationalLayers()->append(m_featureLayer);

  connectSignals();
}

void DeleteFeaturesFeatureService::connectSignals()
{
  // connect to the mouse clicked signal on the MapQuickView
  connect(m_mapView, &MapQuickView::mouseClicked, this, [this](QMouseEvent& mouseEvent)
  {
    // first clear the selection
    m_featureLayer->clearSelection();

    // set the properties for qml
    emit hideWindow();

    //! [DeleteFeaturesFeatureService identify feature]
    // call identify on the map view
    constexpr double tolerance = 5.0;
    constexpr int maxResults = 1;
    constexpr bool returnPopupsOnly = false;
    m_mapView->identifyLayerAsync(m_featureLayer, mouseEvent.position(), tolerance, returnPopupsOnly, maxResults).then(this, [this](IdentifyLayerResult* rawIdentifyResult)
    {
      onIdentifyLayerCompleted_(rawIdentifyResult);
    });
    //! [DeleteFeaturesFeatureService identify feature]

    // connect to the viewpoint changed signal on the MapQuickView
    connect(m_mapView, &MapQuickView::viewpointChanged, this, [this]()
    {
      m_featureLayer->clearSelection();
      emit hideWindow();
    });
  });
}

void DeleteFeaturesFeatureService::deleteSelectedFeature()
{
  m_featureTable->deleteFeatureAsync(m_selectedFeature).then(this, [this]()
  {
    // handle the completion of applyEditsAsync from the ServiceFeatureTable
    m_featureTable->applyEditsAsync().then(this, [](const QList<FeatureEditResult*>& featureEditResults)
    {
      // obtain the first item in the list
      FeatureEditResult* featureEditResult = featureEditResults.isEmpty() ? nullptr : featureEditResults.first();
      // check if there were errors, and if not, log the new object ID
      if (featureEditResult && !featureEditResult->isCompletedWithErrors())
        qDebug() << "Successfully deleted Object ID:" << featureEditResult->objectId();
      else
        qDebug() << "Apply edits error.";

      qDeleteAll(featureEditResults);
    });
  });
}

void DeleteFeaturesFeatureService::onIdentifyLayerCompleted_(IdentifyLayerResult* rawIdentifyResult)
{
  // Deletes rawIdentifyResult instance when we leave scope.
  auto identifyResult = std::unique_ptr<IdentifyLayerResult>(rawIdentifyResult);

  if (!identifyResult)
  {
    return;
  }

  if (identifyResult->geoElements().isEmpty())
  {
    return;
  }

  // delete selected feature member if not nullptr
  if (m_selectedFeature)
  {
    delete m_selectedFeature;
    m_selectedFeature = nullptr;
  }

  GeoElement* element = identifyResult->geoElements().at(0);
  if (!element)
  {
    return;
  }

  // select the item in the result
  QueryParameters query;
  query.setObjectIds(QList<qint64> { element->attributes()->attributeValue(QStringLiteral("objectid")).toLongLong() });
  m_featureLayer->selectFeaturesAsync(query, SelectionMode::New).then(this, [this](FeatureQueryResult* rawFeatureQueryResult)
  {
    onSelectFeaturesCompleted_(rawFeatureQueryResult);
  });

  // set selected feature member
  m_selectedFeature = static_cast<ArcGISFeature*>(element);
  // Don't delete the selected feature when the IdentityResult is deleted.
  m_selectedFeature->setParent(this);
}

void DeleteFeaturesFeatureService::onSelectFeaturesCompleted_(FeatureQueryResult* rawFeatureQueryResult)
{
  // Delete rawFeatureQueryResult pointer when we leave scope.
  auto featureQueryResult = std::unique_ptr<FeatureQueryResult>(rawFeatureQueryResult);

  FeatureIterator iter = featureQueryResult->iterator();
  if (iter.hasNext())
  {
    Feature* feat = iter.next();
    // emit signal for QML
    const QString featureType = feat->attributes()->attributeValue(QStringLiteral("typdamage")).toString();
    // Html tags used to bold and increase pt size of callout title.
    m_mapView->calloutData()->setTitle(QString("<br><b><font size=\"+2\">%1</font></b>").arg(featureType));
    m_mapView->calloutData()->setLocation(feat->geometry().extent().center());
    emit featureSelected();
  }
}

// [WriteFile Name=DeleteFeaturesFeatureService, Category=EditData]
// [Legal]
// Copyright 2016 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

#ifndef DELETE_FEATURES_FEATURE_SERVICE_H
#define DELETE_FEATURES_FEATURE_SERVICE_H

// Qt headers
#include <QQuickItem>

namespace Esri::ArcGISRuntime
{
  class Map;
  class MapQuickView;
  class FeatureLayer;
  class ServiceFeatureTable;
  class Feature;
  class IdentifyLayerResult;
  class FeatureQueryResult;
}

class QString;

class DeleteFeaturesFeatureService : public QQuickItem
{
  Q_OBJECT

public:
  explicit DeleteFeaturesFeatureService(QQuickItem* parent = nullptr);
  ~DeleteFeaturesFeatureService() override;

  void componentComplete() override;
  static void init();
  Q_INVOKABLE void deleteSelectedFeature();

signals:
  void featureSelected();
  void hideWindow();

private:
  void connectSignals();
  void onIdentifyLayerCompleted_(Esri::ArcGISRuntime::IdentifyLayerResult* rawIdentifyResult);
  void onSelectFeaturesCompleted_(Esri::ArcGISRuntime::FeatureQueryResult* rawFeatureQueryResult);

private:
  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::FeatureLayer* m_featureLayer = nullptr;
  Esri::ArcGISRuntime::ServiceFeatureTable* m_featureTable = nullptr;
  Esri::ArcGISRuntime::Feature* m_selectedFeature = nullptr;
};

#endif // DELETE_FEATURES_FEATURE_SERVICE_H

// [WriteFile Name=DeleteFeaturesFeatureService, Category=EditData]
// [Legal]
// Copyright 2016 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

import QtQuick
import QtQuick.Controls
import Esri.Samples
import Esri.ArcGISRuntime.Toolkit

DeleteFeaturesFeatureServiceSample {
    id: deleteFeaturesSample
    width: 800
    height: 600

    MapView {
        id: mapView
        anchors.fill: parent
        objectName: "mapView"

        Component.onCompleted: {
            // Set the focus on MapView to initially enable keyboard navigation
            forceActiveFocus();
        }

        // map callout window
        Callout {
            id: callout
            calloutData: mapView.calloutData
            background: Rectangle {
                border.color: "lightgrey"
                border.width : 1
            }
            accessoryButtonType: "Custom"
            customImageUrl: "qrc:/Samples/EditData/DeleteFeaturesFeatureService/ic_menu_trash_light.png"
            leaderPosition: Callout.LeaderPosition.Automatic
            onAccessoryButtonClicked: {
                if (callout.visible)
                    callout.dismiss();
                deleteFeaturesSample.deleteSelectedFeature();
            }
        }
    }

    onFeatureSelected: {
        // show the callout
        callout.showCallout();
    }

    onHideWindow: {
        // hide the callout
        if (callout.visible)
            callout.dismiss();
    }
}

// [Legal]
// Copyright 2015 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

// sample headers
#include "DeleteFeaturesFeatureService.h"

// ArcGIS Maps SDK headers
#include "ArcGISRuntimeEnvironment.h"

// Qt headers
#include <QCommandLineParser>
#include <QDir>
#include <QGuiApplication>
#include <QQmlEngine>
#include <QQuickView>
#include <QSettings>

// Other headers
#include "Esri/ArcGISRuntime/Toolkit/register.h"

// Platform specific headers
#ifdef Q_OS_WIN
#include <Windows.h>
#endif

#define STRINGIZE(x) #x
#define QUOTE(x) STRINGIZE(x)

int main(int argc, char *argv[])
{
  Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setUseLegacyAuthentication(false);
  QGuiApplication app(argc, argv);
  app.setApplicationName(QString("Delete Features Feature Service"));

  // Use of ArcGIS location services, such as basemap styles, geocoding, and routing services,
  // requires an access token. For more information see
  // https://links.esri.com/arcgis-runtime-security-auth.

  // The following methods grant an access token:

  // 1. User authentication: Grants a temporary access token associated with a user's ArcGIS account.
  // To generate a token, a user logs in to the app with an ArcGIS account that is part of an
  // organization in ArcGIS Online or ArcGIS Enterprise.

  // 2. API key authentication: Get a long-lived access token that gives your application access to
  // ArcGIS location services. Go to the tutorial at https://links.esri.com/create-an-api-key.
  // Copy the API Key access token.

  const QString accessToken = QString("");

  if (accessToken.isEmpty())
  {
      qWarning() << "Use of ArcGIS location services, such as the basemap styles service, requires" <<
                    "you to authenticate with an ArcGIS account or set the API Key property.";
  }
  else
  {
      Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setApiKey(accessToken);
  }

  // Initialize the sample
  DeleteFeaturesFeatureService::init();

  // Initialize application view
  QQuickView view;
  view.setResizeMode(QQuickView::SizeRootObjectToView);

  // Add the import Path
  view.engine()->addImportPath(QDir(QCoreApplication::applicationDirPath()).filePath("qml"));

  QString arcGISRuntimeImportPath = QUOTE(ARCGIS_RUNTIME_IMPORT_PATH);

 #if defined(LINUX_PLATFORM_REPLACEMENT)
  // on some linux platforms the string 'linux' is replaced with 1
  // fix the replacement paths which were created
  QString replaceString = QUOTE(LINUX_PLATFORM_REPLACEMENT);
  arcGISRuntimeImportPath = arcGISRuntimeImportPath.replace(replaceString, "linux", Qt::CaseSensitive);
 #endif

  // Add the Runtime and Extras path
  view.engine()->addImportPath(arcGISRuntimeImportPath);

  Esri::ArcGISRuntime::Toolkit::registerComponents(*(view.engine()));

  // Set the source
  view.setSource(QUrl("qrc:/Samples/EditData/DeleteFeaturesFeatureService/DeleteFeaturesFeatureService.qml"));

  view.show();

  return app.exec();
}