第27回　続・使ってみよう！地図データ用クラウドデータベース

はじめに

前回は、地図データ用クラウドデータベースが利用できるBing Spatial Data Servicesを活用したアプリを作成しました。今回は、少し補足的な内容になってしまいますが、これまでに紹介しきれていないData Source情報の取得やData Sourceの削除についてと、データ検索時のオプションについて紹介します。

Bing Maps AJAX Controlアップデート

今回の内容とは直接関係がありませんが、前回使用した地図コントロールのBing Maps AJAX Controlがアップデートしています。ここで簡単に紹介しておきます。バージョンは変わらず7.0となっています。

日本の地図では未対応のため、あまり使いどころがありませんが、次の機能を利用できるようになっています。

ルート検索および表示
交通情報の表示（図1）
ショッピングモールなどの地図表示と情報の取得（図2）

以上の機能は、モジュールを追加する形で利用できます（スクリプトを遅延読み込みする⁠）⁠。このスクリプトを必要な時点でロードする機能自体も、Ver. 7.0の初期リリース後に追加されたものです。

また、次の機能も追加されています。

PolylineとPolygonで点線の描画
カスタムタイル画像の使用時に、ズームアニメーションに合わせてカスタムタイルの拡大・縮小表示
パンくずリスト（階層リンク）の表示（図3）
Bird’s eye表示の無効化、パン（移動）の禁止、ズームの禁止

パンくずリストの表示は、次のようにMapオブジェクトのオプションを付けるだけですので、すぐに対応できますね。

map = new Microsoft.Maps.Map(document.getElementById("map"),
     {credentials: key, showBreadcrumb: true});

前回のアプリのコードに、showBreadcrumbオプションを追加しています。

アップデート内容およびAPIに関しての詳細は、MSDN Libraryを参照してください。

Data Source情報の取得

さて、今回の内容に進みましょう。Data Sourceを作成後に、その情報を取得できます。一部の内容は第25回にもAccess IDを取得する方法として紹介しています。

取得できる情報は、Data Sourceの名前やEntity Typeの名前（データのコレクション名⁠）⁠、Data Sourceのメタデータです。ここでのメタデータとは、Data Sourceの作成時に定義したプロパティ名やその型についてです。

4種類のURLの書式で情報を取得します。いずれもHTTP GETメソッドでアクセスします。それでは、それぞれの内容をみてみましょう。

Data Source一覧の取得

Bing Maps Keyに関連付いているData Sourceの一覧を取得するには、次のURLにアクセスします。

http://spatial.virtualearth.net/REST/v1/data?
$format=json&
key=BingMapsKey

パラメーターは次の通りです。

名前	説明
$format	取得する形式 atom（規定の値）またはjson
key	マスターキーまたはクエリーとして指定したBing Maps Key

得られる情報は、Data Source名やEntity Type名、更新日時です。現在のAPIのバージョンでは、Data Sourceの更新はできないため（データの入れ替えのみ⁠）⁠、作成日時と同じです。また、Atom（XML）形式の場合、Query APIなどで必要なAccess IDの情報も含まれています。

AtomおよびJSON形式の結果は次のようになります。Data Sourceがふたつ含まれている例を示します。

Atom形式

<?xml version='1.0' encoding='utf-8'?>
<app:service xmlns:app="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:bsi="http://schemas.microsoft.com/bing/spatial/2010/11/odata">
    <bsi:copyright>
        © 2011 Microsoft and its suppliers.（省略）
    </bsi:copyright>
    <app:workspace bsi:updated="2011-06-19T08:59:09Z">
        <atom:title>
            GihyoSample
        </atom:title>
        <app:collection app:href="https://spatial.virtualearth.net/REST/v1/data/XXX/GihyoSample/FuelStores">
            <atom:title>
                FuelStores
            </atom:title>
        </app:collection>
    </app:workspace>
    <app:workspace bsi:updated="2011-05-17T13:37:22Z">
        <atom:title>
            Photo
        </atom:title>
        <app:collection app:href="https://spatial.virtualearth.net/REST/v1/data/YYY/Photo/TripPhotos">
            <atom:title>
                TripPhotos
            </atom:title>
        </app:collection>
    </app:workspace>
</app:service>

JSON形式

{
    "d": {
        "Copyright": "© 2011 Microsoft and its suppliers. （省略）", 
        "DataSources": [
            {
                "EntitySets": [
                    "FuelStores"
                ], 
                "Name": "GihyoSample", 
                "Updated": "Sun, 19 Jun 2011 08:59:09 GMT"
            }, 
            {
                "EntitySets": [
                    "TripsPhotos"
                ], 
                "Name": "Photo", 
                "Updated": "Tue, 17 May 2011 13:37:22 GMT"
            }
        ]
    }
}

ひとつのData Source情報の取得

ひとつのData Source情報の取得もできます。その場合、次のURLにアクセスします。Data Sourceを指定するため、URLにAccess IDとData Source名のパスが含まれています。

