Find features in a feature table which match an SQL query.
Use case
Query expressions can be used in ArcGIS to select a subset of features from a feature table. This is most useful in large or complicated data sets. A possible use case might be on a feature table marking the location of street furniture through a city. A user may wish to query by a TYPE column to return "benches". In this sample, we query a U.S. state by STATE_NAME from a feature table containing all U.S. states.
How to use the sample
Input the name of a U.S. state into the text field. When you tap "GO", a query is performed and the matching features are highlighted or an error is returned.
How it works
- Create a
ServiceFeatureTable
using the URL of a feature service. - Create a
QueryParameters
with a where clause specified usingwhereClause()
. - Perform the query using
queryFeaturesAsync(query)
on the service feature table. - When complete, the query will return a
FeatureQueryResult
which can be iterated over to get the matching features.
About the data
This sample uses U.S. State polygon features from the USA 2016 Daytime Population feature service.
Relevant API
- FeatureLayer
- FeatureQueryResult
- QueryParameters
- ServiceFeatureTable
Tags
Search and Query
Sample Code
/*
* Copyright 2020 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.arcgisruntime.sample.featurelayerquery
import android.app.SearchManager
import android.content.Context
import android.content.Intent
import android.graphics.Color
import android.os.Bundle
import android.util.Log
import android.view.Menu
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import androidx.appcompat.widget.SearchView
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.concurrent.ListenableFuture
import com.esri.arcgisruntime.data.FeatureQueryResult
import com.esri.arcgisruntime.data.QueryParameters
import com.esri.arcgisruntime.data.ServiceFeatureTable
import com.esri.arcgisruntime.geometry.Point
import com.esri.arcgisruntime.geometry.SpatialReferences
import com.esri.arcgisruntime.layers.FeatureLayer
import com.esri.arcgisruntime.mapping.ArcGISMap
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.Viewpoint
import com.esri.arcgisruntime.mapping.view.MapView
import com.esri.arcgisruntime.symbology.SimpleFillSymbol
import com.esri.arcgisruntime.symbology.SimpleLineSymbol
import com.esri.arcgisruntime.symbology.SimpleRenderer
import com.esri.arcgisruntime.sample.featurelayerquery.databinding.ActivityMainBinding
import java.util.Locale
class MainActivity : AppCompatActivity() {
private val activityMainBinding by lazy {
ActivityMainBinding.inflate(layoutInflater)
}
private val mapView: MapView by lazy {
activityMainBinding.mapView
}
// create a service feature table and a feature layer from it
private val serviceFeatureTable: ServiceFeatureTable by lazy {
ServiceFeatureTable(getString(R.string.us_daytime_population_url))
}
// create the feature layer using the service feature table
private val featureLayer: FeatureLayer by lazy {
FeatureLayer(serviceFeatureTable)
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(activityMainBinding.root)
// authentication with an API key or named user is required to access basemaps and other
// location services
ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)
// use symbols to show U.S. states with a black outline and yellow fill
val lineSymbol = SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.BLACK, 1.0f)
val fillSymbol = SimpleFillSymbol(SimpleFillSymbol.Style.SOLID, Color.YELLOW, lineSymbol)
featureLayer.apply {
// set renderer for the feature layer
renderer = SimpleRenderer(fillSymbol)
opacity = 0.8f
maxScale = 10000.0
}
// create a map with the topographic basemap and add it to the basemap
mapView.map = ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC).apply {
// add the feature layer to the map's operational layers
operationalLayers.add(featureLayer)
}
// set an initial viewpoint over the USA
mapView.setViewpoint(
Viewpoint(
Point(
-11000000.0,
5000000.0,
SpatialReferences.getWebMercator()
), 100000000.0
)
)
}
/**
* Handle the search intent from the search widget.
*/
override fun onNewIntent(intent: Intent) {
super.onNewIntent(intent)
this.intent = intent
if (Intent.ACTION_SEARCH == intent.action) {
intent.getStringExtra(SearchManager.QUERY)?.let {
if (it.isNotEmpty()) {
searchForState(it)
}
}
}
}
/**
* Search for a U.S. state like @param searchString in the feature table, and if found add it
* to the featureLayer, zoom to it, and select it.
*/
private fun searchForState(searchString: String) {
// clear any previous selections
featureLayer.clearSelection()
// create a query for the state that was entered
val query = QueryParameters()
// make search case insensitive
query.whereClause =
("upper(STATE_NAME) LIKE '%" + searchString.uppercase(Locale.US) + "%'")
// call select features
val future: ListenableFuture<FeatureQueryResult> =
serviceFeatureTable.queryFeaturesAsync(query)
// add done loading listener to fire when the selection returns
future.addDoneListener {
try {
// call get on the future to get the result
val result = future.get()
// check there are some results
val resultIterator = result.iterator()
if (resultIterator.hasNext()) {
resultIterator.next().run {
// get the extent of the first feature in the result to zoom to
val envelope = geometry.extent
mapView.setViewpointGeometryAsync(envelope, 10.0)
// select the feature
featureLayer.selectFeature(this)
}
} else {
"No states found with name: $searchString".also {
Toast.makeText(this, it, Toast.LENGTH_LONG).show()
Log.d(TAG, it)
}
}
} catch (e: Exception) {
"Feature search failed for: $searchString. Error: ${e.message}".also {
Toast.makeText(this, it, Toast.LENGTH_LONG).show()
Log.e(TAG, it)
}
}
}
}
override fun onCreateOptionsMenu(menu: Menu): Boolean {
// inflate the menu; this adds items to the action bar if it is present
menuInflater.inflate(R.menu.menu_main, menu)
// get the SearchView and set the searchable configuration
val searchManager = getSystemService(Context.SEARCH_SERVICE) as SearchManager
(menu.findItem(R.id.action_search).actionView as? SearchView)?.let {
// assumes current activity is the searchable activity, as specified in manifest
it.setSearchableInfo(searchManager.getSearchableInfo(componentName))
it.setIconifiedByDefault(false)
}
return true
}
override fun onPause() {
mapView.pause()
super.onPause()
}
override fun onResume() {
super.onResume()
mapView.resume()
}
override fun onDestroy() {
mapView.dispose()
super.onDestroy()
}
companion object {
private val TAG: String = MainActivity::class.java.simpleName
}
}