6.8.14 XBRLTaxonomyDocumentBuilderインターフェース

public interface XBRLTaxonomyDocumentBuilder

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書からXBRLTaxonomyDocumentオブジェクトを取得するためのAPIを定義します。
メソッドの概要:
XBRLTaxonomyDocumentBuilderインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1XBRLDocumentManagergetOwnerDocumentManager()
  XBRLTaxonomyDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトを取得します。
2.0および2.1
2intgetXBRLVersion()
  XBRLTaxonomyDocumentBuilderオブジェクトが解析するタクソノミー文書のXBRLバージョンを取得します。
2.0および2.1
3booleanisValidating()
  XBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時に文書の妥当性を検証するかどうかを調べます。
2.0および2.1
4booleanisDelayLoading()
  XBRLTaxonomyDocumentBuilderオブジェクトが,タクソノミー文書の解析時にリンクベースの遅延読み込みをするかどうかを調べます。
2.0および2.1
5intgetMaxTaxonomyExtension()
  タクソノミー文書の解析時に読み込むタクソノミー文書の最大階層数を取得します。
2.0
6intgetMaxDocuments()
  タクソノミー文書の解析時に読み込むタクソノミー文書の最大数を取得します。
2.1
7java.lang.ObjectgetProperty(java.lang.String name)
  XBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書を解析する際に使用するプロパティの値を取得します。
2.1
8voidsetEntityResolver(org.xml.sax.EntityResolver entityResolver)
  タクソノミー文書に記述されているエンティティを解決するために使用するエンティティリゾルバ(org.xml.sax.EntityResolverオブジェクト)を設定します。
2.0および2.1
9voidsetErrorHandler(XBRLParseErrorHandler errorHandler)
  タクソノミー文書解析時のエラーを受け取るXBRLParseErrorHandlerオブジェクトを設定します。
2.0および2.1
10XBRLTaxonomyDocumentparse(org.xml.sax.InputSource[] is)
  指定された入力ソースからタクソノミー文書を解析し,XBRLTaxonomyDocumentオブジェクトを新規に生成します。
2.0および2.1
11XBRLTaxonomyDocumentparse(java.io.File[] file)
  指定されたファイルをタクソノミー文書として解析し,XBRLTaxonomyDocumentオブジェクトを新規に生成します。
2.0および2.1
12XBRLTaxonomyDocumentparse(java.lang.String[] uri)
  指定されたURIの内容をタクソノミー文書として解析し,XBRLTaxonomyDocumentオブジェクトを新規に生成します。
2.0および2.1
13intgetDimensionsVersion()
  XBRLTaxonomyDocumentBuilderオブジェクトが,どのバージョンのXBRL Dimensionsに準拠しているタクソノミー文書を解析するのかを取得します。
2.1
<この項の構成>
(1) getOwnerDocumentManager
(2) getXBRLVersion
(3) isValidating
(4) isDelayLoading
(5) getMaxTaxonomyExtension
(6) getMaxDocuments
(7) getProperty
(8) setEntityResolver
(9) setErrorHandler
(10) parse
(11) parse
(12) parse
(13) getDimensionsVersion

(1) getOwnerDocumentManager

public XBRLDocumentManager getOwnerDocumentManager()

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

(2) getXBRLVersion

public int getXBRLVersion()

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

(3) isValidating

public boolean isValidating()

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

(4) isDelayLoading

public boolean isDelayLoading()

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

(5) getMaxTaxonomyExtension

public int getMaxTaxonomyExtension()

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

(6) getMaxDocuments

public int getMaxDocuments()

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

(7) getProperty

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

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

(8) setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されているエンティティを解決するために使用するエンティティリゾルバ(org.xml.sax.EntityResolverオブジェクト)を設定します。
org.xml.sax.EntityResolverインターフェースのresolveEntity()メソッドの戻り値として返すorg.xml.sax.InputSourceオブジェクトには,java.io.InputStreamやjava.io.Readerを設定できます。このとき,必ずシステム識別子も設定してください。システム識別子を設定しないで,java.io.InputStreamやjava.io.Readerだけを設定した場合,XMLプロセッサがタクソノミー本体を処理する際に,<xsd:import>要素や<xsd:include>要素のschemaLocation属性に指定したURIを解決できないためエラーが発生します。このため,org.xml.sax.EntityResolverインターフェースを実装する際には,org.xml.sax.InputSourceオブジェクトに必ずシステム識別子を設定しなければなりません。なお,JAXPの仕様では,org.xml.sax.InputSourceオブジェクトに設定するシステム識別子は,絶対URIでなければなりません。
引数:
entityResolver - 解析するタクソノミー文書に存在するエンティティを解決するために使用されるorg.xml.sax.EntityResolverオブジェクトを指定します。nullを指定すると,デフォルトの実装が使用されます。