http://spatial.virtualearth.net/REST/v1/data/accessID/dataSourceName?
$format=json&
key=BingMapsKey

すべてのData Sourceのメタデータの取得

続いてメタデータの取得です。Bing Maps Keyに関連付いているData Sourceすべてのメタデータを取得するには、次のURLにアクセスします。

http://spatial.virtualearth.net/REST/v1/data/$metadata?
key=BingMapsKey

このURLは、ODataプロトコルで定義されたService Metadata Documentの内容を返します。

レスポンス内容は次のようになります。少し長いですが内容をみると、Data Source作成時に指定したプロパティ名やその型、IDとなるプロパティなどがわかります。メタデータは、JSON形式での取得はできません。

<?xml version='1.0' encoding='utf-8'?>
<edmx:edmx xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" version="1.0">
    <edmx:dataservices dataserviceversion="1.0">
        <schema namespace="GihyoSampleDataSource" xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
            <entitytype name="FuelStores">
                <key>
                    <propertyref name="ID">
                    </propertyref>
                </key>
                <property name="ID" type="Edm.String" nullable="false" maxlength="256" unicode="true" fixedlength="false">
                </property>
                <property name="Latitude" type="Edm.Double" nullable="false">
                </property>
                <property name="Longitude" type="Edm.Double" nullable="false">
                </property>
                <property name="Address" type="Edm.String" nullable="true" maxlength="256" unicode="true" fixedlength="false">
                </property>
                <property name="Code" type="Edm.Int64" nullable="true">
                </property>
            </entitytype>
        </schema>
        <schema namespace="GihyoSample" xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
            <entitycontainer name="GihyoSampleContext" m:isdefaultentitycontainer="true">
                <entityset name="FuelStores" entitytype="GihyoSampleDataSource.FuelStores">
                </entityset>
            </entitycontainer>
        </schema>
        <schema namespace="PhotoDataSource" xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
            <entitytype name="TripPhotos">
                <key>
                    <propertyref name="ID">
                    </propertyref>
                </key>
                <property name="ID" type="Edm.String" nullable="false" maxlength="256" unicode="true" fixedlength="false">
                </property>
                <property name="Latitude" type="Edm.Double" nullable="false">
                </property>
                <property name="Longitude" type="Edm.Double" nullable="false">
                </property>
                <property name="Date" type="Edm.DateTime" nullable="true">
                </property>
                <property name="Title" type="Edm.String" nullable="true" maxlength="256" unicode="true" fixedlength="false">
                </property>
                <property name="Description" type="Edm.String" nullable="true" maxlength="256" unicode="true" fixedlength="false">
                </property>
            </entitytype>
        </schema>
        <schema namespace="Photo" xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
            <entitycontainer name="PhotoContext" m:isdefaultentitycontainer="true">
                <entityset name="TripPhotos" entitytype="PhotoDataSource.TripPhotos">
                </entityset>
            </entitycontainer>
        </schema>
    </edmx:dataservices>
</edmx:edmx>

ひとつのData Sourceのメタデータの取得

メタデータもData Sourceを指定して取得できます。その場合、次のURLにアクセスします。

http://spatial.virtualearth.net/REST/v1/data/accessID/dataSourceName/$metadata?
key=BingMapsKey

以上が、Data Source情報の取得です。

これらの機能は、アプリから利用することはあまりないと思いますが、管理用ページ作成などに使えそうですね。また、作成したData Sourceの内容を忘れてしまった場合も、以上のように情報を取得できます。

Data Sourceの削除

Data Sourceの削除についてもみてみましょう。Data Sourceの削除は、次の特定のData Sourceを表すURLへ、HTTP DELETEメソッドでアクセスします。

http://spatial.virtualearth.net/REST/v1/data/accessId/dataSourceName?
key=masterKey

keyパラメーターには、Data Source作成時にマスターキーとして指定したBing Maps Keyを指定します。

レスポンスは、削除に成功した場合、HTTPステータスコード202（Accepted）が返ります。

クエリーオプション

次はQuery APIです。これまでの内容も含めて、Bing Spatial Data Servicesで使用できるデータ検索時のオプションについて紹介します。

データの検索方法は大きく分けて次の3種類があります。

地理情報による検索
プロパティによる検索
IDによる検索

地理情報による検索は、ある地点から一定距離内にあるデータ、または、ある領域内にあるデータの検索です。第25回で紹介しています。プロパティとIDによる検索は第26回で紹介しています。

いずれの検索方法も絞り込みの条件が必須で、地理情報による検索はspatialFilterパラメーターを使用し、プロパティによる検索は$filterパラメーターを使用します。IDによる検索は少し特殊で、複数のIDを指定する場合は$filterパラメーターを使用し、ひとつのIDを指定する場合はURLのパスにIDを記述し、その他のフィルタリングオプションは指定できません。ここで扱うのは、ひとつのIDを指定した検索以外の内容です。

