summaryRegion

URI

<spatialanalystJobs_uri>/summaryregion[.<format>]

支持的方法

GET、POST、HEAD

父资源

spatialanalystJobs

子资源

summaryRegionJob

介绍

区域汇总作业资源根目录。通过对 summaryRegion 执行GET 请求，可获取当前系统的区域汇总作业列表。通过 POST 请求可创建一个分析任务。

支持的方法：

支持的表述格式：RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiserver 是服务器名。

http://supermapiserver:8090/iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/summaryregion.rjson

GET 请求

获取对区域汇总的作业列表。

响应结构

对 summaryRegion 资源执行 GET 请求，在响应消息的实体主体里是一个区域汇总资源描述集，其中单个资源描述的结构如下：   

字段 类型 说明
id String 应用ID。
state SparkJobState 该任务的状态。包括执行状态、起止时间、耗时等。
setting SparkJobSetting 列举了任务配置的详细信息。

响应示例

对示例 summaryRegion 资源：http://supermapiserver:8090iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/summaryregion.rjson 执行 GET 请求，返回 rjson 格式的资源描述如下：

[{

  "id": "48508e0b_d4b5_4278_bbde_9e092fe85618",

  "setting": {

    "DEFAULT_MASTER_ADRESS": "local[*] ",

    "analyst": {

      "query": "-74.050,40.650,-73.850,40.850",

      "fieldResultName": "Sum_LocationIDStandard",

      "standardFields": "LocationID",

      "resolution": "10",

      "meshSizeUnit": "Meter",

      "meshType": "0",

      "standardSummaryFields": "true",

      "standardStatisticModes": "Sum",

      "sumShape": "true",

      "weightedSummaryFields": "false"

    },

    "appName": "summaryWithinMesh",

    "args": [

      "--input",

      "{\"sliceNum\":20,\"type\":\"udb\",\"info\":[{\"server\":\"E:\\\\data\\\\test\\\\processing.udb\",\"datasetNames\":[\"singleRegion_R\"]}]}",

      "--meshType",

      "square",

      "--resolution",

      "10",

      "--sumShape",

      "true",

      "--query",

      "-74.050,40.650,-73.850,40.850",

      "--meshSizeUnit",

      "Meter",

      "--standardSummaryFields",

      "[LocationID,Sum,Sum_LocationIDStandard]",

      "--output",

      "{\"server\":\"F:\\\\iserver-code\\\\iserver\\\\etc\\\\iserver-debug\\\\src\\\\test\\\\resources\\\\iserver\\\\processingResultData\\\\Analyst\\\\udbs\\\\14ec67de-c7a5-42e0-9fae-0b9f65b7bf38\",\"datasetName\":\"analystResult\",\"type\":\"udb\"}"

    ],

    "contextSetting": null,

    "input": {

      "datasetInfo": {

        "available": true,

        "bounds": "Left=-74.0012189965531,Bottom=40.691422739248694,Right=-73.84588071508979,Top=40.84578668020041",

        "datasetName": "singleRegion_R",

        "datasetType": "REGION",

        "epsgCode": 4326,

        "name": "test_processing_singleRegion_R",

        "readOnly": false,

        "type": "UDB",

        "url": "E:\\data\\test\\processing.udb"

      },

      "datasetName": "test_processing_singleRegion_R",

      "numSlices": 0

    },

    "mainClass": "com.supermap.bsp.main.SummaryWithinMeshMain",

    "output": {

      "datasetName": "analystResult",

      "outputPath": "F:\\iserver-code\\iserver\\etc\\iserver-debug\\src\\test\\resources\\iserver\\processingResultData\\Analyst\\udbs\\14ec67de-c7a5-42e0-9fae-0b9f65b7bf38"

    },

    "serviceInfo": {

      "targetDataPath": "F:\\iserver-code\\iserver\\etc\\iserver-debug\\src\\test\\resources\\iserver\\processingResultData\\Analyst\\48508e0b_d4b5_4278_bbde_9e092fe85618",

      "targetServiceInfos": [

        {

          "serviceAddress": "http://supermapiserver:8090/iserver/services/data-summaryRegion73/rest",

          "serviceType": "RESTDATA"

        },

        {

          "serviceAddress": "http://supermapiserver:8090/iserver/services/map-summaryRegion64/rest",

          "serviceType": "RESTMAP"

        }

      ]

    },

    "serviceRoot": "http://supermapiserver:8090/iserver/services/",

    "type": "SUMMARYMESH"

  },

  "state": {

    "elapsedTime": 48120,

    "endState": true,

    "endTime": 1499671184678,

    "errorMsg": null,

    "errorStackTrace": null,

    "publisherelapsedTime": 4970,

    "runState": "FINISHED",

    "startTime": 1499671126724

  }

}]

