Create mobile geodatabase

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/* Copyright 2022 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.
 *
 */

package com.esri.arcgismaps.sample.createmobilegeodatabase

import android.app.Dialog
import android.content.Intent
import android.os.Bundle
import android.util.Log
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity
import androidx.core.content.FileProvider
import androidx.databinding.DataBindingUtil
import androidx.lifecycle.lifecycleScope
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.arcgismaps.LoadStatus
import com.arcgismaps.data.FieldDescription
import com.arcgismaps.data.FieldType
import com.arcgismaps.data.Geodatabase
import com.arcgismaps.data.GeodatabaseFeatureTable
import com.arcgismaps.data.QueryParameters
import com.arcgismaps.data.TableDescription
import com.arcgismaps.geometry.GeometryType
import com.arcgismaps.geometry.Point
import com.arcgismaps.geometry.SpatialReference
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.layers.FeatureLayer
import com.esri.arcgismaps.sample.createmobilegeodatabase.databinding.ActivityMainBinding
import com.esri.arcgismaps.sample.createmobilegeodatabase.databinding.TableLayoutBinding
import com.esri.arcgismaps.sample.createmobilegeodatabase.databinding.TableRowBinding
import com.google.android.material.button.MaterialButton
import com.google.android.material.snackbar.Snackbar
import kotlinx.coroutines.launch
import java.io.File
import java.time.Instant

class MainActivity : AppCompatActivity() {

    // set up data binding for the activity
    private val activityMainBinding: ActivityMainBinding by lazy {
        DataBindingUtil.setContentView(this, R.layout.activity_main)
    }

    private val mapView by lazy {
        activityMainBinding.mapView
    }

    private val createButton: MaterialButton by lazy {
        activityMainBinding.createButton
    }

    private val viewTableButton: MaterialButton by lazy {
        activityMainBinding.viewTableButton
    }

    private val featureCountTextView: TextView by lazy {
        activityMainBinding.featureCount
    }

    // feature table created using mobile geodatabase and added to the MapView
    private var featureTable: GeodatabaseFeatureTable? = null