それぞれの検索方法のURLの書式を示します。必須のフィルタリングパラメーターのみ示しています。

地理情報による検索

http://spatial.virtualearth.net/REST/v1/data/accessId/dataSourceName/entityTypeName?
spatialFilter=nearby(latitude,,longitude,,distance)
または
spatialFilter=bbox(southLatitude,,westLongitude,northLatitude,eastLongitude)

プロパティによる検索

http://spatial.virtualearth.net/REST/v1/data/accessId/dataSourceName/entityTypeName?
$filter=filterString

複数のIDを指定した検索

http://spatial.virtualearth.net/REST/v1/data/accessId/dataSourceName/entityTypeName?
$filter=entityId in (entityId1,entityId2,entityIdN)

フィルタリングオプション

これらの検索時に追加できるパラメーターは次のものがあります。

$filter

プロパティの値によるフィルタリングを指定します。詳しくは第26回を参照してください。

例：$filter=Address eq 'Saitama'

$format

レスポンスの形式を、atom（規定）またはjsonで指定します。

例：$format=json

$inlinecount

レスポンスに検索結果の総数を含めるかを、allpagesまたはnone（規定）で指定します。allpagesの場合、総数が含まれます。

例：$inlinecount=allpages

$orderby

結果の並び順をプロパティで指定します。最大で3個までプロパティを指定でき、昇順・降順をasc・descで指定できます。経緯度（Latitude、Longitude）は並び順に使用できません。

例1：$orderby=Rating
例2：$orderby=Rating asc
例3：$orderby=Rating,Category desc

$select

レスポンスに含めるプロパティを指定します。$selectパラメーターが指定されていない場合（または$select=*と指定した場合⁠）⁠、すべてのプロパティが含まれます。

ある地点から一定距離内にあるデータを検索した場合（spatialFilter=nearby(latitude,longitude,distance)形式⁠）⁠、__Distanceを指定するとその地点からの距離を特別なプロパティとして取得できます。型は、Double型です。

例1：$select=Name,Category
例2：$select=Address,Name,Category,__Distance

$skip

検索結果の何番目のデータからレスポンスに含めるかを指定します。0が1番目のデータを表します。

$top

取得する結果の件数を指定します。既定は25、最大で250です。

例1：$skip=0&$top=10 （⁠最初の10件）
例2：$skip=10&$top=10 （⁠11件目から20件目まで）

クエリーオプションは以上です。これらは、ODataプロトコルの仕様に基づいた内容です。指定できる数などの制限は、Bing Spatial Data Servicesの仕様です。

ガソリンスタンドアプリの変更

今回登場したクエリーオプションを少し使ってみましょう。使用するのは$selectパラメーターです。

前回のガソリンスタンドアプリを少し変更して、ガソリンスタンドが地図の中心（現残地）からどの程度離れているか表示してみましょう。

loadData関数を編集して、地図の中心地から一定距離にあるガソリンスタンドを検索するよう変更します（ここでは単に5km以内とします⁠）⁠。また、リクエスト時に、$selectパラメーターと__Distanceプロパティを追加して、中心からの距離を得ます。変更したloadData関数は次のようになります。

function newloadData() {
    pins.clear();

    var center = map.getCenter();
    var nearby = "nearby(" + center.latitude + "," + center.longitude + ",5.0)";
    
    $.ajax({
        type: "GET",
        url: "http://spatial.virtualearth.net/REST/v1/data/accessId/dataSourceName/FuelStores",
        dataType: "jsonp",
        data: {
            spatialFilter: nearby,
            key: key,
            $top: 250,
            $select: "ID,Latitude,Longitude,Address,Code,__Distance",
            $format: "json"
        },
        jsonp: "jsonp",
        success: function (data, dataType) {
            addPins(data);
        }
    });
}

Infoboxに距離を表示するように変更します。レスポンスには __Distanceが含まれていますので、その値をaddPins関数内で記憶しておきます。

// pin オブジェクトに独自のプロパティを設定し燃料料給油所の情報を保持
pin.id = store.ID;
pin.address = store.Address;
pin.code = store.Code;
pin.distance = store.__Distance; // 追加した行

そして、Infobox表示時、showInfobox関数内で__Distanceの値を使用します。

var infobox = new Microsoft.Maps.Infobox(pin.getLocation(), {
    title: (pin.code == 1) ? "ガソリンスタンド" : (pin.code == 2) ? "LPガススタンド" : "SS以外の燃料販売店",
    // ↓変更した行
    description: pin.address + " (" + pin.distance + " km)",
    offset: new Microsoft.Maps.Point(0, 20), 
    height: 100,
    visible: true});

修正箇所は以上です。実行した結果は図4のようになります。

今回は以上です。いかがでしたでしょうか。これまでに紹介できていなかった、Data Source Management APIとQuery APIの内容についてお届けしました。ぜひ自作アプリに活用してみてください。