(9) setErrorHandler

public void setErrorHandler(XBRLParseErrorHandler errorHandler)

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書解析時のエラーを受け取るXBRLParseErrorHandlerオブジェクトを設定します。
引数errorHandlerにnullを指定した場合は,XBRLParseErrorHandlerインターフェースのデフォルトの実装が使用されます。デフォルトの実装では,warning(),error() の両メソッドが呼び出された場合は何もしないため,解析処理が続行されます。また,fatalError()メソッドが呼び出された場合は,fatalError()メソッドの引数に指定した例外をスローし,解析処理が中断されます。
引数:
errorHandler - 解析するタクソノミー文書に存在するエラーのレポートを受け取るXBRLParseErrorHandlerオブジェクトを指定します。nullを指定すると,デフォルトの実装が使用されます。

(10) parse

public XBRLTaxonomyDocument parse(org.xml.sax.InputSource[] is)
                           throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
指定された入力ソースからタクソノミー文書を解析し,XBRLTaxonomyDocumentオブジェクトを新規に生成します。
引数isに指定した配列の各要素のorg.xml.sax.InputSourceオブジェクトには,必ずシステム識別子を設定しなければなりません。システム識別子が設定されていない場合は,例外がスローされます。
引数:
is - 入力ソースを表すorg.xml.sax.InputSourceオブジェクトの配列を指定します。
戻り値:
新しく生成されたXBRLTaxonomyDocumentオブジェクトを返します。
例外:
XBRLDOMException -
  • タクソノミー文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 引数isにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数isに指定した配列の要素数が0の場合にスローされます。[エラーコード:20013]
  • 引数isに指定した配列に値がnullである要素が存在する場合にスローされます。[エラーコード:20012]
  • 引数isに指定した配列にシステム識別子が設定されていないorg.xml.sax.InputSourceオブジェクトが存在する場合にスローされます。[エラーコード:20016]
  • 引数isに指定した配列中のorg.xml.sax.InputSourceオブジェクトに設定されているシステム識別子の形式が不正な場合にスローされます。[エラーコード:20148]

(11) parse

public XBRLTaxonomyDocument parse(java.io.File[] file)
                           throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
指定されたファイルをタクソノミー文書として解析し,XBRLTaxonomyDocumentオブジェクトを新規に生成します。
引数:
file - タクソノミー文書を含むファイルを表すjava.io.Fileオブジェクトの配列を指定します。
戻り値:
新しく生成されたXBRLTaxonomyDocumentオブジェクトを返します。
例外:
XBRLDOMException -
  • タクソノミー文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 引数fileにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数fileに指定した配列の要素数が0の場合にスローされます。[エラーコード:20013]
  • 引数fileに指定した配列に値がnullである要素が存在する場合にスローされます。[エラーコード:20012]

(12) parse

public XBRLTaxonomyDocument parse(java.lang.String[] uri)
                           throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
指定されたURIの内容をタクソノミー文書として解析し,XBRLTaxonomyDocumentオブジェクトを新規に生成します。
引数:
uri - タクソノミー文書の場所を示すURIを表す文字列の配列を指定します。
戻り値:
新しく生成されたXBRLTaxonomyDocumentオブジェクトを返します。
例外:
XBRLDOMException -
  • タクソノミー文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 引数uriにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数uriに指定した配列の要素数が0の場合にスローされます。[エラーコード:20013]
  • 引数uriに指定した配列に値がnullである要素が存在する場合にスローされます。[エラーコード:20012]
  • 引数uriに指定した配列中のURIの形式が不正な場合にスローされます。[エラーコード:20148]

(13) getDimensionsVersion

public int getDimensionsVersion()

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