プレリリース版です。正式公開までは、公開済みのファイルも含めて内容が変わることがあります。
Skip to content

出典: https://datamodels.jp/guide/ · 文章は CC BY 4.0

ガイド ​

このサイトで使う言葉の意味は、用語にまとめています。

どのページを読むか ​

まず、カタログのモデルが自分のデータに合うかを見ます。そのまま合わないときも、少し合わせれば使えることがあります。

モデルがそのまま合う?はいモデルを使う使い方いいえ名前だけが違う?はい独自の名前で使う別名いいえ属性が少し足りない?はい属性を足す拡張いいえどれも合わない自分のサイトで公開またはカタログに提案

モデルを使う ​

  • チュートリアル:CSV ファイルから地図まで:実際のオープンデータをモデルに変換します。後半(任意)では、ブローカーに登録し、検索して、地図に表示します。
  • 一覧を公開する:自治体の CSV の一覧から、モデルに合った JSON を作り、オープンデータとして CSV の隣に公開します。
  • 使い方:カタログのモデルで JSON を検証し、NGSI-LD ブローカーに送り、Linked Data として使う方法です。

モデルを合わせる ​

  • 属性を足す:モデルを複製せずに、独自の属性を足します(拡張)。必要なファイルは、ページの中の拡張ビルダーで作れます。
  • 独自の名前で使う:モデルはそのままで、属性名や型名を自分たちの呼び方に合わせます(別名)。

カタログに加わる ​

  • 貢献する:参加の方法です。モデルの提案、拡張やサイトの登録、他のカタログを知らせるフォームと、そのあとの流れを説明します。
  • モデルのルール:カタログに載せるモデル、独自の型を作るときの考え方、守ること、標準との対応表、例の書き方、モデルの段階です。

カタログの外のモデル ​

参照 ​

  • 対応している標準:自治体標準オープンデータセットや災害対応基本共有情報(EEI)など、モデルが対応している標準と、対応するモデルの一覧です。
  • 対応表:標準のどの項目がモデルのどの属性に当たるかを示すファイルです。ある場所と、書いてあることを説明します。
  • normalized の形:エンティティの key-values の形と normalized の形、一方を他方にする決まりを、例と共に説明します。
  • URL とバージョン:どの URL を使うか、何が変わらないか、バージョンと非推奨について説明します。
  • 他のデータモデルカタログ:提案の前に確かめておきたい、国内外のデータモデルのカタログです。
  • データモデルのサイト:自分のデータモデルを公開している、datamodels.jp が知っているサイトの一覧です。1 行に 1 つのサイトで、もとにしたカタログのモデルが分かります。

用語 ​

このサイトでは、次の言葉を次の意味で使います。

  • モデル:ある種類のデータ(型)が、どの属性をどんな意味で持つかを決めたものです。@context、JSON Schema、例で公開しています。
  • エンティティ:データの 1 件です。避難場所 1 か所が、1 つのエンティティです。
  • 属性:エンティティが持つ項目です。名称、位置、対象となる災害の種別などです。
  • 分野:関係するモデルのまとまりです。名前空間とバージョンを持ちます(disaster、transportation など)。URL やコマンドでは <subject> と書きます。
  • @context:短い名前(hazardTypes など)を IRI に結び付ける、辞書のようなファイルです。
  • IRI:型や属性に付けた、Web 全体で一意の名前です(https://datamodels.jp/ns/disaster/hazardTypes など)。
  • key-values の形:属性名と値だけの、単純な JSON の形です。JSON Schema は、この形のデータを検証します(normalized の形)。
  • normalized の形:NGSI-LD ブローカーに送る形です。各属性が、Property や Relationship などの種類も示します(normalized の形)。
  • 検証:データが JSON Schema などの決まりに合っているかを確かめることです。CI やツールキットの check がカタログやサイトのファイルを確かめることは、「検査」と呼びます。
  • 対応表:標準や手元の一覧のどの項目が、モデルのどの属性に当たるかを書いたファイルです(対応表)。
  • 拡張:カタログのモデルに自分の属性を足すために公開する、小さな @context です。技術的には、モデルのプロファイルです(属性を足す)。ツールキットの extend は別のもので、カタログのモデルをもとに、自分のサイトに新しいモデルを作ります。
  • 別名:カタログの型や属性に付ける、自分たちの名前です。意味は変わりません(独自の名前で使う)。
  • バージョンの別名:v1.jsonld のように、メジャーバージョンだけを書いた URL です。互換性のある最新のバージョンを指します(URL とバージョン)。