Class: GeoprocessingService

GeoprocessingService

处理自动化服务接口类。通过处理自动化工具构建处理自动化模型并运行,实现空间数据处理与分析过程的自动化。
提供方法:获取处理自动化服务任务列表、某一任务的执行信息、异步执行状态信息;获取处理自动化工具的工具列表、某一工具的信息、异步执行的结果;异步、同步执行处理自动化工具;取消处理自动化任务的异步执行等。

new GeoprocessingService(url, options)

Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/openlayers/iclient-ol.js"></script>
<script>
  new ol.supermap.GeoprocessingService(url, options);
  
</script>

// ES6 Import
import { GeoprocessingService } from '@supermapgis/iclient-ol';

new GeoprocessingService(url, options);

openlayers/services/GeoprocessingService.js, line 4
Name Type Description
url string

服务地址。

options Object

参数。

Version:
  • 10.1.0
Example
//为了安全访问受保护的处理自动化服务,必须通过传递iserver令牌(token),才能正确访问相关资源。
SecurityManager.registerToken(serviceUrl, token);
var geoprocessingService = new geoprocessingService("http://localhost:8090/iserver/services/geoprocessing/restjsr/gp/v2")
   geoprocessingService.submitJob(identifier,params, environments, function(serverResult) {
     console.log(serverResult.result);
     var jobID = serverResult.result.jobID;
     var options = {
       interval: 5000,
       statusCallback: function(state) {
         console.log("Job Status: ", state);
       }
     };
     geoprocessingService.waitForJobCompletion(jobID, identifier, options, function(serverResult) {
       console.log(serverResult);
     });
   })

Extends

Methods

cancelJob(identifier, jobId, callback){Promise}

openlayers/services/GeoprocessingService.js, line 122

取消处理自动化任务的异步执行。

Name Type Description
identifier string

处理自动化工具 ID。

jobId string

处理自动化任务 ID。

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

execute(identifier, parameter, environment, callback){Promise}

openlayers/services/GeoprocessingService.js, line 69

同步执行处理自动化工具。

Name Type Description
identifier string

处理自动化工具 ID。

parameter Object

处理自动化工具的输入参数。

environment Object

处理自动化工具的环境参数。

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

getJobInfo(identifier, jobId, callback){Promise}

openlayers/services/GeoprocessingService.js, line 110

获取处理自动化任务的执行信息。

Name Type Description
identifier string

处理自动化工具 ID。

jobId string

处理自动化任务 ID。

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

getJobs(identifier, callback){Promise}

openlayers/services/GeoprocessingService.js, line 134

获取处理自动化服务任务列表。

Name Type Description
identifier string

处理自动化工具 ID。(可选,传参代表 identifier 算子的任务列表,不传参代表所有任务的列表)

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

getResults(identifier, jobId, filter, callback){Promise}

openlayers/services/GeoprocessingService.js, line 145

处理自动化工具异步执行的结果,支持结果过滤。

Name Type Description
identifier string

处理自动化工具 ID。

jobId string

处理自动化任务 ID。

filter string

输出异步结果的 ID。(可选,传入 filter 参数时对该处理自动化工具执行的结果进行过滤获取,不传参时显示所有的执行结果)

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

getTool(identifier, callback){Promise}

openlayers/services/GeoprocessingService.js, line 58

获取处理自动化工具的 ID、名称、描述、输入参数、环境参数和输出结果等相关参数。

Name Type Description
identifier string

处理自动化工具 ID。

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

getTools(callback){Promise}

openlayers/services/GeoprocessingService.js, line 48

获取处理自动化工具列表。

Name Type Description
callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

submitJob(identifier, parameter, environment, callback){Promise}

openlayers/services/GeoprocessingService.js, line 82

异步执行处理自动化工具。

Name Type Description
identifier string

处理自动化工具 ID。

parameter Object

处理自动化工具的输入参数。

environment Object

处理自动化工具的环境参数。

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。

waitForJobCompletion(jobId, identifier, options, callback){Promise}

openlayers/services/GeoprocessingService.js, line 95

获取处理自动化异步执行状态信息。

Name Type Description
jobId string

处理自动化任务 ID。

identifier string

处理自动化工具 ID。

options Object

状态信息参数。

Name Type Description
interval number

定时器时间间隔。

statusCallback function

回调函数。

callback RequestCallback 可选

回调函数,该参数未传时可通过返回的 promise 获取结果。

Returns:
Type Description
Promise Promise 对象。