6.5.2 XBRLDocumentManagerクラス

public abstract class XBRLDocumentManager
extends java.lang.Object

XBRLのバージョン:
2.0および2.1
説明:
XBRL文書の入出力や,タクソノミー文書のキャッシュを管理します。
XBRL DOMを使用する前に,init()メソッドを呼び出してXBRL DOMを初期化する必要があります。XBRL DOMを初期化すると,XBRLDocumentManagerを実装したクラスのインスタンスがシングルトンとして生成されます。生成されたXBRLDocumentManagerを実装したクラスのインスタンスはgetInstance()メソッドで取得できます。
メソッドの概要:
XBRLDocumentManagerクラスのメソッドの概要を次の表に示します。

表6-8 XBRLDocumentManagerクラスのメソッドの概要

項番説明XBRLのバージョン
1static voidinit()
  XBRL DOMを初期化します。
2.0および2.1
2static voidinit(java.lang.String path)
  XBRL DOMを初期化します。
2.0および2.1
3static voidinit(java.util.Properties properties)
  XBRL DOMを初期化します。
2.0および2.1
4static XBRLDocumentManagergetInstance()
  XBRLDocumentManagerを実装したクラスのインスタンスを取得します。
2.0および2.1
5abstract XBRLInstanceDocumentBuilderFactorynewInstanceDocumentBuilderFactory()
  XBRLInstanceDocumentBuilderFactoryオブジェクトを生成します。
2.0および2.1
6abstract XBRLInstanceDocumentWriterFactorynewInstanceDocumentWriterFactory()
  XBRLInstanceDocumentWriterFactoryオブジェクトを生成します。
2.0および2.1
7abstract XBRLTaxonomyDocumentBuilderFactorynewTaxonomyDocumentBuilderFactory()
  XBRLTaxonomyDocumentBuilderFactoryオブジェクトを生成します。
2.0および2.1
8abstract XBRLDocumentWriterFactorynewDocumentWriterFactory()
  XBRLDocumentWriterFactoryオブジェクトを生成します。
2.1
9abstract SimpleTaxonomyBuilderFactorynewSimpleTaxonomyBuilderFactory()
  SimpleTaxonomyBuilderFactoryオブジェクトを生成します。
2.1
10abstract voidclearCache()
  キャッシュされているすべてのタクソノミー文書を,キャッシュから削除します。
2.0および2.1
<この項の構成>
(1) init
(2) init
(3) init
(4) getInstance
(5) newInstanceDocumentBuilderFactory
(6) newInstanceDocumentWriterFactory
(7) newTaxonomyDocumentBuilderFactory
(8) newDocumentWriterFactory
(9) newSimpleTaxonomyBuilderFactory
(10) clearCache

(1) init

public static void init()
                  throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
XBRL DOMを初期化します。
このメソッドでは,XBRL DOMの動作を制御するための各プロパティにデフォルト値が設定されたものとして,初期化処理します。プロパティのデフォルト値については,「4.16.2 プロパティ一覧」を参照してください。
各プロパティの値を明示的に指定して初期化処理する場合は,このinit()メソッドではなく,init(java.lang.String)メソッドまたはinit(java.util.Properties)メソッドを使用します。
例外:
XBRLDOMException -
  • XBRL DOMの初期化処理でエラーが発生した場合にスローされます。[エラーコード:39000]
XBRLDOMRuntimeException -
  • XBRL DOMがすでに初期化されている場合にスローされます。[エラーコード:20000]

(2) init

public static void init(java.lang.String path)
                  throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
XBRL DOMを初期化します。
このメソッドは,指定したプロパティファイルの内容に従ってXBRL DOMを初期化します。プロパティファイルに記述できるプロパティの詳細,およびプロパティファイルの記述方法については,「4.16.2 プロパティ一覧」を参照してください。
引数pathに指定したプロパティファイルで定義されていないプロパティについては,デフォルト値が設定されます。そのため,引数pathに指定するプロパティファイルでは,すべてのプロパティを定義する必要はありません。
引数:
path - XBRL DOMのプロパティを記述したプロパティファイルの絶対パス名を指定します。
例外:
XBRLDOMException -
  • プロパティファイルの読み込み中にエラーが発生した場合にスローされます。[エラーコード:39200,39203,39204,39205,39206]
  • XBRL DOMの初期化処理でエラーが発生した場合にスローされます。[エラーコード:39000]
XBRLDOMRuntimeException -
  • XBRL DOMがすでに初期化されている場合にスローされます。[エラーコード:20000]
  • 引数pathにnullを指定した場合にスローされます。[エラーコード:20002]

(3) init

public static void init(java.util.Properties properties)
                  throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
XBRL DOMを初期化します。
このメソッドは,指定したプロパティの設定値に従ってXBRL DOMを初期化します。XBRL DOMの動作を制御するために指定できるプロパティの詳細については,「4.16.2 プロパティ一覧」を参照してください。
引数propertiesに指定したjava.util.Propertiesオブジェクトで定義されていないプロパティについては,デフォルト値が設定されます。そのため,引数propertiesに指定するjava.util.Propertiesオブジェクトでは,すべてのプロパティを定義する必要はありません。
引数:
properties - XBRL DOMのプロパティを格納しているjava.util.Propertiesオブジェクトを指定します。
例外:
XBRLDOMException -
  • プロパティの読み取り中にエラーが発生した場合にスローされます。[エラーコード:39200,39206]
  • XBRL DOMの初期化処理でエラーが発生した場合にスローされます。[エラーコード:39000]
XBRLDOMRuntimeException -
  • XBRL DOMがすでに初期化されている場合にスローされます。[エラーコード:20000]
  • 引数propertiesにnullを指定した場合にスローされます。[エラーコード:20002]

(4) getInstance

public static XBRLDocumentManager getInstance()

XBRLのバージョン:
2.0および2.1
説明:
XBRLDocumentManagerを実装したクラスのインスタンスを取得します。
このメソッドを呼び出す前に,init()メソッドを呼び出して,XBRL DOMを初期化しておく必要があります。
戻り値:
XBRLDocumentManagerを実装したクラスのインスタンスを返します。
例外:
XBRLDOMRuntimeException -
  • XBRL DOMが初期化されていない場合にスローされます。[エラーコード:20001]
使用例:

XBRLDocumentManager dm = XBRLDocumentManager.getInstance();
XBRLTaxonomyDocumentBuilderFactory tbf = dm.newTaxonomyDocumentBuilderFactory();

(5) newInstanceDocumentBuilderFactory

public abstract XBRLInstanceDocumentBuilderFactory newInstanceDocumentBuilderFactory()

XBRLのバージョン:
2.0および2.1
説明:
XBRLInstanceDocumentBuilderFactoryオブジェクトを生成します。
戻り値:
新しく生成されたXBRLInstanceDocumentBuilderFactoryオブジェクトを返します。

(6) newInstanceDocumentWriterFactory

public abstract XBRLInstanceDocumentWriterFactory newInstanceDocumentWriterFactory()

XBRLのバージョン:
2.0および2.1
説明:
XBRLInstanceDocumentWriterFactoryオブジェクトを生成します。
戻り値:
新しく生成されたXBRLInstanceDocumentWriterFactoryオブジェクトを返します。

(7) newTaxonomyDocumentBuilderFactory

public abstract XBRLTaxonomyDocumentBuilderFactory newTaxonomyDocumentBuilderFactory()

XBRLのバージョン:
2.0および2.1
説明:
XBRLTaxonomyDocumentBuilderFactoryオブジェクトを生成します。
戻り値:
新しく生成されたXBRLTaxonomyDocumentBuilderFactoryオブジェクトを返します。

(8) newDocumentWriterFactory

public abstract XBRLDocumentWriterFactory newDocumentWriterFactory()

XBRLのバージョン:
2.1
説明:
XBRLDocumentWriterFactoryオブジェクトを生成します。
戻り値:
新たに生成されたXBRLDocumentWriterFactoryオブジェクトを返します。

(9) newSimpleTaxonomyBuilderFactory

public abstract SimpleTaxonomyBuilderFactory newSimpleTaxonomyBuilderFactory()

XBRLのバージョン:
2.1
説明:
SimpleTaxonomyBuilderFactoryオブジェクトを生成します。
戻り値:
新たに生成されたSimpleTaxonomyBuilderFactoryオブジェクトを返します。

(10) clearCache

public abstract void clearCache()

XBRLのバージョン:
2.0および2.1
説明:
キャッシュされているすべてのタクソノミー文書を,キャッシュから削除します。