6.5.1 XBRLParseErrorHandlerインターフェース

public interface XBRLParseErrorHandler

XBRLのバージョン:
2.0および2.1
説明:
XBRL文書の解析時に検出されたエラーの通知を受け取るためのインターフェースです。
XBRL文書の解析時に発生したエラーの通知を,ユーザーアプリケーションで受け取りたい場合は,このインターフェースを実装したクラスを用意する必要があります。このインターフェースを実装したクラスのインスタンスを,XBRLInstanceDocumentBuilderやXBRLTaxonomyDocumentBuilderのsetErrorHandler()メソッドで指定することで,XBRL文書の解析時に発生したすべてのエラーについての通知を受け取ることができます。
warning(),error(),fatalError()の各メソッドでは,XBRLDOMExceptionをスローして解析処理を中断させることができます。このとき,warning(),error(),fatalError()の各メソッドからスローされた例外は,XBRLInstanceDocumentBuilderやXBRLTaxonomyDocumentBuilderのparse()メソッドの呼び出し元へそのままスローされます。
メソッドの概要:
XBRLParseErrorHandlerインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1voidwarning(XBRLDOMException exception)
  警告の通知を受け取ります。
2.0および2.1
2voiderror(XBRLDOMException exception)
  回復できるエラーの通知を受け取ります。
2.0および2.1
3voidfatalError(XBRLDOMException exception)
  致命的なエラーの通知を受け取ります。
2.0および2.1
<この項の構成>
(1) warning
(2) error
(3) fatalError

(1) warning

public void warning(XBRLDOMException exception)
           throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
警告の通知を受け取ります。このメソッドの呼び出しで例外がスローされなかった場合,XBRL DOMは解析処理を続行します。
引数:
exception - カプセル化された警告情報が指定されます。
例外:
XBRLDOMException -
  • 解析処理を中断させる場合は,引数exceptionに指定した例外をそのままスローするか,またはXBRLDOMUserExceptionをスローしてください。

(2) error

public void error(XBRLDOMException exception)
           throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
回復できるエラーの通知を受け取ります。このメソッドの呼び出しで例外がスローされなかった場合,XBRL DOMは解析処理を続行します。
引数:
exception - カプセル化されたエラー情報が指定されます。
例外:
XBRLDOMException -
  • 解析処理を中断させる場合は,引数exceptionに指定した例外をそのままスローするか,または,XBRLDOMUserExceptionをスローしてください。

(3) fatalError

public void fatalError(XBRLDOMException exception)
           throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
致命的なエラーの通知を受け取ります。このメソッドの呼び出しで例外がスローされなかった場合でも,XBRL DOMは必ず解析処理を中断します。このメソッドの呼び出しで例外がスローされなかった場合は,XBRLInstanceDocumentBuilderまたはXBRLTaxonomyDocumentBuilderのparse()メソッドの呼び出し元へ,引数exceptionに指定した例外がスローされます。
引数:
exception - カプセル化されたエラー情報が指定されます。
例外:
XBRLDOMException -
  • 引数exceptionに指定した例外をそのままスローするか,または,XBRLDOMUserExceptionをスローしてください。