POST 请求

创建一个区域汇总作业任务。

请求参数

对 summaryRegion 资源执行 POST 请求，创建一个 区域汇总分析任务，请求体需包含参数如下：

名称 类型 含义

input

【必填参数】

 DatasetInputDataSetting
  • 数据集输入设置，当输入数据是一个数据目录服务中已存在的数据集时，用该设置。其中包含如下字段
    • datasetName：数据集名称。其中数据集的来源包括通过数据目录服务导入的数据、注册到 iServer 的数据对应的数据集以及 DataStore 中存储的数据集。
  • 数据集信息输入设置，当输入数据集文件路径及信息时，用该设置。其中包含如下字段
    • datasetInfo：数据集信息。其中数据集的来源包括：CSV文件、udb文件、空间数据库。详细参数说明请参考：大数据分析输入参数设定。

analyst

 SummaryWithinRegionAnalystSetting
SummaryWithinMeshAnalystSetting		 【以下不做特殊说明的均为必填参数】
分析配置。传入时，需指定：
    • 公共字段
      • sumShape：是否统计被汇总对象的面积或者长度。非必选。如不指定，默认为true
      • query：分析范围。非必填。当不设置时，默认为输入数据集的全幅范围
      • standardSummaryFields：是否以标准属性字段统计。非必选
      • standardFields：标准属性字段名称 。仅支持系统字段以外的整形、长整形、浮点型的字段的名称。standardSummaryFields 为 true 时必填
      • standardStatisticModes：标准属性字段的统计模式。standardSummaryFields为true时必填
      • weightedSummaryFields：是否以权重字段统计。非必选
      • weightedFields：权重字段名称。仅支持系统字段以外的整形、长整形、浮点型的字段的名称。weightedSummaryFields 为true时必填
      • weightedStatisticModes：权重统计字段的统计模式。weightedSummaryFields 为true时必填
      • mappingParameters：分析后结果可视化的参数类。详见MappingParameters说明。  
          • numericPrecision：精度，此字段用于设置分析结果标签专题图中标签数值的精度，如“1”表示精确到小数点的后一位。（默认值：1）
          • rangeMode：专题图分段模式。包括：EQUALINTERVAL、LOGARITHM、QUANTILE、SQUAREROOT、STDDEVIATION。
          • rangeCount：专题图分段个数。
          • colorGradientType：专题图颜色渐变模式。包括：GREENORANGEVIOLET、GREENORANGERED、RAINBOW、SPECTRUM、TERRAIN 等。
          • items：专题图子项设置。（可自定义专题图分段个数、颜色渐变模式）
    • 格网区域汇总
      • meshType：网格面汇总类型。0表示四边形汇总，1表示六边形汇总
      • resolution：格网大小。非必填
      • meshSizeUnit：格网大小单位。非必填
    • 多边形区域汇总
      • query：分析范围。非必填
      • regionDataset：汇总数据集
          • 已向iServer注册：regionDataset：只需指定查询对象所在的数据集名称。
          • 未向iServer注册：regionDatasource：需指定查询对象数据源路径及数据集名称。设定参数包括：数据库类型 type、服务器名称 server、数据集名称 datasetNames、数据库名称 database、用户名 user、密码 password 等。 当设置参数 type 时，如果您使用的数据集存储于 PostgreSQL 数据库，则需要配置为 pg；PostGIS 数据库配置为 pggis
type SummaryAnalystType 【必填参数】汇总类型，包含：
    • SUMMARYMESH：格网区域汇总
    • SUMMARYREGION：多边形区域汇总

output

【选填参数】

 FileSystemOutputSetting
  • 分析结果输出设置。当输出结果到文件时。用该设置。其中包含如下字段
    • type：指定输出类型。
    • datasourcePath ：结果数据源的存放路径。其中分析结果可以存放到udb或hdfs中。
    • outputPath：分析结果工作空间输出路径。
DatabaseOutputSetting
  • 分析结果输出设置。当输出结果到数据库（PostgreSQL、PostGIS、MongoDB）时。用该设置。其中包含如下字段
    • type：指定输出类型。
    • datasetName：分析结果数据集名称。
    • datasourceInfo：结果数据源的连接信息。详细参数设定请参考：大数据分析输出参数设定

