6.10.1 XBRLIdCreatorインターフェース

public interface XBRLIdCreator

XBRLのバージョン:
2.1
説明:
XBRL文書のIDを生成するためのインターフェースです。
XBRL文書の編集時に自動採番されるIDを,ユーザーアプリケーションで生成したい場合は,このインターフェースを実装したクラスを用意する必要があります。
このインターフェースを実装したクラスのオブジェクトをXBRL文書のIDを管理するXBRLIdManagerオブジェクトに設定すると,IDの自動採番時にコールバックされ,ユーザーアプリケーションでIDを生成できます。
フィールドの概要:
XBRLIdCreatorインターフェースのフィールドの概要を次の表に示します。

表6-160 XBRLIdCreatorインターフェースのフィールドの概要

項番説明
1intFOOTNOTE_LABEL
  <link:footnote>要素のxlink:label属性に設定する値を生成することを示します。
2intLOC_LABEL
  <link:loc>要素のxlink:label属性に設定する値を生成することを示します。
3intITEM_ID
  アイテムのid属性に設定する値を生成することを示します。
4intTUPLE_ID
  タプルのid属性に設定する値を生成することを示します。
5intXBRL_ID
  <xbrli:xbrl>要素のid属性に設定する値を生成することを示します。
6intCONTEXT_ID
  <xbrli:context>要素のid属性に設定する値を生成することを示します。
7intUNIT_ID
  <xbrli:unit>要素のid属性に設定する値を生成することを示します。
8intFOOTNOTE_LINK_ID
  <link:footnoteLink>要素のid属性に設定する値を生成することを示します。
9intFOOTNOTE_ID
  <link:footnote>要素のid属性に設定する値を生成することを示します。
メソッドの概要:
XBRLIdCreatorクラスのメソッドの概要を次の表に示します。

表6-161 XBRLIdCreatorクラスのメソッドの概要

説明XBRLのバージョン
java.lang.StringcreateId(int type, XBRLIdManager idManager)
  IDを生成します。
2.1
<この項の構成>
(1) createId

(1) createId

public java.lang.String createId(int type,
                                XBRLIdManager idManager)

XBRLのバージョン:
2.1
説明:
IDを生成します。
インスタンス文書のアイテムや脚注リンクの<link:loc>要素などの生成時に,id属性やxlink:label属性などの値を自動生成する前に呼び出されます。このメソッドの戻り値(文字列)を,id属性やxlink:label属性などの値として使用します。
XBRLInstanceDocument.createItem()メソッドやXBRLInstanceDocument.addFootnote()メソッドなどの延長でこのメソッドが呼び出され,戻り値は引数idManagerのXBRLIdManagerオブジェクトで管理されます。
このメソッドで採番したIDが不正な場合や実行時例外がスローされた場合には,uCosminexus Business Reporting Processorによって自動採番し直されたIDが使用されます。
引数:
type - IDの自動生成が必要な要素の属性を示す値を指定します。詳細を次の表に示します。

表6-162 IDの自動生成が必要な要素と,typeに指定する値

項番typeに指定する値IDの自動生成が必要な要素と属性
1XBRLIdCreator.FOOTNOTE_LABEL<link:footnote>/xlink:label
2XBRLIdCreator.LOC_LABEL<link:loc>/xlink:label
3XBRLIdCreator.ITEM_IDアイテム型要素/id
4XBRLIdCreator.TUPLE_IDタプル型要素/id
5XBRLIdCreator.XBRL_ID<xbrl>/id
6XBRLIdCreator.CONTEXT_ID<context>/id
7XBRLIdCreator.UNIT_ID<unit>/id
8XBRLIdCreator.FOOTNOTE_LINK_ID<footnoteLink>/id
9XBRLIdCreator.FOOTNOTE_ID<footnote>/id
なお,このメソッドがXBRLIdManagerオブジェクトから呼び出された場合,次の値が指定されることはありません。
  • XBRLIdCreator.XBRL_ID
  • XBRLIdCreator.FOOTNOTE_LINK_ID
  • XBRLIdCreator.FOOTNOTE_ID
idManager - このメソッドを呼び出したXBRLIdManagerオブジェクトを指定します。
戻り値:
各要素のid属性など,XML文書内に記述するIDを返します。返したIDが次の場合は,uCosminexus Business Reporting Processorによって自動採番し直されたIDが使用されます。
  • 引数idManagerのXBRLIdManagerオブジェクト内で,一意でない場合
  • nullの場合
  • 空文字列の場合
  • xsd:NCName型でない場合
  • 実行時例外がスローされた場合