Big Data Spatial and GraphのREST API

Hadoop APIを使用した空間索引のレコードの空間的フィルタ処理

get

/spatialviewer/api/v1/hadoop/filter

Hadoop APIを使用したレコードの空間的フィルタ処理サービス・レスポンスをMap APIのデータ・ソースとして使用し、マップ上に結果を表示できます。例:

// リモートの地理空間コンテンツをフェッチする場合のデフォルトhttpメソッド
OM.gv.setHttpMethod("GET");

tweetsLayer = new OM.layer.VectorLayer("Result",
{
def:{
type:OM.layer.VectorLayer.TYPE_DATAPACK,
url:'http://localhost:8045/spatialviewer/api/v1/hadoop/filter?indexName=TweetsJune&queryWindow={"type":"Polygon","coordinates":[[-106, 25, -106, 30, -104, 30, -104, 25, -106, 25]]}&heatMapResult=false&spatialOperation=None',
jsonp: true},
boundingTheme: true});

リクエスト

問合せパラメータ

asynchronous: boolean

trueの場合、この操作は非同期で実行されます。

デフォルト値: false
dataPath: string

分類するHDFS内のファイルのパス。useIndexがfalseの場合は、このパラメータを指定します。
例: /user/oracle/spatialviewer/tweetsJune.json
distance: number(double)

spatialOperationがWithinDistanceの場合、距離が必要です。投影されたデータの場合、距離の単位は投影の単位と同じです。測地データの場合、距離はメートル単位です。
例: 1000
fullResult: boolean

falseの場合、非同期の場合、レスポンスにはHDFS内の結果の場所が含まれ、実際の結果は含まれません。

デフォルト値: true
heatMapResult: boolean

ヒート・マップを結果として取得する場合はtrue。falseの場合、データの実際の形状が返されます。デフォルトでFalseです。

デフォルト値: false
indexName: string

索引の名前。useIndexがtrueの場合は、このパラメータを指定します。
例: TweetsJune
inputFormatClass: string

入力形式クラス。useIndexがfalseの場合に設定可能なオプションのパラメータ。入力形式クラスが指定されていない場合は、SparkContextのtextFileが使用されます。
例: oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat
jarWithNeededClasses: string

カスタムRecordInfoProviderまたはInputFormatのようなユーザー定義クラスを持つJAR名。InputFormatクラスまたはRecordInfoProviderクラスがAPI、またはHadoop APIクラスにない場合、ユーザー定義クラスのJARが提供されます。このjarを使用するには、/opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/WEB-INF/libディレクトリに追加し、サーバーを再起動する必要があります。オプションのパラメータ。
例: myjar.jar
numberOfColumns: integer(int32)

ヒート・マップ・グリッドの列数。デフォルトは600です。
numberOfRows: integer(int32)

ヒート・マップ・グリッドの行数。デフォルトは600です。
outputPath: string

ジョブの出力パス。asynchronousがtrueの場合は、このパラメータを指定します。
例: /user/oracle/spatialviewer/FilterResult
queryWindow: string

GeoJSON形式のqueryWindow。
問合せウィンドウは、矩形ツールなどのMap APIツールバーの標準ツールを使用して作成できます。
var queryWindow = toolbar.getBuiltInTool(OM.control.ToolBar.BUILTIN_RECTANGLE).getGeometry().transform(8307).toString();

Example: {"type":"Polygon","coordinates":[[-106, 25, -106, 30, -104, 30, -104, 25, -106, 25]]}
recordInfoProviderClass: string

空間情報を提供するクラス。useIndexがfalseの場合は、このパラメータを指定します。
例: oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider
spatialOperation: string

レコードを空間的にフィルタ処理する空間操作。指定できる値は、None、AnyInteract、IsInside、WithinDistanceおよびContainsです。デフォルト値はAnyInteractです。
例: AnyInteract
srid: integer(int32)

ジオメトリのSRID。useIndexがfalseの場合は、このパラメータを指定します。
例: 8307
tolerance: number(double)

空間操作を実行するときに使用される許容差を表すdouble値。useIndexがfalseの場合は、このパラメータを指定します。
例: 0.05
useIndex: boolean

索引が入力として使用される場合はtrue、それ以外の場合はfalse

デフォルト値: true

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

200レスポンス

要求が成功しました

ルート・スキーマ: RecordsInfo

型: object

ソースの表示

copyright(optional): string

例: Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
features(optional): array features
geodetic(optional): boolean

ジオメトリが測地の場合はtrue、それ以外の場合はfalse。

例: true
srs(optional): integer(int32)

ジオメトリのSRID。

例: 8307
type(optional): string

例: FeatureCollection

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"FeatureCollection"
        },
        "copyright":{
            "type":"string",
            "example":"Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved."
        },
        "srs":{
            "type":"integer",
            "description":"SRID of the geometries.",
            "format":"int32",
            "example":8307
        },
        "geodetic":{
            "type":"boolean",
            "description":"true if the geometries are geodetic, false otherwise.",
            "example":true
        },
        "features":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Feature"
            }
        }
    }
}

