6.10.5 XBRLIdManagerクラス

public class XBRLIdManager
extends java.lang.Object

XBRLのバージョン:
2.1
説明:
XBRL文書に記述されたIDを管理します。
コンストラクタの概要:
XBRLIdManagerクラスのコンストラクタの概要を次の表に示します。

表6-166 XBRLIdManagerクラスのコンストラクタの概要

説明XBRLのバージョン
XBRLIdManager()
  XBRL文書に記述されたIDを管理するXBRLIdManagerオブジェクトを新規に構築します。
2.1
メソッドの概要:
XBRLIdManagerクラスのメソッドの概要を次の表に示します。

表6-167 XBRLIdManagerクラスのメソッドの概要

項番説明XBRLのバージョン
1XBRLIdCreatorsetIdCreator(XBRLIdCreator creator)
  XBRLIdCreatorインターフェースを継承したオブジェクトを,XBRLIdManagerオブジェクトに設定します。
2.1
2XBRLIdCreatorgetIdCreator()
  このXBRLIdManagerオブジェクトに設定されているXBRLIdCreatorインターフェースを継承したオブジェクトを取得します。
2.1
3voidregisterDocument(XBRLInstanceDocument doc)
  XBRLInstanceDocumentオブジェクトをXBRLIdManagerオブジェクトに登録します。
2.1
4voidunregisterDocument(XBRLInstanceDocument doc)
  XBRLIdManagerオブジェクトで管理するXBRLInstanceDocumentオブジェクトの登録を解除します。
2.1
5booleanisId(java.lang.String id)
  このXBRLIdManagerオブジェクトに登録されているXBRLInstanceDocumentオブジェクトで,指定したIDがすでに使用されているIDかどうかを調べます。
2.1
6java.lang.String[]getIds()
  このXBRLIdManagerオブジェクトに登録されているXBRLInstanceDocumentオブジェクトで,すでに使用されているIDの配列を取得します。
2.1
<この項の構成>
(1) XBRLIdManager
(2) setIdCreator
(3) getIdCreator
(4) registerDocument
(5) unregisterDocument
(6) isId
(7) getIds

(1) XBRLIdManager

public XBRLIdManager()

XBRLのバージョン:
2.1
説明:
XBRL文書に記述されたIDを管理するXBRLIdManagerオブジェクトを新規に構築します。

(2) setIdCreator

public XBRLIdCreator setIdCreator(XBRLIdCreator creator)

XBRLのバージョン:
2.1
説明:
XBRLIdCreatorインターフェースを継承したオブジェクトを,XBRLIdManagerオブジェクトに設定します。
XBRLIdManagerオブジェクトに設定したXBRLIdCreatorオブジェクトは,IDが自動採番される前にcreateId()メソッドによって呼び出されます。XBRLIdCreatorを実装してsetIdCreator()メソッドを利用すれば,ユーザーアプリケーションでIDを生成できます。
setIdCreator()メソッドの引数creatorにnullを指定すると,uCosminexus Business Reporting Processorによる自動採番(未設定)に設定が戻ります。
引数:
creator - 自動採番で利用するXBRLIdCreatorオブジェクトを指定します。
戻り値:
設定前のXBRLIdCreatorオブジェクトを返します。未設定の場合には,デフォルト実装のXBRLIdCreatorオブジェクトを返します。

(3) getIdCreator

public XBRLIdCreator getIdCreator()

XBRLのバージョン:
2.1
説明:
このXBRLIdManagerオブジェクトに設定されているXBRLIdCreatorインターフェースを継承したオブジェクトを取得します。
戻り値:
設定されているXBRLIdCreatorオブジェクトを返します。設定されていない場合は,デフォルト実装のXBRLIdCreatorオブジェクトを返します。

(4) registerDocument

public void registerDocument(XBRLInstanceDocument doc)

XBRLのバージョン:
2.1
説明:
XBRLInstanceDocumentオブジェクトをXBRLIdManagerオブジェクトに登録します。
登録時に引数docに指定したXBRLInstanceDocumentオブジェクトは,既存のXBRLIdManagerオブジェクトから自動的に登録を解除されます。一つのXBRLInstanceDocumentオブジェクトを,複数のXBRLIdManagerオブジェクトでは管理しません。
また,すでにこのXBRLIdManagerオブジェクトで管理されているXBRLInstanceDocumentオブジェクトを引数docに指定しても,例外は発生しません。
引数:
doc - このオブジェクトで管理するXBRLInstanceDocumentオブジェクトを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数docにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数docに指定されたXBRLInstanceDocumentオブジェクトが準拠するXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20144]
  • このオブジェクトで管理するIDと,引数docに指定されたXBRLInstanceDocumentオブジェクトで使用されているIDが重複した場合にスローされます。[エラーコード:20028]
  • 引数docに指定されたXBRLInstanceDocumentオブジェクトのXBRLInstanceDocument.getW3CDOMNode()の結果と,すでに管理対象となっています。オブジェクトの結果が異なる場合にスローされます。[エラーコード:20143]

(5) unregisterDocument

public void unregisterDocument(XBRLInstanceDocument doc)

XBRLのバージョン:
2.1
説明:
このXBRLIdManagerオブジェクトで管理するXBRLInstanceDocumentオブジェクトの登録を解除します。
解除後,引数docのXBRLInstanceDocumentオブジェクトは,デフォルト実装の新たなXBRLIdManagerオブジェクトで管理されます。
ただし,このXBRLIdManagerオブジェクトに設定されているXBRLIdCreatorオブジェクトは,デフォルト実装の新たなXBRLIdManagerオブジェクトのXBRLIdCreatorオブジェクトとして設定されます。
よって,解除後にuCosminexus Business Reporting Processorによる自動採番を利用する場合には,XBRLIdManager.setIdCreator()メソッドで未設定に変更する必要があります。
引数:
doc - このオブジェクトで管理しているXBRLInstanceDocumentオブジェクトを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数docにnullを指定した場合にスローされます。[エラーコード:20002]

(6) isId

public boolean isId(java.lang.String id)

XBRLのバージョン:
2.1
説明:
このXBRLIdManagerオブジェクトに登録されているすべてのXBRLInstanceDocumentオブジェクトで,指定したIDがすでに使用されているかどうかを調べます。
引数:
id - このXBRLIdManagerオブジェクトに登録されているすべてのXBRLInstanceDocumentオブジェクトで,すでに使用されているかどうかを調べるIDを指定します。
戻り値:
このXBRLIdManagerオブジェクトに登録されているすべてのXBRLInstanceDocumentで,引数idがすでに使用されているIDの場合はtrue,使用されていない場合にはfalseを返します。

(7) getIds

public java.lang.String[] getIds()

XBRLのバージョン:
2.1
説明:
このXBRLIdManagerオブジェクトに登録されているすべてのXBRLInstanceDocumentオブジェクトで,すでに使用されているIDの配列を取得します。
戻り値:
このXBRLIdManagerオブジェクトに登録されているすべてのXBRLInstanceDocumentオブジェクトで,すでに使用されているIDの配列を返します。
すでに使用されているIDが存在しない場合はnullを返します。