    // mobile geodatabase used to create and store
    // the feature attributes (LocationHistory.geodatabase)
    private var geodatabase: Geodatabase? = null


    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // authentication with an API key or named user is
        // required to access basemaps and other location services
        ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.API_KEY)
        lifecycle.addObserver(mapView)

        lifecycleScope.launch {
            mapView.onSingleTapConfirmed.collect { tapConfirmedEvent ->
                tapConfirmedEvent.mapPoint?.let {
                    // create a feature on where the user clicked
                    addFeature(it)
                }
            }
        }

        // displays a dialog to show the attributes of each feature in a feature table
        viewTableButton.setOnClickListener {
            lifecycleScope.launch {
                displayTable()
            }
        }

        // opens a share-sheet with the "LocationHistory.geodatabase" file
        createButton.setOnClickListener {
            // close the mobile geodatabase before sharing
            geodatabase?.close()

            // get the URI of the geodatabase file using FileProvider
            val geodatabaseURI = FileProvider.getUriForFile(
                this,
                getString(R.string.provider_authority),
                File(geodatabase?.path.toString())
            )

            // set up the sharing intent with the geodatabase URI
            val geodatabaseIntent = Intent(Intent.ACTION_SEND).apply {
                type = "*/*"
                putExtra(Intent.EXTRA_STREAM, geodatabaseURI)
            }

            // open the Android share sheet
            startActivity(geodatabaseIntent)
        }
    }


    /**
     * Create and load a new geodatabase file with TableDescription fields
     */
    private fun createGeodatabase() {
        // define the path and name of the geodatabase file
        // note: the path defined must be non-empty, available,
        // allow read/write access, and end in ".geodatabase"
        val file = File(getExternalFilesDir(null)?.path, "/LocationHistory.geodatabase")
        if (file.exists()) {
            file.delete()
        }
        // close the existing geodatabase
        geodatabase?.close()
        lifecycleScope.launch {
            // create a geodatabase file at the file path
            Geodatabase.create(file.path).onSuccess { geodatabase ->
                // keep the instance of the new geodatabase for sharing
                this@MainActivity.geodatabase = geodatabase
                createGeodatabaseFeatureTable()
            }.onFailure {
                showError(it.message.toString())
            }

        }
    }

    /**
     * Create a new [featureTable] using a custom table description
     * and add the feature layer to the MapView.
     */
    private suspend fun createGeodatabaseFeatureTable() {
        // construct a table description which stores features as points on map
        val tableDescription =
            TableDescription(
                "LocationHistory",
                SpatialReference.wgs84(),
                GeometryType.Point
            )
        // set up the fields to the table,
        // Field.Type.OID is the primary key of the SQLite table
        // Field.Type.DATE is a date column used to store a Calendar date
        // FieldDescriptions can be a SHORT, INTEGER, GUID, FLOAT, DOUBLE, DATE, TEXT, OID, GLOBALID, BLOB, GEOMETRY, RASTER, or XML.
        tableDescription.fieldDescriptions.addAll(
            listOf(
                FieldDescription("oid", FieldType.Oid),
                FieldDescription("collection_timestamp", FieldType.Date)
            )
        )

        // set any properties not needed to false
        tableDescription.apply {
            hasAttachments = false
            hasM = false
            hasZ = false
        }

        // add a new table to the geodatabase by creating one from the tableDescription
        geodatabase?.createTable(tableDescription)?.onSuccess { featureTable ->
            // get the result of the loaded "LocationHistory" table
            this.featureTable = featureTable
            // create a feature layer for the map using the GeodatabaseFeatureTable
            val featureLayer = FeatureLayer.createWithFeatureTable(featureTable)
            mapView.map?.operationalLayers?.add(featureLayer)
            // display the current count of features in the FeatureTable
            featureCountTextView.text =
                "Number of features added: ${featureTable.numberOfFeatures}"
        }?.onFailure {
            showError(it.message.toString())
        }
    }

    /**
     * Create a feature with attributes on map click and add it to the [featureTable]
     * Also, updates the TotalFeatureCount on the screen
     */
    private fun addFeature(mapPoint: Point) {
        // set up the feature attributes
        val featureAttributes = mutableMapOf<String, Any>()
        featureAttributes["collection_timestamp"] = Instant.now()

        // create a new feature at the mapPoint
        val feature = featureTable?.createFeature(featureAttributes, mapPoint)
            ?: return showError("Error creating feature using attributes")

        lifecycleScope.launch {
            // add the feature to the feature table
            featureTable?.addFeature(feature)?.onSuccess {
                // feature added successfully, update count
                featureCountTextView.text =
                    "Number of features added: ${featureTable?.numberOfFeatures}"
                // enable table button since at least 1 feature loaded on the GeodatabaseFeatureTable
                viewTableButton.isEnabled = true
            }?.onFailure {
                showError(it.message.toString())
            }
        }
    }

    /**
     * Displays a dialog with the table of features
     * added to the GeodatabaseFeatureTable [featureTable]
     */
    private suspend fun displayTable() {
        // query all the features loaded to the table
        featureTable?.queryFeatures(QueryParameters())?.onSuccess { queryResults ->
            // inflate the table layout
            val tableLayoutBinding = TableLayoutBinding.inflate(layoutInflater)
            // set up a dialog to be displayed
            Dialog(this).apply {
                setContentView(tableLayoutBinding.root)
                setCancelable(true)
                // grab the instance of the TableLayout
                val table = tableLayoutBinding.tableLayout
                // iterate through each feature to add to the TableLayout
                queryResults.forEach { feature ->
                    // prepare the table row
                    val tableRowBinding = TableRowBinding.inflate(layoutInflater).apply {
                        oid.text = feature.attributes["oid"].toString()
                        collectionTimestamp.text =
                            (feature.attributes["collection_timestamp"] as Instant).toString()
                    }
                    // add the row to the TableLayout
                    table.addView(tableRowBinding.root)
                }
            }.show()
        }?.onFailure {
            showError(it.message.toString())
        }
    }

    /**
     * Called on app launch or when Android share sheet is closed
     */
    private fun setMapView() {
        // create and add a map with a navigation night basemap style
        mapView.map = ArcGISMap(BasemapStyle.ArcGISTopographic)
        mapView.setViewpoint(Viewpoint(41.5, -100.0, 100_000_000.0))

        lifecycleScope.launch {
            mapView.map?.loadStatus?.collect { loadStatus ->
                if (loadStatus == LoadStatus.Loaded) {
                    // clear any feature layers displayed on the map
                    mapView.map?.operationalLayers?.clear()
                    // disable the button since no features are displayed
                    viewTableButton.isEnabled = false
                    // create a new geodatabase file to add features into the feature table
                    createGeodatabase()
                } else if (loadStatus is LoadStatus.FailedToLoad) {
                    showError("Error loading MapView: ${loadStatus.error.message}")
                }
            }
        }
    }

    override fun onResume() {
        super.onResume()
        // set up map view and create new geodatabase file
        // on every app launch or on share sheet close
        setMapView()
    }

    private fun showError(message: String) {
        Log.e(localClassName, message)
        Snackbar.make(mapView, message, Snackbar.LENGTH_SHORT).show()
    }
}