6.6.10 XBRLInstanceDocumentWriterインターフェース
public interface XBRLInstanceDocumentWriter
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書をストリームに書き出すためのインターフェースを提供します。
- メソッドの概要:
- XBRLInstanceDocumentWriterインターフェースのメソッドの概要を次の表に示します。
表6-28 XBRLInstanceDocumentWriterインターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | XBRLDocumentManager | getOwnerDocumentManager() XBRLInstanceDocumentWriterオブジェクトを所有するXBRLDocumentManagerオブジェクトを取得します。 | 2.0および2.1 |
2 | void | setEncoding(java.lang.String encoding) インスタンス文書を書き出す際に使用するエンコーディングを設定します。 | 2.0および2.1 |
3 | java.lang.String | getEncoding() インスタンス文書を書き出す際に使用するエンコーディングを取得します。 | 2.0および2.1 |
4 | void | setIndent(boolean indent) インスタンス文書を書き出す際にインデントをするかどうかを設定します。 | 2.0および2.1 |
5 | boolean | isIndent() インスタンス文書を書き出す際にインデントをするかどうかを調べます。 | 2.0および2.1 |
6 | void | write(java.io.OutputStream os, XBRLInstanceDocument doc) インスタンス文書をストリームに書き出します。 | 2.0および2.1 |
- <この項の構成>
- (1) getOwnerDocumentManager
- (2) setEncoding
- (3) getEncoding
- (4) setIndent
- (5) isIndent
- (6) write
(1) getOwnerDocumentManager
public XBRLDocumentManager getOwnerDocumentManager()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLInstanceDocumentWriterオブジェクトを所有するXBRLDocumentManagerオブジェクトを取得します。
- 戻り値:
- このXBRLInstanceDocumentWriterオブジェクトを所有するXBRLDocumentManagerオブジェクトを返します。
(2) setEncoding
public void setEncoding(java.lang.String encoding)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書を書き出す際に使用するエンコーディングを設定します。このメソッドが呼び出されなかった場合は,デフォルトのエンコーディングであるUTF-8が使用されます。
- XBRLInstanceDocumentWriterは,JAXPに準拠したXSLTプロセッサを使用してインスタンス文書をストリームへ出力します。このため,setEncoding()メソッドで指定できるエンコーディングは,使用するXSLTプロセッサに依存します。uCosminexus Business Reporting Processorとしては,利用できるエンコーディングに制限を設けません。setEncoding()メソッドでは,引数にnullを指定しないかぎり,例外は発生しません。XSLTプロセッサでサポートされていないエンコーディングを指定した場合は,write()メソッドで出力処理を実行する際に,例外が発生するおそれがあります。
- 引数:
- encoding - エンコーディングを指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数encodingにnullを指定した場合にスローされます。[エラーコード:20002]
(3) getEncoding
public java.lang.String getEncoding()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書を書き出す際に使用するエンコーディングを取得します。
- 戻り値:
- インスタンス文書を書き出す際に使用されるエンコーディングを返します。
(4) setIndent
public void setIndent(boolean indent)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書を書き出す際にインデントをするかどうかを設定します。このメソッドが呼び出されなかった場合は,インデントは設定しません。
- このメソッドでインデントを設定するように指定すると,XBRLInstanceDocumentWriterオブジェクトは,XSLTプロセッサに対してindentプロパティをyesに設定してから出力処理を実行します。
- 引数:
- indent - インスタンス文書を書き出す際にインデントを設定する場合はtrue,設定しない場合はfalseを指定します。
(5) isIndent
public boolean isIndent()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書を書き出す際にインデントをするかどうかを調べます。
- 戻り値:
- インスタンス文書を書き出す際にインデントを設定する場合はtrue,設定しない場合はfalseを返します。
(6) write
public void write(java.io.OutputStream os,
XBRLInstanceDocument doc)
throws XBRLDOMException
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書をストリームに書き出します。
- 注 書き出したインスタンス文書は,一度検証することを推奨します。
- XBRL2.1の場合:
インスタンス文書のルート要素がXML文書のルート要素ではない場合,インスタンス文書が埋め込まれているXML文書全体をストリームへ書き出します。インスタンス文書のルート要素がDOMツリーにつながっていない場合は,XBRLDOMRuntimeExceptionがスローされます。
- 引数:
- os - インスタンス文書を書き出すストリームを指定します。
- doc - ストリームへ書き出すインスタンス文書を指定します。
- 例外:
- XBRLDOMException -
- 入出力エラーが発生した場合にスローされます。[エラーコード:20052]
- XBRLDOMRuntimeException -
- 引数osまたはdocにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数docに指定したXBRLInstanceDocumentオブジェクトを所有するXBRLDocumentManagerオブジェクトが,このXBRLInstanceDocumentWriterオブジェクトを所有するXBRLDocumentManagerオブジェクトと異なる場合にスローされます。[エラーコード:20051]
- XBRL2.1の場合:引数docに指定されたインスタンス文書のルート要素がDOMツリーにつながっていない場合にスローされます。[エラーコード:20106]