Tips & Tricks

属性名や型名を自分たちの用語に合わせる

モデルは合っているのに、名前だけが現場の言い方と違う、ということはよくあります。カタログでは assignee でも、ある市では対応班を responsibleTeam と呼んでいる。以下はタスク管理の Project を Saigai、assignee を responsibleTeam という名前で使う例です。

このために新しいモデルを作る必要はありません。JSON-LD では、キーは「語（term）」にすぎず、それがどの IRI を指すかは @context が決めます。同じ IRI を指す語は何個あってもよいので、自分たちの名前を同じ IRI に割り当てた context を用意すれば、モデルはそのままで名前だけ変わります。これをエイリアスと呼びます。

json

{
  "@context": [
    "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.8.jsonld",
    {
      "tm": "https://datamodels.jp/ns/task/",
      "Saigai": "tm:Project",
      "responsibleTeam": "tm:assignee"
    }
  ]
}

responsibleTeam で書いたエンティティは、assignee で書いたものと同じ IRI に展開されます。ブローカーの中では同じ属性で、検索・購読・他のクライアントから見た違いはありません。読み出すときは NGSI-LD がリクエストの context で短縮するので、この context を渡したクライアントには responsibleTeam と Saigai で返ってきます。

守ること

短縮名は英数字と _ だけ。 GeonicDB などのブローカーは属性名を [A-Za-z0-9_]（または完全な IRI）に限定しています。日本語のキーは context を見る前に拒否されます。他のクライアントやツールも英数字を前提にしていることが多いので、エイリアスも英数字で付けてください。
ひとつの context の中で、ひとつの IRI にひとつの名前。 カタログの context を取り込んだ上で別名を足すと、同じ IRI に 2 つの語ができ、読み出し時にどちらで返るかは JSON-LD の規則（短いほうが優先）で決まります。確実に自分の名前で受け取りたいなら、エイリアス用の context は「使う語をすべて列挙した完全な一覧」として書き、カタログの context は取り込まないでください。カタログの context をコピーして名前を書き換えるのが早道です。
型のエイリアスは、別の型ではありません。 Saigai と Project は同じ IRI なので、ブローカーでは同じ型として保存・照合され、認可ポリシーも同じ型として扱います。型を分けたい（認可を型で分ける、属性を足す）場合は別の IRI が必要です。それはエイリアスではなくサブクラスで、独自の型 IRI を持ちつつ同名の属性は親の IRI を使います（スキーマの x-subclass-of。拡張する）。

アダプターと組み合わせる（GeonicDB）

Custom Data Model の propertyDetails のキーは短縮名です。エイリアスを使うなら、定義もエイリアスの名前で登録し、contextUrl にはエイリアス用の context を指定します。書き出しスクリプトが名前の置き換えをまとめて行います。

bash

node adapters/geonicdb/export.mjs task --type Project --type-name Saigai \
  --context-url https://example.com/context/city-disaster.jsonld --out ./out
node adapters/geonicdb/export.mjs task --type Task --rename assignee=responsibleTeam \
  --context-url https://example.com/context/city-disaster.jsonld --out ./out

各属性の @context にはカタログの IRI が残るので、名前が変わっても語彙は同じです。

Tips & Tricks ​

属性名や型名を自分たちの用語に合わせる ​

守ること ​

アダプターと組み合わせる（GeonicDB） ​

関連 ​

Tips & Tricks

属性名や型名を自分たちの用語に合わせる

守ること

アダプターと組み合わせる（GeonicDB）

関連