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