|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.core.tasks.ags.geoprocessing.Geoprocessor
public class Geoprocessor
This class represents a GeoProcessing task. A GeoProcessing task is a single task running against a GeoProcessing service published using the ArcGIS Server and it supports one of the following two main operations:
setProcessSR(SpatialReference)
and setOutSR(SpatialReference)
.
Constructor Summary | |
---|---|
Geoprocessor(String serviceUrl)
Initializes the Geoprocessor object using the geoprocessing service URL. |
|
Geoprocessor(String serviceUrl,
UserCredentials credentials)
Initializes the Geoprocessor object using the geoprocessing service URL and credentials. |
Method Summary | |
---|---|
GPJobResource |
checkJobStatus(String jobId)
Provides basic information about a submitted job such as the job ID, status and messages. |
GPResultResource |
execute(List<GPParameter> parameters)
The execute method is performed on a GP service when the execution type desired is synchronous (on the server side). |
SpatialReference |
getOutSR()
Returns the output spatial reference set for this geoprocessing task. |
SpatialReference |
getProcessSR()
Returns the process spatial reference set for this geoprocessing task. |
GPParameter |
getResultData(String jobId,
String parameterName)
Retrieves the result parameter information for a specific job. |
GPParameter |
getResultImage(String jobId,
String parameterName)
Retrieves the result parameter information as a map image for a specific job. |
String |
getUrl()
Gets the URL to the geoprocessing service. |
void |
setOutSR(SpatialReference outSR)
Sets the well-known ID of the spatial reference of the output geometries. |
void |
setProcessSR(SpatialReference processSR)
Sets the well-known ID of the spatial reference that the model will use to perform geometry operations. |
void |
setUrl(String url)
Sets the URL to the geoprocessing service. |
GPJobResource |
submitJob(List<GPParameter> parameters)
The submitJob method is performed on a GP service when the execution type desired is asynchronous (on the server side). |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Geoprocessor(String serviceUrl)
serviceUrl
- ArcGIS Server Rest API endpoint to the service that receives the geoprocessing request.public Geoprocessor(String serviceUrl, UserCredentials credentials)
serviceUrl
- ArcGIS Server Rest API endpoint to the service that receives the geoprocessing request.credentials
- the credentials used for accessing a secure geoprocessing service.Method Detail |
---|
public String getUrl()
public void setUrl(String url)
url
- the url of the geoprocessing service to setpublic SpatialReference getOutSR()
public SpatialReference getProcessSR()
public void setOutSR(SpatialReference outSR)
outSR
- The spatial reference of the output geometries to set.public void setProcessSR(SpatialReference processSR)
processSR
- The spatial reference that the model will use to perform geometry operations to setpublic GPResultResource execute(List<GPParameter> parameters) throws Exception
GPResultResource
containing an array of result parameters and the GP task
execution messages.
parameters
- The various input parameters accepted by the corresponding GP task
Exception
public GPJobResource submitJob(List<GPParameter> parameters) throws Exception
GPJobResource
containing information about the job submitted.
parameters
- The various input parameters accepted by the corresponding GP task.
Exception
public GPJobResource checkJobStatus(String jobId) throws Exception
jobId
- The job ID.
Exception
public GPParameter getResultData(String jobId, String parameterName) throws Exception
jobId
- The job ID of the job this result pertains toparameterName
- The name of the parameter to be retrieved
GPParameter
Exception
public GPParameter getResultImage(String jobId, String parameterName) throws Exception
jobId
- The job ID of the job this result pertains toparameterName
- The name of the parameter to be retrieved
GPParameter
(necessarily GPRasterDataLayer
or
GPFeatureRecordSetLayer
in this case)
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |