6.8.15 XBRLTaxonomyDocumentBuilderFactoryインターフェース

public interface XBRLTaxonomyDocumentBuilderFactory

XBRLのバージョン:
2.0および2.1
説明:
XBRLTaxonomyDocumentBuilderオブジェクトを生成するためのAPIを定義します。
メソッドの概要:
XBRLTaxonomyDocumentBuilderFactoryインターフェースのメソッドの概要を次の表に示します。

表6-106 XBRLTaxonomyDocumentBuilderFactoryインターフェースのメソッドの概要

項番説明XBRLのバージョン
1XBRLDocumentManagergetOwnerDocumentManager()
  XBRLTaxonomyDocumentBuilderFactoryオブジェクトを所有するXBRLDocumentManagerオブジェクトを取得します。
2.0および2.1
2voidsetXBRLVersion(int version)
  どのXBRLバージョンのタクソノミー文書を解析するのかを設定します。
2.0および2.1
3intgetXBRLVersion()
  どのXBRLバージョンのタクソノミー文書を解析するのかを取得します。
2.0および2.1
4voidsetValidating(boolean flag)
  タクソノミー文書の解析時に文書の妥当性を検証するかどうかを設定します。
2.0および2.1
5booleanisValidating()
  タクソノミー文書の解析時に文書の妥当性を検証するかどうかを調べます。
2.0および2.1
6voidsetDelayLoading(boolean flag)
  タクソノミー文書の解析時にリンクベースの遅延読み込みをするかどうかを設定します。
2.0および2.1
7booleanisDelayLoading()
  タクソノミー文書の解析時にリンクベースの遅延読み込みをするかどうかを調べます。
2.0および2.1
8voidsetMaxTaxonomyExtension(int max)
  タクソノミー文書の解析時に読み込むタクソノミー文書の最大階層数を設定します。
2.0
9intgetMaxTaxonomyExtension()
  タクソノミー文書の解析時に読み込むタクソノミー文書の最大階層数を取得します。
2.0
10voidsetMaxDocuments(int max)
  タクソノミー文書の解析時に読み込むタクソノミー文書の最大数を設定します。
2.1
11intgetMaxDocuments()
  タクソノミー文書の解析時に読み込むタクソノミー文書の最大数を取得します。
2.1
12voidsetIgnoringComments(boolean flag)
  タクソノミー文書の解析時にコメントを無視するかどうかを設定します。
2.0および2.1
13booleanisIgnoringComments()
  タクソノミー文書の解析時にコメントを無視するかどうかを調べます。
2.0および2.1
14voidsetCoalescing(boolean flag)
  タクソノミー文書の解析時にCDATAノードをTextノードに変換するかどうかを設定します。
2.0および2.1
15booleanisCoalescing()
  タクソノミー文書の解析時にCDATAノードをTextノードに変換するかどうかを調べます。
2.0および2.1
16voidsetProperty(java.lang.String name, java.lang.Object value)
  XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するプロパティの値を設定します。
2.1
17java.lang.ObjectgetProperty(java.lang.String name)
  XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するプロパティの値を取得します。
2.1
18XBRLTaxonomyDocumentBuildernewTaxonomyDocumentBuilder()
  現在設定されているパラメタを使用して,XBRLTaxonomyDocumentBuilderのインスタンスを新規に生成します。
2.0および2.1
19voidsetDimensionsVersion(int version)
  XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,どのバージョンのXBRL Dimensionsに準拠しているタクソノミー文書を解析するのかを指定します。
2.1
20intgetDimensionsVersion()
  XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,どのバージョンのXBRL Dimensionsに準拠しているタクソノミー文書を解析するのかを取得します。
2.1
<この項の構成>
(1) getOwnerDocumentManager
(2) setXBRLVersion
(3) getXBRLVersion
(4) setValidating
(5) isValidating
(6) setDelayLoading
(7) isDelayLoading
(8) setMaxTaxonomyExtension
(9) getMaxTaxonomyExtension
(10) setMaxDocuments
(11) getMaxDocuments
(12) setIgnoringComments
(13) isIgnoringComments
(14) setCoalescing
(15) isCoalescing
(16) setProperty
(17) getProperty
(18) newTaxonomyDocumentBuilder
(19) setDimensionsVersion
(20) getDimensionsVersion

(1) getOwnerDocumentManager

public XBRLDocumentManager getOwnerDocumentManager()

XBRLのバージョン:
2.0および2.1
説明:
XBRLTaxonomyDocumentBuilderFactoryオブジェクトを所有するXBRLDocumentManagerオブジェクトを取得します。
戻り値:
このXBRLTaxonomyDocumentBuilderFactoryオブジェクトを所有する,XBRLDocumentManagerオブジェクトを返します。

(2) setXBRLVersion

public void setXBRLVersion(int version)

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,どのXBRLバージョンのタクソノミー文書を解析するのかを設定します。このメソッドで指定した値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.XBRLVersionプロパティの値として設定されます。
cbrp.parse.XBRLVersionプロパティの値は,このメソッドか,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.XBRLVersionプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.XBRLVersionプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前にこのメソッドを呼び出してください。
引数:
version - XBRL2.0に準拠したタクソノミー文書を解析する場合はXBRLConstants.XBRL_2_0,XBRL2.1に準拠したタクソノミー文書を解析する場合はXBRLConstants.XBRL_2_1を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数versionに不正な値を指定した場合にスローされます。[エラーコード:20014]

(3) getXBRLVersion

public int getXBRLVersion()

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,どのXBRLバージョンのタクソノミー文書を解析するのかを取得します。このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.XBRLVersionプロパティの値です。
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.XBRLVersionプロパティの値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetXBRLVersion()メソッド,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.XBRLVersionプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
戻り値:
XBRL2.0に準拠したタクソノミー文書を解析する場合はXBRLConstants.XBRL_2_0,XBRL2.1に準拠したタクソノミー文書を解析する場合はXBRLConstants.XBRL_2_1を返します。

(4) setValidating

public void setValidating(boolean flag)

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時に文書の妥当性を検証するかどうかを設定します。このメソッドで指定した値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.validateプロパティの値として設定されます。
cbrp.parse.validateプロパティの値は,このメソッドか,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.validateプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.validateプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前にこのメソッドを呼び出してください。
引数:
flag - タクソノミー文書の解析時に妥当性を検証する場合はtrue,検証しない場合はfalseを指定します。

(5) isValidating

public boolean isValidating()

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時に文書の妥当性を検証するかどうかを調べます。
このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.validateプロパティの値です。
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.validateプロパティの値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetValidating()メソッド,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.validateプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
戻り値:
タクソノミー文書の解析時に妥当性を検証する場合はtrue,検証しない場合はfalseを返します。

(6) setDelayLoading

public void setDelayLoading(boolean flag)

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時にリンクベースの遅延読み込みをするかどうかを設定します。このメソッドで指定した値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.delayLoadプロパティの値として設定されます。
cbrp.parse.delayLoadプロパティの値は,このメソッドか,またはsetProperty()メソッドで設定します。これらのメソッドによってcbrp.parse.delayLoadプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.delayLoadプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前に,このメソッドを呼び出してください。
タクソノミー文書の解析時に妥当性を検証する場合は,リンクの解析を遅延することはできません。このメソッドでリンクの解析を遅延するように設定しても,その設定は無視されます。リンクの解析を遅延したい場合は,必ず妥当性の検証を行わないように設定します。
引数:
flag - タクソノミー文書に含まれるリンクの解析を遅延する場合はtrue,遅延しない場合はfalseを指定します。

(7) isDelayLoading

public boolean isDelayLoading()

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時にリンクベースの遅延読み込みをするかどうかを調べます。
このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.delayLoadプロパティの値です。
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.delayLoadプロパティの値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetDelayLoading()メソッド,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.delayLoadプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
戻り値:
タクソノミー文書に含まれるリンクの解析を遅延する場合はtrue,遅延しない場合はfalseを返します。

(8) setMaxTaxonomyExtension

public void setMaxTaxonomyExtension(int max)

XBRLのバージョン:
2.0
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時に読み込むタクソノミー文書の,基底タクソノミー文書までの最大階層数を設定します。このメソッドで指定した値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.maxTaxonomyExtensionプロパティの値として設定されます。
cbrp.parse.maxTaxonomyExtensionプロパティの値は,このメソッドか,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.maxTaxonomyExtensionプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.maxTaxonomyExtensionプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前にこのメソッドを呼び出してください。
cbrp.parse.maxTaxonomyExtensionプロパティの値は,解析対象のタクソノミー文書がXBRL2.0に準拠している場合だけ使用されます。解析対象のタクソノミー文書がほかのバージョンのXBRL仕様に準拠しているものである場合は,cbrp.parse.maxTaxonomyExtensionプロパティの値は使用されません。
引数:
max - タクソノミー文書の解析時に処理できる,拡張されたタクソノミー文書から基底タクソノミー文書までの最大階層を指定します。指定できる値の範囲は,0以上2,147,483,647(Integer.MAX_VALUE)以下です。
例外:
XBRLDOMRuntimeException -
  • 引数maxに負数を指定した場合にスローされます。[エラーコード:20014]

(9) getMaxTaxonomyExtension

public int getMaxTaxonomyExtension()

XBRLのバージョン:
2.0
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時に読み込むタクソノミー文書の,基底タクソノミー文書までの最大階層数を取得します。
このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.maxTaxonomyExtensionプロパティの値です。
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.maxTaxonomyExtensionプロパティの値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetMaxTaxonomyExtension()メソッド,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.maxTaxonomyExtensionプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.maxTaxonomyExtensionプロパティの値は,解析対象のタクソノミー文書がXBRL2.0に準拠している場合だけ使用されます。解析対象のタクソノミー文書がほかのバージョンのXBRL仕様に準拠しているものである場合は,cbrp.parse.maxTaxonomyExtensionプロパティの値は使用されません。
戻り値:
タクソノミー文書の解析時に処理できる,拡張されたタクソノミー文書から基底タクソノミー文書までの最大階層を返します。

(10) setMaxDocuments

public void setMaxDocuments(int max)

XBRLのバージョン:
2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時に読み込むタクソノミー文書の最大数を設定します。このメソッドで指定した値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.DTS.maxDocumentsプロパティの値として設定されます。
cbrp.parse.DTS.maxDocumentsプロパティの値は,このメソッドか,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.DTS.maxDocumentsプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.DTS.maxDocumentsプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前に,このメソッドを呼び出してください。
cbrp.parse.DTS.maxDocumentsプロパティの値は,解析対象のタクソノミー文書がXBRL2.1に準拠している場合だけ使用されます。解析対象のタクソノミー文書がほかのバージョンのXBRL仕様に準拠しているものである場合は,cbrp.parse.DTS.maxDocumentsプロパティの値は使用されません。
引数:
max - タクソノミー文書の解析時に処理できる文書の最大数を指定します。指定できる値の範囲は,0以上2,147,483,647(Integer.MAX_VALUE)以下です。
例外:
XBRLDOMRuntimeException -
  • 引数maxに負数を指定した場合にスローされます。[エラーコード:20014]

(11) getMaxDocuments

public int getMaxDocuments()

XBRLのバージョン:
2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時に読み込むタクソノミー文書の最大数を取得します。
このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.DTS.maxDocumentsプロパティの値です。
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.DTS.maxDocumentsプロパティの値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetMaxDocuments()メソッド,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.DTS.maxDocumentsプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.DTS.maxDocumentsプロパティの値は,解析対象のタクソノミー文書がXBRL2.1に準拠している場合だけ使用されます。解析対象のタクソノミー文書がほかのバージョンのXBRL仕様に準拠しているものである場合は,cbrp.parse.DTS.maxDocumentsプロパティの値は使用されません。
戻り値:
タクソノミー文書の解析時に処理できる文書の最大数を返します。

(12) setIgnoringComments

public void setIgnoringComments(boolean flag)

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時にコメントを無視するかどうかを設定します。このメソッドで指定した値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.ignoringCommentsプロパティの値として設定されます。
cbrp.parse.ignoringCommentsプロパティの値は,このメソッドか,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.ignoringCommentsプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.ignoringCommentsプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前にこのメソッドを呼び出してください。
cbrp.parse.ignoringCommentsプロパティでコメントを無視するように指定しても,無視しないように指定しても,XBRL DOMの動作に影響しません。ただし,XBRLTaxonomyNode.getW3CDOMNode()メソッドなどで取得したDOMツリーを参照した場合にCommentノードが含まれるかどうかについては,cbrp.parse.ignoringCommentsプロパティの指定によって違いが生じます。
引数:
flag - タクソノミー文書の解析時にコメントを無視する場合はtrue,コメントを無視しない場合はfalseを指定します。

(13) isIgnoringComments

public boolean isIgnoringComments()

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時にコメントを無視するかどうかを調べます。
このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.ignoringCommentsプロパティの値です。
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.ignoringCommentsプロパティの値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetIgnoringComments()メソッド,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.ignoringCommentsプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
戻り値:
タクソノミー文書の解析時にコメントを無視する場合はtrue,無視しない場合はfalseを返します。

(14) setCoalescing

public void setCoalescing(boolean flag)

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時にCDATAノードをTextノードに変換するかどうかを設定します。このメソッドで指定した値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.coalescingプロパティの値として設定されます。
cbrp.parse.coalescingプロパティの値は,このメソッドか,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.coalescingプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.coalescingプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前に,このメソッドを呼び出してください。
cbrp.parse.coalescingプロパティでCDATAノードをTextノードに変換するように指定しても,変換しないように指定しても,XBRL DOMの動作に影響しません。ただし,XBRLTaxonomyNode.getW3CDOMNode()メソッドなどで取得したDOMツリーを参照した場合にCDATAノードが含まれるかどうかについては,cbrp.parse.coalescingプロパティの指定によって違いが生じます。
引数:
flag - タクソノミー文書の解析時にCDATAノードをTextノードに変換する場合はtrue,Textノードに変換しない場合はfalseを指定します。

(15) isCoalescing

public boolean isCoalescing()

XBRLのバージョン:
2.0および2.1
説明:
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時にCDATAノードをTextノードに変換するかどうかを調べます。
このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するcbrp.parse.coalescingプロパティの値です。
このXBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.coalescingプロパティの値は,このXBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetCoalescing()メソッド,またはsetProperty()メソッドで設定できます。これらのメソッドによってcbrp.parse.coalescingプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
戻り値:
タクソノミー文書の解析時にCDATAノードをTextノードに変換する場合はtrue,変換しない場合はfalseを返します。

(16) setProperty

public void setProperty(java.lang.String name,
                       java.lang.Object value)

XBRLのバージョン:
2.1
説明:
XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するプロパティの値を設定します。このメソッドで値を設定できるプロパティの一覧およびこのメソッドにプロパティの値として指定するオブジェクトの詳細については,「4.16.2 プロパティ一覧」を参照してください。
各プロパティの値は,このメソッドか,またはsetValidating()などの各プロパティ専用のメソッドで設定できます。これらのメソッドによってプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時のプロパティの値は,引数nameで指定したプロパティに対し,初期化時に値が指定されていたかどうかで次のように異なります。
  • 初期化時にプロパティの値が指定されていた場合
    そのときの指定値がXBRL DOM初期化時の値となる。
  • 初期化時にプロパティの値が指定されていなかった場合
    そのプロパティのデフォルト値がXBRL DOM初期化時の値となる。
プロパティを設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前にこのメソッドを呼び出してください。
このメソッドで設定したプロパティ値は,setValidating()などの各プロパティ専用のメソッドによって上書きできます。逆に,setValidating()などの各プロパティ専用のメソッドで設定した値をこのメソッドで上書きすることもできます。例えば,このメソッドでcbrp.parse.validateプロパティの値としてBoolean.TRUEを設定したあと,setValidating()メソッドを呼び出してfalseを設定した場合,getProperty()メソッドで取得したcbrp.parse.validateプロパティの値はBoolean.FALSEとなります。また,isValidating()メソッドもfalseを返します。
引数:
name - プロパティの名前を指定します。
value - プロパティの値を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数nameにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数nameに指定したプロパティの名前が正しくない場合にスローされます。[エラーコード:20150]
  • 引数nameに指定したプロパティが値としてnullを受け付けないで,かつ引数valueにnullを指定した場合にスローされます。[エラーコード:20151]
  • 引数valueに指定したオブジェクトの型が正しくない場合にスローされます。[エラーコード:20152]
  • 引数valueに指定したオブジェクトが保持している値が正しくない場合にスローされます。[エラーコード:20153]
  • 引数valueに指定したオブジェクトが配列で,かつ要素数が0である場合にスローされます。[エラーコード:20154]
  • 引数valueに指定したオブジェクトが配列で,かつ値がnullである要素が存在する場合にスローされます。[エラーコード:20155]

(17) getProperty

public java.lang.Object getProperty(java.lang.String name)

XBRLのバージョン:
2.1
説明:
XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するプロパティの値を取得します。このメソッドで値を取得できるプロパティの一覧およびこのメソッドがプロパティの値として返すオブジェクトの詳細については,「4.16.2 プロパティ一覧」を参照してください。
引数:
name - プロパティの名前を指定します。
戻り値:
プロパティの値を返します。
例外:
XBRLDOMRuntimeException -
  • 引数nameにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数nameに指定したプロパティの名前が正しくない場合にスローされます。[エラーコード:20150]

(18) newTaxonomyDocumentBuilder

public XBRLTaxonomyDocumentBuilder newTaxonomyDocumentBuilder()

XBRLのバージョン:
2.0および2.1
説明:
現在設定されているパラメタを使用して,XBRLTaxonomyDocumentBuilderのインスタンスを新規に生成します。
戻り値:
新しく生成されたXBRLTaxonomyDocumentBuilderオブジェクトを返します。

(19) setDimensionsVersion

public void setDimensionsVersion(int version)

XBRLのバージョン:
2.1

説明:

XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,どのバージョンのXBRL Dimensionsに準拠しているタクソノミー文書を解析するのかを指定します。このメソッドで指定した値は,XBRLTaxonomyDocumentBuilderFactoryオブジェクトによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用する,cbrp.parse.DimensionsVersionプロパティの値として設定されます。

cbrp.parse.DimensionsVersionプロパティの値は,このメソッドか,または,setProperty(java.lang.String name, java.lang.Object value)メソッドで設定できます。これらのメソッドによってcbrp.parse.DimensionsVersionプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。

cbrp.parse.DimensionsVersionプロパティの値を設定する場合は,newTaxonomyDocumentBuilder()メソッドを呼び出す前にこのメソッドを呼び出してください。

cbrp.parse.DimensionsVersionプロパティの値は,解析対象のタクソノミー文書がXBRL2.1に準拠している場合だけ使用されます。解析対象のタクソノミー文書がほかのバージョンのXBRLに準拠している場合は,cbrp.parse.DimensionsVersionプロパティの値は使用されません。

引数:
version - XBRL Dimensions1.0に準拠したタクソノミー文書を解析する場合はXBRLConstants.DIMENSIONS_1_0を指定します。XBRL Dimensionsに準拠したタクソノミー文書を解析しない場合はXBRLConstants.DIMENSIONS_NONEを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数versionに不正な値を指定した場合にスローされます。[エラーコード:20014]

(20) getDimensionsVersion

public int getDimensionsVersion()

XBRLのバージョン:
2.1
説明:
XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが,どのバージョンのXBRL Dimensionsに準拠しているタクソノミー文書を解析するのかを取得します。このメソッドが返す値は,XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用する,cbrp.parse.DimensionsVersionプロパティの値です。
XBRLTaxonomyDocumentBuilderFactoryによって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用するcbrp.parse.DimensionsVersionプロパティの値は,XBRLTaxonomyDocumentBuilderFactoryオブジェクトのsetDimensionsVersion(int version)メソッド,または,setProperty(java.lang.String name, java.lang.Object value) メソッドで設定できます。これらのメソッドによってcbrp.parse.DimensionsVersionプロパティの値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.8.15(16) setProperty」の説明を参照してください。
cbrp.parse.DimensionsVersionプロパティの値は,解析対象のタクソノミー文書がXBRL2.1に準拠している場合だけ使用されます。解析対象のタクソノミー文書がほかのバージョンのXBRLに準拠している場合は,cbrp.parse.DimensionsVersionプロパティの値は使用されません。
戻り値:
XBRL Dimensions1.0に準拠したタクソノミー文書を解析する場合はXBRLConstants.DIMENSIONS_1_0を返します。XBRL Dimensionsに準拠したタクソノミー文書を解析しない場合はXBRLConstants.DIMENSIONS_NONEを返します。