XBRLIdCreatorインターフェース

public interface XBRLIdCreator

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

フィールドの概要：

XBRLIdCreatorインターフェースのフィールドの概要を次の表に示します。

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

項番	説明
1	int	FOOTNOTE_LABEL 　　<link:footnote>要素のxlink:label属性に設定する値を生成することを示します。
2	int	LOC_LABEL 　　<link:loc>要素のxlink:label属性に設定する値を生成することを示します。
3	int	ITEM_ID 　　アイテムのid属性に設定する値を生成することを示します。
4	int	TUPLE_ID 　　タプルのid属性に設定する値を生成することを示します。
5	int	XBRL_ID 　　<xbrli:xbrl>要素のid属性に設定する値を生成することを示します。
6	int	CONTEXT_ID 　　<xbrli:context>要素のid属性に設定する値を生成することを示します。
7	int	UNIT_ID 　　<xbrli:unit>要素のid属性に設定する値を生成することを示します。
8	int	FOOTNOTE_LINK_ID 　　<link:footnoteLink>要素のid属性に設定する値を生成することを示します。
9	int	FOOTNOTE_ID 　　<link:footnote>要素のid属性に設定する値を生成することを示します。

メソッドの概要：

XBRLIdCreatorクラスのメソッドの概要を次の表に示します。

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

説明		XBRLのバージョン
java.lang.String	createId(int type, XBRLIdManager idManager) 　　IDを生成します。	2.1

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

説明：: 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の自動生成が必要な要素と属性
1	XBRLIdCreator.FOOTNOTE_LABEL	<link:footnote>/xlink:label
2	XBRLIdCreator.LOC_LABEL	<link:loc>/xlink:label
3	XBRLIdCreator.ITEM_ID	アイテム型要素/id
4	XBRLIdCreator.TUPLE_ID	タプル型要素/id
5	XBRLIdCreator.XBRL_ID	<xbrl>/id
6	XBRLIdCreator.CONTEXT_ID	<context>/id
7	XBRLIdCreator.UNIT_ID	<unit>/id
8	XBRLIdCreator.FOOTNOTE_LINK_ID	<footnoteLink>/id
9	XBRLIdCreator.FOOTNOTE_ID	<footnote>/id

なお，このメソッドがXBRLIdManagerオブジェクトから呼び出された場合，次の値が指定されることはありません。

idManager - このメソッドを呼び出したXBRLIdManagerオブジェクトを指定します。

戻り値：

各要素のid属性など，XML文書内に記述するIDを返します。返したIDが次の場合は，uCosminexus Business Reporting Processorによって自動採番し直されたIDが使用されます。