Package com.esri.arcgisruntime.tasks.geoprocessing
Geoprocessing is a fundamental part of enterprise GIS operations. Geoprocessing provides GIS users with data analysis, data management, and data conversion tools.
A typical geoprocessing operation takes an input dataset, performs an operation and returns the result of the operation as an output dataset. Common geoprocessing operations include geographic feature overlay, feature selection and analysis, topology processing, raster processing, and data conversion. Geoprocessing allows for definition, management, and analysis of information used to form decisions.
The geoprocessing package contains classes to run a geoprocessing (also known as GP) task on ArcGIS Server or Local
Server (on the desktop platforms that support it). The
GeoprocessingTask
is the main component for developers to use
geoprocessing tasks. The workflow for running a geoprocessing task is:
- Create a GeoprocessingTask
with the URL to the target
geoprocessing task end-point.
- Create a GeoprocessingParameters
with a corresponding
GeoprocessingParameters.ExecutionType
- Create a GeoprocessingParameter
and add them to
GeoprocessingParameters.getInputs()
where the key is the name of
the parameter and the value is the parameter.
- Set environment variables on GeoprocessingParameters
if needed.
- Create a GeoprocessingJob
with
GeoprocessingTask.createJob(GeoprocessingParameters)
- Start listening for message and status reports using
Job.addJobMessageAddedListener(com.esri.arcgisruntime.tasks.JobMessageAddedListener)
Job.addStatusChangedListener(java.lang.Runnable)
- Run the task using Job.start()
- When GeoprocessingJob
has finished, handle results from
GeoprocessingJob.getResult()
- Since:
- 100.0.0
-
ClassDescriptionCorresponds to GPBoolean parameter type in the service REST specification.Corresponds to GPDataFile parameter type in the service REST specification.Corresponds to GPDate parameter type in the service REST specification.Corresponds to GPDouble parameter type in the service REST specification.Corresponds to GPRecordSet and GPFeatureRecordSetLayer parameter types in the service REST specification.Geoprocessing feature set is a read-only set of features that are returned from
GeoprocessingFeatures
.Geoprocessing job is used to run the geoprocessing task on the service.Corresponds to GPLinearUnit parameter type in the service REST specification.The list of geoprocessing linear unit types.Corresponds to GPLong parameter type in the service REST specification.Corresponds to GPMultiValue parameter type in the service REST specification.Base class for all concrete parameters types that can be used in geoprocessing.Geoprocessing parameter types.Provides information on a single input or output parameter of a geoprocessing task.Defines whether a GeoprocessingParameterInfo represents an input or an output parameter.Geoprocessing parameters contains input parameters that are sent to the target geoprocessing task.The list of geoprocessing execution types.Corresponds to GPRasterData and GPRasterDataLayer parameter types in the service REST specification.Contains output parameters returned from the service.Corresponds to GPString parameter type in the service REST specification.The GeoprocessingTask class is used to run a geoprocessing task that is published as a web service.GeoprocessingTaskInfo contains information on aGeoprocessingTask
.Represents an output parameter that is a new type of geoprocessing parameter that's not currently supported.