示例1：输入数据集名称

对示例 summaryRegion 资源：http://supermapiserver:8090iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/summaryregion.rjson 执行 POST 请求，输入一个已注册到iServer 的数据集，传入数据集名称即可。创建一个区域汇总任务。请求体中的参数如下：

{

    "input": {

        "datasetName": "smtiles_processing_newyorkZone_R"

    },

    "analyst": {

        "sumShape": true,

        "query": "-74.050,40.650,-73.850,40.850",

        "mappingParameters": {

            "numericPrecision": 2

        },

        "standardSummaryFields": true,

        "standardFields": "LocationID",

        "standardStatisticModes": "sum",

        "weightedSummaryFields": false,

        "meshType": "0",

        "resolution": "1000",

        "meshSizeUnit": "Meter"

    },

    "type": "SUMMARYMESH"

}

返回 rjson 格式的操作结果表述如下：

{

  "newResourceID": "73b47027_b492_465d_b452_e88e40b1f503",

  "newResourceLocation":"http://supermapiserver:8090/iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/summaryregion/73b47027_b492_465d_b452_e88e40b1f503",

  "postResultType": "CreateChild",

  "succeed": true

}

示例2：输入PostgreSQL中存储的数据集

对示例 summaryRegion 资源：http://supermapiserver:8090iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/summaryregion.rjson 执行 POST 请求，输入数据为存储于PostgreSQL 数据库的数据。创建一个区域汇总任务。请求体中的参数如下：

 {

    "input": {

        "datasetInfo": {

            "type": "REGION",

            "name": "newyorkZone_R_1359289148",

            "datasourceConnectionInfo": {

                "engineType": "POSTGRESQL",

                "dataBase": "supermap4",

                "password": "supermap",

                "user": "postgres",

                "server": "192.168.120.49"

            }

        }

    },

    "analyst":{

           "regionDatasource":"{\"type\":\"pg\",\"info\":[{\"server\":\"192.168.120.49\",\"datasetNames\":[\"singleRegion_R_1359289148\"],\"database\":\"supermap4\",\"user\":\"postgres\",\"password\":\"supermap\"}]}",

           "sumShape":"true",

           "standardSummaryFields":"true",

           "weightedSummaryFields":"false",

           "standardFields":"LocationID",

           "standardStatisticModes":"sum",

           "query":"-74.050,40.650,-73.850,40.850"

         },

     "type":"SUMMARYREGION"

}

返回 rjson 格式的操作结果表述如下：

{

  "newResourceID": "ca6464b6_63b3_419f_b3f7_4707827455e3",

  "newResourceLocation": "http://supermapiserver:8090/iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/vectorclip/ca6464b6_63b3_419f_b3f7_4707827455e3",

  "postResultType": "CreateChild",

  "succeed": true

}

示例3：输入数据集名称，参数中增加色带枚举值

对示例 summaryRegion 资源：http://supermapiserver:8090iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/summaryregion.rjson 执行 POST 请求，以输入形式为数据集名称，该数据集已注册到iServer，参数中增加色带枚举值。默认输出。创建一个区域汇总任务。请求体中的参数如下：

{

    "input": {

        "datasetName": "samples_processing_newyorkZone_R"

    },

    "analyst": {

        "sumShape": true,

        "query": "",

        "mappingParameters": {

            "numericPrecision": 4,

            "rangeMode": "STDDEVIATION",

            "rangeCount": "7",

            "colorGradientType": "SPECTRUM"

        },

        "standardSummaryFields": true,

        "standardFields": "Shape_Leng",

        "standardStatisticModes": "min",

        "weightedSummaryFields": false,

        "meshType": "1",

        "resolution": "1000",

        "meshSizeUnit": "Meter"

    },

    "type": "SUMMARYMESH"

}

返回 rjson 格式的操作结果表述如下：

{

    "postResultType": "CreateChild",

    "newResourceID": "3d6728c3_7e78_48f8_8d7f_18fbab683b68",

    "succeed": true,

    "newResourceLocation": "http://supermapiserver:8090/iserver/services/distributedanalyst/rest/v1/jobs/spatialanalyst/summaryregion/3d6728c3_7e78_48f8_8d7f_18fbab683b68"

}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 summaryRegion 资源是否存在，或者客户端是否有权限访问 summaryRegion 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 summaryRegion 资源是否支持<format>格式的表述。

请参见