共通データ仕様 / データパーツ (コンピュータ用の帳票の部品)

データパーツへのインデックス

■一般的に使われるデータパーツ

 施設管理だけでなく、一般的に利用可能なデータパーツの定義です。

■施設関連のデータパーツ

 施設管理だけでなく、一般的に利用可能なデータモパーツの定義です。

■項目定義のデータパーツ

 項目に登録する値のルールを決めているデータパーツの定義です。

  • id (id)
    NGSI V2でデータモデルの必須項目となっているidの形式定義です。
  • postalCode
    日本国内の郵便番号を表すデータパーツの定義です。
  • telephone
    電話番号を表すデータパーツの定義です

データパーツとは

 既に記載した通り、コンピュータ用の帳票のひな形をデータモデルと呼びます。従って、データモデルにも情報を登録するための項目が並んでいます。帳票と同様に、データモデルにも、同じ形式の部分が含まれていることが良くあります。例えば、住所、連絡先、座標などは色々なデータモデルに含まれていますが、この構造が帳票毎にバラバラだとアプリを作る場合などに非効率です。そこで、同じ形式になるであろう部分をパーツとして切り出して一ヶ所で定義して、各データモデルはパーツを指定するようにします。本協議会ではそれらの切り出したパーツを「データパーツ」と呼んでいます。

 データパーツには、項目の構造を定義するタイプと、項目に登録する値を定義するタイプがあります。前記のインデックスでは、「項目定義のデータパーツ」が後者で、それ以外は前者の構造をていぎするタイプです。

 前者の項目を定義するタイプとは、例えば住所は都道府県・市区町村・町字・番地・号など、色々な項目が組み合わさって出来ています。これを一つの項目とするか、複数の項目に分けるか、複数に分けるとしたらどこで分けるのかなどのルールを決めています。

 後者の項目に登録する値を定義するタイプとは次の通りです。帳票の項目の中には、一つの項目なのだけれど、中身を見ると構造を持っているものがあります。例えば、電話番号は市外局番や局番や番号が組み合わさって出来ています。前記の様に項目を分けても良いのですが、却って煩雑になるので、ひとつの項目のままでルールを決めているのか後者です。

データパーツに関する技術情報

■データモデルからみたデータパーツ

 データモデルの定義で項目に構造がある場合は、本来はAttribute typeに”StructuredValue”を記述し、valueに構造をもった値の定義をしますが、パーツを使っている場合は、Attribute typeにパーツの名称を記入し、構造の定義は省略してあります。また、項目定義のパーツの場合は、Attribute nameにデータパーツ名を表示してあります。どちらもパーツへのリンクを埋め込んであります。

 各データパーツの説明で、「想定項目名」はデータモデル内で定義するAttribute nameとして使ってはどうかという提案です。Attribute nameが共通していると視認性が良いため、推奨として提案しています。「Attribute type」はデータパーツの名称であると共に、データモデル内でデータパーツを使う際にどのデータパーツか区別するためにAttribute typeに記載するために使用します。

■データパーツの定義の見方

 各データモデルの定義は以下の通りです。

  • Attribute name: 項目の名称です。NGSI V2の規定に従い、米国英語を繋げた小文字で始まるLCCになっています。但し、一行目のAttribute nameは想定項目名であり、必ずしもデータモデルで同じ名前を使っているとは限りません。視認性確保のため、項目名として想定項目名を利用する事を推奨しています
  • 回数: 値を幾つ登録して良いかを示しています。回数は”a::b”の記号で書かれていますが、aが最小回数、bは最大回数です。つまり、”0::1″はデータを登録してもしなくても良いが、登録数は最大1個という意味になります。最大数bがnの場合は、登録する値の数に制限が無い事を示しています
  • type: 登録する値の形式です。例えばTextは単語などの文字列で、Numberは数値です。興味がある方は、準拠規格のデータタイプをご覧ください。データパーツの中で更にデータパーツを利用している場合、ここにデータパーツの名称が記入されています
  • 補足: Attributeの説明です

 各データモデルには技術情報も掲載されていますが、技術情報の各項目は以下の意味を持ちます。

  • 想定項目名: 構造を持つデータパーツにあり、推奨するAttribute nameです
  • 定義名: 定義に与えられた識別子であり、構造を持つデータパーツではAttribute typeに一致します。項目定義のデータパーツでは、Attribute nameに一致します
  • Attribute type: 実際のAttribute typeです
  • 継承元データモデル: その定義を策定する際に元となったデータモデルや規定類を示しています
  • 参照データモデル: その定義を策定する際に元となったデータモデルや規定類で、継承元データモデル以外のものを示しています
  • URI: 定義名には他の団体等で策定したものと同名の可能性があるため、識別するためのURLです。尚、各ヘッダに記載しているURIは、NGSI V2の後継規格であるNGSI-LDが準拠しているデータ形式であるJSON-LDに規定されているものです。本来はIRIと記載すべきものですが、NGSI-LDの記載に倣い、URIと記載しています。このURIが一致していると、データモデルの定義が一致しているという意味を持ちます。
  • 補足: 文字通り、補足です