ネストされたスキーマ: features

型: array

ソースの表示

配列: object Feature

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Feature"
    }
}

ネストされたスキーマ: Feature

型: object

ソースの表示

_id(optional): string

地物ID。

例: 1
geometry(optional): object Geometry
type(optional): string

例: Feature

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"Feature"
        },
        "_id":{
            "type":"string",
            "description":"Feature id.",
            "example":1
        },
        "geometry":{
            "type":"string",
            "description":"Feature geometry.",
            "$ref":"#/definitions/Geometry"
        }
    }
}

ネストされたスキーマ: Geometry

型: object

ソースの表示

coordinates(optional): array coordinates
properties(optional): object properties

フィルタ処理されたレコードの追加フィールド(2.8.2.1「空間の索引付けクラスの構造」を参照)。たとえば、followers_count、friends_count、locationおよびuser_idという名前の追加フィールドを含めることができます
type(optional): string

例: Point

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"Point"
        },
        "coordinates":{
            "type":"array",
            "items":{
                "type":"number",
                "format":"double"
            },
            "example":[
                -73.86659,
                50.41706
            ]
        },
        "properties":{
            "type":"object",
            "description":"Extra fields of the filtered records (see 2.8.2.1 Spatial Indexing Class Structure). For example we can have  extra fields named followers_count, friends_count, location and user_id",
            "properties":{
                "followers_count":{
                    "type":"string",
                    "example":"70"
                },
                "friends_count":{
                    "type":"string",
                    "example":"51"
                },
                "location":{
                    "type":"string",
                    "example":"Canada"
                },
                "user_id":{
                    "type":"string",
                    "example":"5039703"
                }
            }
        }
    }
}

ネストされたスキーマ: coordinates

型: array

ソースの表示

配列: number(double)

{
    "type":"array",
    "items":{
        "type":"number",
        "format":"double"
    },
    "example":[
        -73.86659,
        50.41706
    ]
}

例:

ネストされたスキーマ: properties

型: object

フィルタ処理されたレコードの追加フィールド(2.8.2.1「空間の索引付けクラスの構造」を参照)。たとえば、followers_count、friends_count、locationおよびuser_idという名前の追加フィールドを含めることができます

ソースの表示

followers_count(optional): string

例: 70
friends_count(optional): string

例: 51
location(optional): string

例: Canada
user_id(optional): string

例: 5039703

{
    "type":"object",
    "description":"Extra fields of the filtered records (see 2.8.2.1 Spatial Indexing Class Structure). For example we can have  extra fields named followers_count, friends_count, location and user_id",
    "properties":{
        "followers_count":{
            "type":"string",
            "example":"70"
        },
        "friends_count":{
            "type":"string",
            "example":"51"
        },
        "location":{
            "type":"string",
            "example":"Canada"
        },
        "user_id":{
            "type":"string",
            "example":"5039703"
        }
    }
}

202レスポンス

非同期リクエストを受け入れました

ルート・スキーマ: AsyncHadoopFilterJobResponse

型: object

ソースの表示

o:successCode(optional): string

成功コード。

例: SV-05012
response(optional): string

レスポンスには、ジョブを追跡するためのリソース・マネージャWebアプリケーションのURLの場所が含まれています(Hadoopパラメータyarn.resourcemanager.webapp.addressの構成を参照してください)。

例: http://resource.manager.webapp:8088
status(optional): string

成功またはエラー

例: success
title(optional): string

サービスのタイトル。

例: Spatial Hadoop filter.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Spatial Hadoop filter."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05012"
        },
        "response":{
            "type":"string",
            "description":"The response contains the location of the resource manager web application URL to track the job (see in the configuration the Hadoop parameter yarn.resourcemanager.webapp.address).",
            "example":"http://resource.manager.webapp:8088"
        }
    }
}

先頭に戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、Hadoop索引を使用してフィルタ処理する方法を示しています。

curl -v -X GET "http://localhost:8045/spatialviewer/api/v1/hadoop/filter?fullResult=true&queryWindow=\{\"type\":\"Polygon\",\"coordinates\":\[\[-106,25,-106,30,-104,30,-104,25,-106,25\]\]\}&useIndex=true&indexName=tweetsJanuary" -H  "accept: application/json"

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK Date: Wed, 15 Nov 2017 17:50:38 GMT Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type, Accept Transfer-Encoding: chunked  Content-Type: application/json

レスポンス本文の例

次の例は、レスポンス本文の内容をJSON形式で示したものです(1つのレコードを含みます)。

{"type":"FeatureCollection", "copyright":"Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.", "srs":8307, "geodetic":true,"features":[{"type":"Feature","_id":"4789","geometry":{"type":"Point","coordinates":[-105.49998,28.19997]},"properties":{"friends_count":"199","location":"Chihuahua","user_id":"4092140","followers_count":"13"}}]}

先頭に戻る