6.6.8 XBRLInstanceDocumentBuilderインターフェース
public interface XBRLInstanceDocumentBuilder
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書からXBRLInstanceDocumentオブジェクトを取得するためのAPIを定義します。
- メソッドの概要:
- XBRLInstanceDocumentBuilderインターフェースのメソッドの概要を次の表に示します。
表6-26 XBRLInstanceDocumentBuilderインターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | XBRLDocumentManager | getOwnerDocumentManager() XBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトを取得します。 | 2.0および2.1 |
2 | int | getXBRLVersion() XBRLInstanceDocumentBuilderオブジェクトが解析または作成するインスタンス文書のXBRLバージョンを取得します。 | 2.0および2.1 |
3 | boolean | isValidating() XBRLInstanceDocumentBuilderオブジェクトが,インスタンス文書の解析時に文書の妥当性を検証するかどうかを調べます。 | 2.0および2.1 |
4 | boolean | isDelayLoading() XBRLInstanceDocumentBuilderオブジェクトが,インスタンス文書の解析時にリンクベースの遅延読み込みをするかどうかを調べます。 | 2.0および2.1 |
5 | java.util.List<java.lang.String> | getExternalSchemaRefs() XBRLInstanceDocumentBuilderオブジェクトが,インスタンス文書の解析時に参照するタクソノミー本体のURIのリストを取得します。 | 2.1 |
6 | java.lang.Object | getProperty(java.lang.String name) XBRLInstanceDocumentBuilderオブジェクトがインスタンス文書を解析または作成する際に使用するプロパティの値を取得します。 | 2.1 |
7 | XBRLTaxonomyDocumentBuilder | getTaxonomyDocumentBuilder() タクソノミー文書を読み込むために使用するXBRLTaxonomyDocumentBuilderオブジェクトを取得します。 | 2.0および2.1 |
8 | void | setTaxonomyDocumentBuilder(XBRLTaxonomyDocumentBuilder taxonomyDocumentBuilder) タクソノミー文書を読み込むために使用するXBRLTaxonomyDocumentBuilderオブジェクトを設定します。 | 2.0および2.1 |
9 | void | setEntityResolver(org.xml.sax.EntityResolver entityResolver) インスタンス文書に存在するエンティティを解決するためのエンティティリゾルバ(org.xml.sax.EntityResolverオブジェクト)を設定します。 | 2.0および2.1 |
10 | void | setErrorHandler(XBRLParseErrorHandler errorHandler) インスタンス文書解析時のエラーを受け取るエラーハンドラ(XBRLParseErrorHandlerオブジェクト)を設定します。 | 2.0および2.1 |
11 | XBRLInstanceDocument | parse(org.xml.sax.InputSource is) 指定した入力ソースからインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.0および2.1 |
12 | XBRLInstanceDocument | parse(java.io.InputStream is) 指定した入力ストリームをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.0および2.1 |
13 | XBRLInstanceDocument | parse(java.io.InputStream is, java.lang.String systemId) 指定した入力ストリームをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.0および2.1 |
14 | XBRLInstanceDocument | parse(java.io.File file) 指定したファイルをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.0および2.1 |
15 | XBRLInstanceDocument | parse(java.lang.String uri) 指定したURIをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.0および2.1 |
16 | XBRLInstanceDocument | parse(org.w3c.dom.Element instanceRoot) 指定した要素をルート要素とするインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
17 | XBRLInstanceDocument | parse(org.w3c.dom.Element instanceRoot, java.lang.String systemId) 指定した要素をルート要素とするインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
18 | XBRLInstanceDocument[] | parse2(org.xml.sax.InputSource is) 指定した入力ソースに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
19 | XBRLInstanceDocument[] | parse2(java.io.InputStream is) 指定した入力ストリームに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
20 | XBRLInstanceDocument[] | parse2(java.io.InputStream is, java.lang.String systemId) 指定した入力ストリームに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
21 | XBRLInstanceDocument[] | parse2(java.io.File file) 指定したファイルに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
22 | XBRLInstanceDocument[] | parse2(java.lang.String uri) 指定したURIに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
23 | XBRLInstanceDocument | newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument) 空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.0および2.1 |
24 | XBRLInstanceDocument | newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument, java.lang.String systemId) 空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
25 | XBRLInstanceDocument | newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument, org.w3c.dom.Document w3cdomDocument) XML文書の任意の位置にインスタンス文書を追加する場合に使用します。空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
26 | XBRLInstanceDocument | newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument, org.w3c.dom.Document w3cdomDocument, java.lang.String systemId) XML文書の任意の位置にインスタンス文書を追加する場合に使用します。空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。 | 2.1 |
27 | int | getDimensionsVersion() XBRLInstanceDocumentBuilderオブジェクトが,どのバージョンのXBRL Dimensionsに準拠しているインスタンス文書を解析または作成するのかを取得します。 | 2.1 |
28 | void | setCreatingSchemaLocations(boolean creating) 空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを生成するときに,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組を設定するかどうかを指定します。 | 2.1 |
29 | boolean | isCreatingSchemaLocations() 空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを生成するときに,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組を設定するかどうかを示します。 | 2.1 |
- <この項の構成>
- (1) getOwnerDocumentManager
- (2) getXBRLVersion
- (3) isValidating
- (4) isDelayLoading
- (5) getExternalSchemaRefs
- (6) getProperty
- (7) getTaxonomyDocumentBuilder
- (8) setTaxonomyDocumentBuilder
- (9) setEntityResolver
- (10) setErrorHandler
- (11) parse
- (12) parse
- (13) parse
- (14) parse
- (15) parse
- (16) parse
- (17) parse
- (18) parse2
- (19) parse2
- (20) parse2
- (21) parse2
- (22) parse2
- (23) newInstanceDocument
- (24) newInstanceDocument
- (25) newInstanceDocument
- (26) newInstanceDocument
- (27) getDimensionsVersion
- (28) setCreatingSchemaLocations
- (29) isCreatingSchemaLocations
(1) getOwnerDocumentManager
public XBRLDocumentManager getOwnerDocumentManager()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトを取得します。
- 戻り値:
- このXBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトを返します。
(2) getXBRLVersion
public int getXBRLVersion()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLInstanceDocumentBuilderオブジェクトが解析または作成するインスタンス文書のXBRLバージョンを取得します。
- このメソッドが返す設定値は,このXBRLInstanceDocumentBuilderオブジェクトがインスタンス文書を解析または作成する際に使用するcbrp.parse.XBRLVersionプロパティの値となります。
- このXBRLInstanceDocumentBuilderオブジェクトが使用するcbrp.parse.XBRLVersionプロパティの値は,このXBRLInstanceDocumentBuilderオブジェクトを生成したXBRLInstanceDocumentBuilderFactoryオブジェクトのsetXBRLVersion()メソッド,またはsetProperty()メソッドで設定された値です。XBRLInstanceDocumentBuilderFactoryオブジェクトで値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.6.9(15) setProperty」の説明を参照してください。
- 戻り値:
- XBRL2.0に準拠したインスタンス文書を解析または作成する場合はXBRLConstants.XBRL_2_0,XBRL2.1に準拠したインスタンス文書を解析または作成する場合はXBRLConstants.XBRL_2_1を返します。
(3) isValidating
public boolean isValidating()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLInstanceDocumentBuilderオブジェクトが,インスタンス文書の解析時に文書の妥当性を検証するかどうかを調べます。
- このメソッドが返す設定値は,このXBRLInstanceDocumentBuilderオブジェクトがインスタンス文書を解析する際に使用するcbrp.parse.validateプロパティの値です。
- このXBRLInstanceDocumentBuilderオブジェクトが使用するcbrp.parse.validateプロパティの値は,このXBRLInstanceDocumentBuilderオブジェクトを生成したXBRLInstanceDocumentBuilderFactoryオブジェクトのsetValidating()メソッド,またはsetProperty()メソッドで設定された値です。XBRLInstanceDocumentBuilderFactoryオブジェクトで値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.6.9(15) setProperty」の説明を参照してください。
- 戻り値:
- インスタンス文書の解析時に妥当性を検証する場合はtrue,検証しない場合はfalseを返します。
(4) isDelayLoading
public boolean isDelayLoading()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLInstanceDocumentBuilderオブジェクトが,インスタンス文書の解析時にリンクベースの遅延読み込みをするかどうかを調べます。
- このメソッドが返す設定値は,このXBRLInstanceDocumentBuilderオブジェクトがインスタンス文書を解析する際に使用するcbrp.parse.delayLoadプロパティの値です。
- このXBRLInstanceDocumentBuilderオブジェクトが使用するcbrp.parse.delayLoadプロパティの値は,このXBRLInstanceDocumentBuilderオブジェクトを生成したXBRLInstanceDocumentBuilderFactoryオブジェクトのsetDelayLoading()メソッド,またはsetProperty()メソッドで設定された値です。XBRLInstanceDocumentBuilderFactoryオブジェクトで値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.6.9(15) setProperty」の説明を参照してください。
- 戻り値:
- インスタンス文書に記述されているリンクの解析を遅延する場合はtrue,遅延しない場合はfalseを返します。
(5) getExternalSchemaRefs
public java.util.List<java.lang.String> getExternalSchemaRefs()
- XBRLのバージョン:
- 2.1
- 説明:
- XBRLInstanceDocumentBuilderオブジェクトが,インスタンス文書の解析時に参照するタクソノミー本体のURIのリストを取得します。
- このメソッドが返す設定値は,このXBRLInstanceDocumentBuilderオブジェクトがインスタンス文書を解析する際に使用するcbrp.parse.DTS.externalSchemaRefsプロパティの値です。
- このXBRLInstanceDocumentBuilderオブジェクトが使用するcbrp.parse.DTS.externalSchemaRefsプロパティの値は,このXBRLInstanceDocumentBuilderオブジェクトを生成したXBRLInstanceDocumentBuilderFactoryオブジェクトのsetExternalSchemaRefs()メソッド,またはsetProperty()メソッドで設定された値です。XBRLInstanceDocumentBuilderFactoryオブジェクトで値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.6.9(15) setProperty」の説明を参照してください。
- このメソッドが返す設定値は,解析対象のインスタンス文書がXBRL2.1に準拠している場合にだけ有効です。解析対象のインスタンス文書がほかのバージョンのXBRL仕様に準拠しているものである場合は,このメソッドが返す設定値は使用されません。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- インスタンス文書の解析時に参照するタクソノミー本体のURIを表す文字列のリストを返します。インスタンス文書に記述されている<link:schemaRef>要素だけを使用して解析処理を行うように設定されている場合は,要素数が0のリストを返します。
(6) getProperty
public java.lang.Object getProperty(java.lang.String name)
- XBRLのバージョン:
- 2.1
- 説明:
- XBRLInstanceDocumentBuilderオブジェクトがインスタンス文書を解析または作成する際に使用するプロパティの値を取得します。このメソッドで値を取得できるプロパティの一覧およびこのメソッドがプロパティの値として返すオブジェクトの詳細については,「4.16.2 プロパティ一覧」を参照してください。
- 引数:
- name - プロパティの名前を指定します。
- 戻り値:
- プロパティの値を返します。
- 例外:
- XBRLDOMRuntimeException -
- 引数nameにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数nameに指定したプロパティの名前が正しくない場合にスローされます。[エラーコード:20150]
(7) getTaxonomyDocumentBuilder
public XBRLTaxonomyDocumentBuilder getTaxonomyDocumentBuilder()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- タクソノミー文書を読み込むために使用するXBRLTaxonomyDocumentBuilderオブジェクトを取得します。
- このメソッドが返す設定値は,このXBRLInstanceDocumentBuilderオブジェクトのsetTaxonomyDocumentBuilder()メソッドで設定された値となります。setTaxonomyDocumentBuilder()メソッドの引数にnullが指定された場合,または,setTaxonomyDocumentBuilder()メソッドが呼び出されなかった場合は,nullを返します。
- 戻り値:
- タクソノミー文書を読み込むために使用するXBRLTaxonomyDocumentBuilderオブジェクトを返します。nullを返した場合は,this.getOwnerDocumentManager().newTaxonomyDocumentBuilderFactory().newTaxonomyDocumentBuilder()によって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用されることを意味します。
(8) setTaxonomyDocumentBuilder
public void setTaxonomyDocumentBuilder(XBRLTaxonomyDocumentBuilder taxonomyDocumentBuilder)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- タクソノミー文書を読み込むために使用するXBRLTaxonomyDocumentBuilderオブジェクトを設定します。
- このメソッドで設定されたXBRLTaxonomyDocumentBuilderオブジェクトは,次の場合に使用されることがあります。
- このXBRLInstanceDocumentBuilderオブジェクトのparse()メソッドを呼び出してインスタンス文書を解析する際に,そのインスタンス文書が参照しているタクソノミー文書を解析する場合
- このXBRLInstanceDocumentBuilderオブジェクトによって生成されたXBRLInstanceDocumentオブジェクトに<link:linkbaseRef>要素を追加する場合
- XBRL2.1の場合:このXBRLInstanceDocumentBuilderオブジェクトによって生成されたXBRLInstanceDocumentオブジェクトに<link:schemaRef>要素,<link:roleRef>要素,および,<link:arcroleRef>要素を追加する場合
- このメソッドを呼び出さなかった場合,もしくは引数taxonomyDocumentBuilderにnullを指定した場合は,this.getOwnerDocumentManager().newTaxonomyDocumentBuilderFactory().newTaxonomyDocumentBuilder()によって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用されます。このとき,エンティティリゾルバ(org.xml.sax.EntityResolver),エラーハンドラ(XBRLParseErrorHandler),およびsetValidating()などのメソッドで設定される各種プロパティの値は,このXBRLInstanceDocumentBuilderオブジェクトに設定されたものが引き継がれます。
- 引数:
- taxonomyDocumentBuilder - タクソノミー文書を読み込むために使用するXBRLTaxonomyDocumentBuilderオブジェクトを指定します。nullを指定すると,this.getOwnerDocumentManager().newTaxonomyDocumentBuilderFactory().newTaxonomyDocumentBuilder()によって生成されるXBRLTaxonomyDocumentBuilderオブジェクトが使用されます。
- 例外:
- XBRLDOMRuntimeException -
- 引数taxonomyDocumentBuilderに指定したXBRLTaxonomyDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトが,このXBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトと異なる場合にスローされます。[エラーコード:20051]
- 引数taxonomyDocumentBuilderに指定されたXBRLTaxonomyDocumentBuilderオブジェクトが処理対象とするXBRLのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRLのバージョンが異なる場合にスローされます。[エラーコード:20102]
- XBRL2.1の場合:このXBRLInstanceDocumentBuilderオブジェクトがインスタンス文書の解析時に完全な妥当性検証をするように設定されていて,かつ引数taxonomyDocumentBuilderに指定されたXBRLTaxonomyDocumentBuilderオブジェクトがタクソノミー文書の解析時に完全な妥当性検証をするように設定されていない場合にスローされます。[エラーコード:20149]
- 引数taxonomyDocumentBuilderに指定したXBRLTaxonomyDocumentBuilderオブジェクトが処理対象とするXBRL Dimensionsのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRL Dimensionsのバージョンが異なる場合にスローされます。[エラーコード:22101]
(9) setEntityResolver
public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書に存在するエンティティを解決するためのエンティティリゾルバ(org.xml.sax.EntityResolverオブジェクト)を設定します。
- setTaxonomyDocumentBuilder()メソッドを呼び出さなかったか,またはsetTaxonomyDocumentBuilder()メソッドの引数にnullを指定した場合は,タクソノミー文書を解析する際に,エンティティを解決するため,このメソッドで設定したorg.xml.sax.EntityResolverオブジェクトが使用されます。タクソノミー文書を解析するために使用されるorg.xml.sax.EntityResolverオブジェクトでは,resolveEntity()メソッドの戻り値として返すorg.xml.sax.InputSourceオブジェクトに,必ずシステム識別子を設定しなければなりません。詳細については,XBRLTaxonomyDocumentBuilderインターフェースの「6.8.14(8) setEntityResolver」を参照してください。
- 引数:
- entityResolver - 解析するインスタンス文書に存在するエンティティを解決するために使用される,org.xml.sax.EntityResolverオブジェクトを指定します。nullを指定すると,デフォルトの実装が使用されます。
(10) setErrorHandler
public void setErrorHandler(XBRLParseErrorHandler errorHandler)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- インスタンス文書解析時のエラーを受け取るエラーハンドラ(XBRLParseErrorHandlerオブジェクト)を設定します。
- 引数errorHandlerにnullを指定した場合は,XBRLParseErrorHandlerインターフェースのデフォルトの実装が使用されます。デフォルトの実装では,warning(),error()の両メソッドが呼び出された場合は何もしないため,解析処理が続行されます。また,fatalError()メソッドが呼び出された場合は,fatalError()メソッドの引数に指定した例外をスローするため解析処理が中断されます。
- 引数:
- errorHandler - 解析するインスタンス文書に存在するエラーのレポートを受け取る,XBRLParseErrorHandlerオブジェクトを指定します。nullを指定すると,デフォルトの実装が使用されます。
(11) parse
public XBRLInstanceDocument parse(org.xml.sax.InputSource is)
throws XBRLDOMException
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 指定した入力ソースからインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- XBRL2.0の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素である必要があります。解析対象のインスタンス文書のルート要素がXML文書のルート要素でない場合は,致命的エラーが発生します。
- XBRL2.1の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。ただし,XML文書中に複数のインスタンス文書が含まれている場合は,最初の一つだけが解析され,二つ目以降のインスタンス文書は解析されません。XML文書中に含まれるすべてのインスタンス文書を解析したい場合は,parse2()メソッドを使用してください。
- 引数:
- is - 入力ソースを表すorg.xml.sax.InputSourceオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理で,エラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- 引数isにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数isに指定されたorg.xml.sax.InputSourceオブジェクトに設定されているシステム識別子の形式が不正な場合にスローされます。[エラーコード:20147]
(12) parse
public XBRLInstanceDocument parse(java.io.InputStream is)
throws XBRLDOMException
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 指定した入力ストリームをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- XBRL2.0の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素である必要があります。解析対象のインスタンス文書のルート要素がXML文書のルート要素でない場合は,致命的エラーが発生します。
- XBRL2.1の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。ただし,XML文書中に複数のインスタンス文書が含まれている場合は,最初の一つだけが解析され,二つ目以降のインスタンス文書は解析されません。XML文書中に含まれるすべてのインスタンス文書を解析したい場合は,parse2()メソッドを使用してください。
- 引数:
- is - インスタンス文書を含む入力ストリームを表すjava.io.InputStreamオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- 引数isにnullを指定した場合にスローされます。[エラーコード:20002]
(13) parse
public XBRLInstanceDocument parse(java.io.InputStream is,
java.lang.String systemId)
throws XBRLDOMException
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 指定した入力ストリームをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- XBRL2.0の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素である必要があります。解析対象のインスタンス文書のルート要素がXML文書のルート要素でない場合は,致命的エラーが発生します。
- XBRL2.1の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。ただし,XML文書中に複数のインスタンス文書が含まれている場合は,最初の一つだけが解析され,二つ目以降のインスタンス文書は解析されません。XML文書中に含まれるすべてのインスタンス文書を解析したい場合は,parse2()メソッドを使用してください。
- 引数:
- is - インスタンス文書を含む入力ストリームを表すjava.io.InputStreamオブジェクトを指定します。
- systemId - インスタンス文書のシステム識別子を指定します。システム識別子は,相対URIを解決するために使用されます。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- 引数isまたはsystemIdにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数systemIdに指定されたシステム識別子の形式が不正な場合にスローされます。[エラーコード:20147]
(14) parse
public XBRLInstanceDocument parse(java.io.File file)
throws XBRLDOMException
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 指定したファイルをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- XBRL2.0の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素である必要があります。解析対象のインスタンス文書のルート要素がXML文書のルート要素でない場合は,致命的エラーが発生します。
- XBRL2.1の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。ただし,XML文書中に複数のインスタンス文書が含まれている場合は,最初の一つだけが解析され,二つ目以降のインスタンス文書は解析されません。XML文書中に含まれるすべてのインスタンス文書を解析したい場合は,parse2()メソッドを使用してください。
- 引数:
- file - インスタンス文書を含むファイルを表すjava.io.Fileオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- 引数fileにnullを指定した場合にスローされます。[エラーコード:20002]
(15) parse
public XBRLInstanceDocument parse(java.lang.String uri)
throws XBRLDOMException
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 指定したURIをインスタンス文書として解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- XBRL2.0の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素である必要があります。解析対象のインスタンス文書のルート要素がXML文書のルート要素でない場合は,致命的エラーが発生します。
- XBRL2.1の場合:
解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。ただし,XML文書中に複数のインスタンス文書が含まれている場合は,最初の一つだけが解析され,二つ目以降のインスタンス文書は解析されません。XML文書中に含まれるすべてのインスタンス文書を解析したい場合は,parse2()メソッドを使用してください。
- 引数:
- uri - インスタンス文書の場所を示すURIを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- 引数uriにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数uriに指定されたURIの形式が不正な場合にスローされます。[エラーコード:20147]
(16) parse
public XBRLInstanceDocument parse(org.w3c.dom.Element instanceRoot)
throws XBRLDOMException
- XBRLのバージョン:
- 2.1
- 説明:
- 指定した要素をルート要素とするインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- このメソッドでインスタンス文書を解析する場合は,DOMツリーはすでに生成されているため,XMLプロセッサによる解析処理は実行されません。このため,このXBRLInstanceDocumentBuilderオブジェクトがインスタンス文書の解析時に妥当性の検証を行うように設定されている場合(isValidating()メソッドがtrueを返す場合)でも,XML Schemaによる妥当性の検証はされません。ただし,uCosminexus Business Reporting Processor独自の検証処理は実行されます。
- 引数:
- instanceRoot - インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を解析するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数instanceRootにnullを指定した場合にスローされます。[エラーコード:20002]
(17) parse
public XBRLInstanceDocument parse(org.w3c.dom.Element instanceRoot,
java.lang.String systemId)
throws XBRLDOMException
- XBRLのバージョン:
- 2.1
- 説明:
- 指定した要素をルート要素とするインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- このメソッドでインスタンス文書を解析する場合は,DOMツリーはすでに生成されているため,XMLプロセッサによる解析処理は実行されません。このため,このXBRLInstanceDocumentBuilderオブジェクトがインスタンス文書の解析時に妥当性の検証を行うように設定されている場合(isValidating()メソッドがtrueを返す場合)でも,XML Schemaによる妥当性の検証はされません。ただし,uCosminexus Business Reporting Processor独自の検証処理は実行されます。
- 引数:
- instanceRoot - インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトを指定します。
- systemId インスタンス文書のシステム識別子を指定します。システム識別子は,相対URIを解決するために使用されます。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を解析するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数instanceRootまたはsystemIdにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数systemIdに指定されたシステム識別子の形式が不正な場合にスローされます。[エラーコード:20147]
(18) parse2
public XBRLInstanceDocument[] parse2(org.xml.sax.InputSource is)
throws XBRLDOMException
- XBRLのバージョン:
- 2.1
- 説明:
- 指定した入力ソースに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- 解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。また,XML文書中に複数のインスタンス文書を含めることができます。XML文書中に複数のインスタンス文書が含まれている場合は,含まれているインスタンス文書をすべて解析してXBRLInstanceDocumentオブジェクトとして返します。ただし,XML文書中にインスタンス文書が一つも含まれていない場合は,致命的エラーが発生します。
- IDの一元管理
- このメソッドが複数のXBRLInstanceDocumentオブジェクトを返した場合,インスタンス文書に含まれるIDは,XBRLInstanceDocumentオブジェクトごとに別々のXBRLIdManagerオブジェクトで管理されます。つまり,XBRLInstanceDocument.getIdManager()メソッドが返すXBRLIdManagerオブジェクトは,XBRLInstanceDocumentオブジェクトごとに異なります。そのため,IDを一つのXBRLIdManagerオブジェクトで一元管理したい場合は,XBRLIdManager.registerDocument(XBRLInstanceDocument doc)メソッドを使用して,各XBRLInstanceDocumentオブジェクトを同じXBRLIdManagerオブジェクトへ登録する必要があります。
- 引数:
- is - インスタンス文書を含む入力ソースを表すorg.xml.sax.InputSourceオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトの配列を返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を解析するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数isにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数isに指定されたorg.xml.sax.InputSourceオブジェクトに設定されているシステム識別子の形式が不正な場合にスローされます。[エラーコード:20147]
(19) parse2
public XBRLInstanceDocument[] parse2(java.io.InputStream is)
throws XBRLDOMException
- XBRLのバージョン:
- 2.1
- 説明:
- 指定した入力ストリームに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- 解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。また,XML文書中に複数のインスタンス文書を含めることができます。XML文書中に複数のインスタンス文書が含まれている場合は,含まれているインスタンス文書をすべて解析してXBRLInstanceDocumentオブジェクトとして返します。ただし,XML文書中にインスタンス文書が一つも含まれていない場合は,致命的エラーが発生します。
- IDの一元管理
- このメソッドが複数のXBRLInstanceDocumentオブジェクトを返した場合,インスタンス文書に含まれるIDは,XBRLInstanceDocumentオブジェクトごとに別々のXBRLIdManagerオブジェクトで管理されます。つまり,XBRLInstanceDocument.getIdManager()メソッドが返すXBRLIdManagerオブジェクトは,XBRLInstanceDocumentオブジェクトごとに異なります。そのため,IDを一つのXBRLIdManagerオブジェクトで一元管理したい場合は,XBRLIdManager.registerDocument(XBRLInstanceDocument doc)メソッドを使用して,各XBRLInstanceDocumentオブジェクトを同じXBRLIdManagerオブジェクトへ登録する必要があります。
- 引数:
- is - インスタンス文書を含む入力ストリームを表すjava.io.InputStreamオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトの配列を返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を解析するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数isにnullを指定した場合にスローされます。[エラーコード:20002]
(20) parse2
public XBRLInstanceDocument[] parse2(java.io.InputStream is,
java.lang.String systemId)
throws XBRLDOMException
- XBRLのバージョン:
- 2.1
- 説明:
- 指定した入力ストリームに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- 解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。また,XML文書中に複数のインスタンス文書を含めることができます。XML文書中に複数のインスタンス文書が含まれている場合は,含まれているインスタンス文書をすべて解析してXBRLInstanceDocumentオブジェクトとして返します。ただし,XML文書中にインスタンス文書が一つも含まれていない場合は,致命的エラーが発生します。
- IDの一元管理
- このメソッドが複数のXBRLInstanceDocumentオブジェクトを返した場合,インスタンス文書に含まれるIDは,XBRLInstanceDocumentオブジェクトごとに別々のXBRLIdManagerオブジェクトで管理されます。つまり,XBRLInstanceDocument.getIdManager()メソッドが返すXBRLIdManagerオブジェクトは,XBRLInstanceDocumentオブジェクトごとに異なります。そのため,IDを一つのXBRLIdManagerオブジェクトで一元管理したい場合は,XBRLIdManager.registerDocument(XBRLInstanceDocument doc)メソッドを使用して,各XBRLInstanceDocumentオブジェクトを同じXBRLIdManagerオブジェクトへ登録する必要があります。
- 引数:
- is - インスタンス文書を含む入力ストリームを表すjava.io.InputStreamオブジェクトを指定します。
- systemId - インスタンス文書を含むXML文書のシステム識別子を指定します。システム識別子は,相対URIを解決するために使用されます。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトの配列を返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を解析するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数isまたはsystemIdにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数systemIdに指定されたシステム識別子の形式が不正な場合にスローされます。[エラーコード:20147]
(21) parse2
public XBRLInstanceDocument[] parse2(java.io.File file)
throws XBRLDOMException
- XBRLのバージョン:
- 2.1
- 説明:
- 指定したファイルに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- 解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。また,XML文書中に複数のインスタンス文書を含めることができます。XML文書中に複数のインスタンス文書が含まれている場合は,含まれているインスタンス文書をすべて解析してXBRLInstanceDocumentオブジェクトとして返します。ただし,XML文書中にインスタンス文書が一つも含まれていない場合は,致命的エラーが発生します。
- IDの一元管理
- このメソッドが複数のXBRLInstanceDocumentオブジェクトを返した場合,インスタンス文書に含まれるIDは,XBRLInstanceDocumentオブジェクトごとに別々のXBRLIdManagerオブジェクトで管理されます。つまり,XBRLInstanceDocument.getIdManager()メソッドが返すXBRLIdManagerオブジェクトは,XBRLInstanceDocumentオブジェクトごとに異なります。そのため,IDを一つのXBRLIdManagerオブジェクトで一元管理したい場合は,XBRLIdManager.registerDocument(XBRLInstanceDocument doc)メソッドを使用して,各XBRLInstanceDocumentオブジェクトを同じXBRLIdManagerオブジェクトへ登録する必要があります。
- 引数:
- file - インスタンス文書を含むファイルを表すjava.io.Fileオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトの配列を返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を解析するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数fileにnullを指定した場合にスローされます。[エラーコード:20002]
(22) parse2
public XBRLInstanceDocument[] parse2(java.lang.String uri)
throws XBRLDOMException
- XBRLのバージョン:
- 2.1
- 説明:
- 指定したURIに含まれる複数のインスタンス文書を解析し,XBRLInstanceDocumentオブジェクトを新規に生成します。
- 解析対象のインスタンス文書のルート要素は,XML文書のルート要素でなくてもかまいません。また,XML文書中に複数のインスタンス文書を含めることができます。XML文書中に複数のインスタンス文書が含まれている場合は,含まれているインスタンス文書をすべて解析してXBRLInstanceDocumentオブジェクトとして返します。ただし,XML文書中にインスタンス文書が一つも含まれていない場合は,致命的エラーが発生します。
- IDの一元管理
- このメソッドが複数のXBRLInstanceDocumentオブジェクトを返した場合,インスタンス文書に含まれるIDは,XBRLInstanceDocumentオブジェクトごとに別々のXBRLIdManagerオブジェクトで管理されます。つまり,XBRLInstanceDocument.getIdManager()メソッドが返すXBRLIdManagerオブジェクトは,XBRLInstanceDocumentオブジェクトごとに異なります。そのため,IDを一つのXBRLIdManagerオブジェクトで一元管理したい場合は,XBRLIdManager.registerDocument(XBRLInstanceDocument doc)メソッドを使用して,各XBRLInstanceDocumentオブジェクトを同じXBRLIdManagerオブジェクトへ登録する必要があります。
- 引数:
- uri - インスタンス文書を含むXML文書の場所を示すURIを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトの配列を返します。
- 例外:
- XBRLDOMException -
- インスタンス文書の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる※]
注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を解析するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数uriにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数uriに指定されたURIの形式が不正な場合にスローされます。[エラーコード:20147]
(23) newInstanceDocument
public XBRLInstanceDocument newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。
- 生成されたXBRLInstanceDocumentオブジェクトに対応するorg.w3c.dom.Documentオブジェクトが新規に作成されます。また,インスタンス文書のルート要素がXML文書のルート要素として設定されます。
- XBRL2.1の場合:出発点となったタクソノミー本体およびリンクベースの追加
- このメソッドを使用して新規にインスタンス文書を生成した場合は,引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトを構築する際の出発点となったタクソノミー本体およびリンクベースのリストをXBRLTaxonomyDocument.getStartingPoints()メソッドを使用して取得し,出発点となったタクソノミー本体およびリンクベースを指す<link:schemaRef>要素および<link:linkbaseRef>要素をインスタンス文書に追加する必要があります。このとき,各要素のxlink:href属性に指定するURIは,絶対URI,相対URIのどちらでもかまいません。ただし,インスタンス文書をストリームへ出力してから再度読み込んだ際に,xlink:href属性のURIを適切な文書に解決できる必要があります。なお,必要な<link:schemaRef>要素および<link:linkbaseRef>要素を追加しなかった場合は,インスタンス文書をストリームへ出力してから再度読み込んだ際に,タクソノミー文書を構成するタクソノミー本体またはリンクベースに不足が生じるおそれがあるため,注意してください。
- 引数:
- taxonomyDocument -タクソノミー文書を表すXBRLTaxonomyDocumentオブジェクトを指定します。生成されるXBRLInstanceDocumentオブジェクトは,このXBRLTaxonomyDocumentオブジェクトの複製を参照します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- 引数taxonomyDocumentにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトを所有するXBRLDocumentManagerオブジェクトが,このXBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトと異なる場合にスローされます。[エラーコード:20051]
- 引数taxonomyDocumentに指定されたXBRLTaxonomyDocumentオブジェクトが準拠するXBRLのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRLのバージョンが異なる場合にスローされます。[エラーコード:20103]
- 引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトが準拠するXBRL Dimensionsのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRL Dimensionsのバージョンが異なる場合にスローされます。[エラーコード:22103]
(24) newInstanceDocument
public XBRLInstanceDocument newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument,
java.lang.String systemId)
- XBRLのバージョン:
- 2.1
- 説明:
- 空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。
- 生成されたXBRLInstanceDocumentオブジェクトに対応するorg.w3c.dom.Documentオブジェクトが新規に作成されます。また,インスタンス文書のルート要素がXML文書のルート要素として設定されます。
- 出発点となったタクソノミー本体およびリンクベースの追加
- このメソッドを使用して新規にインスタンス文書を生成した場合は,引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトを構築する際の出発点となったタクソノミー本体およびリンクベースのリストをXBRLTaxonomyDocument.getStartingPoints()メソッドを使用して取得し,出発点となったタクソノミー本体およびリンクベースを指す<link:schemaRef>要素および<link:linkbaseRef>要素をインスタンス文書に追加する必要があります。このとき,各要素のxlink:href属性に指定するURIは,絶対URI,相対URIのどちらでもかまいません。ただし,インスタンス文書をストリームへ出力してから再度読み込んだ際に,xlink:href属性のURIを適切な文書に解決できる必要があります。なお,必要な<link:schemaRef>要素および<link:linkbaseRef>要素を追加しなかった場合は,インスタンス文書をストリームへ出力してから再度読み込んだ際に,タクソノミー文書を構成するタクソノミー本体またはリンクベースに不足が生じるおそれがあるため,注意してください。
- 引数:
- taxonomyDocument - タクソノミー文書を表すXBRLTaxonomyDocumentオブジェクトを指定します。生成されるXBRLInstanceDocumentオブジェクトは,このXBRLTaxonomyDocumentオブジェクトの複製を参照します。
- systemId - インスタンス文書のシステム識別子を指定します。システム識別子は,相対URIを解決するために使用されます。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を作成するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数taxonomyDocumentまたはsystemIdにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数taxonomyDocumentに指定されたXBRLTaxonomyDocumentオブジェクトを所有するXBRLDocumentManagerオブジェクトが,このXBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトと異なる場合にスローされます。[エラーコード:20051]
- 引数taxonomyDocumentに指定されたXBRLTaxonomyDocumentオブジェクトが準拠するXBRLのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRLのバージョンが異なる場合にスローされます。[エラーコード:20103]
- 引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトが準拠するXBRL Dimensionsのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRL Dimensionsのバージョンが異なる場合にスローされます。[エラーコード:22103]
- 引数systemIdに指定されたシステム識別子の形式が不正な場合にスローされます。[エラーコード:20147]
(25) newInstanceDocument
public XBRLInstanceDocument newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument,
org.w3c.dom.Document w3cdomDocument)
- XBRLのバージョン:
- 2.1
- 説明:
- XML文書の任意の位置にインスタンス文書を追加する場合に使用します。空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。
- ルート要素の挿入
- 生成されたXBRLInstanceDocumentオブジェクトのルート要素は,生成直後はDOMツリーにつながっていません。そのため,ユーザーアプリケーションでは,W3C DOMのAPIを使用して,生成されたインスタンス文書のルート要素を,引数w3cdomDocumentに指定したXML文書の任意の位置へ挿入する必要があります。ただし,同一XML文書中に記述されているほかのインスタンス文書の中に挿入しないでください。インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトは,XBRLInstanceDocument.getInstanceRoot()メソッドを使用して取得できます。
- 出発点となったタクソノミー本体およびリンクベースの追加
- このメソッドを使用して新規にインスタンス文書を生成した場合は,引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトを構築する際の出発点となったタクソノミー本体およびリンクベースのリストをXBRLTaxonomyDocument.getStartingPoints()メソッドを使用して取得し,出発点となったタクソノミー本体およびリンクベースを指す<link:schemaRef>要素および<link:linkbaseRef>要素をインスタンス文書に追加する必要があります。このとき,各要素のxlink:href属性に指定するURIは,絶対URI,相対URIのどちらでもかまいません。ただし,インスタンス文書をストリームへ出力してから再度読み込んだ際に,xlink:href属性のURIを適切な文書に解決できる必要があります。なお,必要な<link:schemaRef>要素および<link:linkbaseRef>要素を追加しなかった場合は,インスタンス文書をストリームへ出力してから再度読み込んだ際に,タクソノミー文書を構成するタクソノミー本体またはリンクベースに不足が生じるおそれがあるため,注意してください。
- 引数:
- taxonomyDocument - タクソノミー文書を表すXBRLTaxonomyDocumentオブジェクトを指定します。生成されるXBRLInstanceDocumentオブジェクトは,このXBRLTaxonomyDocumentオブジェクトの複製を参照します。
- w3cdomDocument - インスタンス文書を挿入したいXML文書を表すorg.w3c.dom.Documentオブジェクトを指定します。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を作成するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数taxonomyDocumentまたはw3cdomDocumentにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数taxonomyDocumentに指定されたXBRLTaxonomyDocumentオブジェクトを所有するXBRLDocumentManagerオブジェクトが,このXBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトと異なる場合にスローされます。[エラーコード:20051]
- 引数taxonomyDocumentに指定されたXBRLTaxonomyDocumentオブジェクトが準拠するXBRLのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRLのバージョンが異なる場合にスローされます。[エラーコード:20103]
- 引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトが準拠するXBRL Dimensionsのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRL Dimensionsのバージョンが異なる場合にスローされます。[エラーコード:22103]
(26) newInstanceDocument
public XBRLInstanceDocument newInstanceDocument(XBRLTaxonomyDocument taxonomyDocument,
org.w3c.dom.Document w3cdomDocument,
java.lang.String systemId)
- XBRLのバージョン:
- 2.1
- 説明:
- XML文書の任意の位置にインスタンス文書を追加する場合に使用します。空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを新規に生成します。
- ルート要素の挿入
- 生成されたXBRLInstanceDocumentオブジェクトのルート要素は,生成直後はDOMツリーにつながっていません。そのため,ユーザーアプリケーションでは,W3C DOMのAPIを使用して,生成されたインスタンス文書のルート要素を,引数w3cdomDocumentに指定したXML文書の任意の位置へ挿入する必要があります。ただし,同一XML文書中に記述されているほかのインスタンス文書の中に挿入しないでください。インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトは,XBRLInstanceDocument.getInstanceRoot()メソッドを使用して取得できます。
- 出発点となったタクソノミー本体およびリンクベースの追加
- このメソッドを使用して新規にインスタンス文書を生成した場合は,引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトを構築する際の出発点となったタクソノミー本体およびリンクベースのリストをXBRLTaxonomyDocument.getStartingPoints()メソッドを使用して取得し,出発点となったタクソノミー本体およびリンクベースを指す<link:schemaRef>要素および<link:linkbaseRef>要素をインスタンス文書に追加する必要があります。このとき,各要素のxlink:href属性に指定するURIは,絶対URI,相対URIのどちらでもかまいません。ただし,インスタンス文書をストリームへ出力してから再度読み込んだ際に,xlink:href属性のURIを適切な文書に解決できる必要があります。なお,必要な<link:schemaRef>要素および<link:linkbaseRef>要素を追加しなかった場合は,インスタンス文書をストリームへ出力してから再度読み込んだ際に,タクソノミー文書を構成するタクソノミー本体またはリンクベースに不足が生じるおそれがあるため,注意してください。
- 引数:
- taxonomyDocument - タクソノミー文書を表すXBRLTaxonomyDocumentオブジェクトを指定します。生成されるXBRLInstanceDocumentオブジェクトは,このXBRLTaxonomyDocumentオブジェクトの複製を参照します。
- w3cdomDocument - インスタンス文書を挿入したいXML文書を表すorg.w3c.dom.Documentオブジェクトを指定します。
- systemId - インスタンス文書のシステム識別子を指定します。システム識別子は,相対URIを解決するために使用されます。
- 戻り値:
- 新しく生成されたXBRLInstanceDocumentオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- このXBRLInstanceDocumentBuilderオブジェクトが,バージョンが2.1であるXBRL仕様に準拠したインスタンス文書を作成するように設定されていない場合にスローされます。[エラーコード:20101]
- 引数taxonomyDocument,w3cdomDocument,またはsystemIdにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数taxonomyDocumentに指定されたXBRLTaxonomyDocumentオブジェクトを所有するXBRLDocumentManagerオブジェクトが,このXBRLInstanceDocumentBuilderオブジェクトを所有するXBRLDocumentManagerオブジェクトと異なる場合にスローされます。[エラーコード:20051]
- 引数taxonomyDocumentに指定されたXBRLTaxonomyDocumentオブジェクトが準拠するXBRLのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRLのバージョンが異なる場合にスローされます。[エラーコード:20103]
- 引数taxonomyDocumentに指定したXBRLTaxonomyDocumentオブジェクトが準拠するXBRL Dimensionsのバージョンと,このXBRLInstanceDocumentBuilderオブジェクトが処理対象とするXBRL Dimensionsのバージョンが異なる場合にスローされます。[エラーコード:22103]
- 引数systemIdに指定されたシステム識別子の形式が不正な場合にスローされます。[エラーコード:20147]
(27) getDimensionsVersion
public int getDimensionsVersion()
- XBRLのバージョン:
- 2.1
- 説明:
- XBRLInstanceDocumentBuilderオブジェクトが,どのバージョンのXBRL Dimensionsに準拠しているインスタンス文書を解析,または作成するのかを取得します。このメソッドが返す値は,XBRLInstanceDocumentBuilderオブジェクトがインスタンス文書を解析,または作成する際に使用するcbrp.parse.DimensionsVersionプロパティの値です。
- XBRLInstanceDocumentBuilderオブジェクトが使用するcbrp.parse.DimensionsVersionプロパティの値は,XBRLInstanceDocumentBuilderオブジェクトを生成したXBRLInstanceDocumentBuilderFactoryオブジェクトのsetDimensionsVersion(int version)メソッド,またはsetProperty(java.lang.String name, java.lang.Object value)メソッドで設定した値です。XBRLInstanceDocumentBuilderFactoryオブジェクトで値が設定されなかった場合は,XBRL DOM初期化時の値を使用します。XBRL DOM初期化時の値については,「6.6.9(15) setProperty」の説明を参照してください。
- なお,cbrp.parse.DimensionsVersionプロパティの値は,インスタンス文書がXBRL2.1に準拠している場合だけ使用されます。インスタンス文書がほかのXBRLのバージョンに準拠している場合は,cbrp.parse.DimensionsVersionプロパティの値は使用されません。
- 戻り値:
- XBRL Dimensions1.0に準拠したインスタンス文書を解析または作成する場合は,XBRLConstants.DIMENSIONS_1_0を返します。
- XBRL Dimensions1.0に準拠したインスタンス文書を解析または作成しない場合は,XBRLConstants.DIMENSIONS_NONEを返します。
(28) setCreatingSchemaLocations
public void setCreatingSchemaLocations(boolean creating)
- XBRLのバージョン:
- 2.1
- 説明:
- XBRLInstanceDocumentBuilderでXBRL2.1に準拠した空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを生成するときに,ルート要素のxsi:schemaLocation属性の初期値としてタクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組を設定するかどうかを指定します。デフォルト値はtrueです。
- XBRL2.0に準拠したインスタンス文書を作成する場合はこの設定値は無視され,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組を設定します。
- 引数:
- creating - XBRL2.1に準拠した空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを生成するときに,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組を設定する場合はtrue,設定しない場合はfalseを指定します。
(29) isCreatingSchemaLocations
public boolean isCreatingSchemaLocations()
- XBRLのバージョン:
- 2.1
- 説明:
- XBRLInstanceDocumentBuilderでXBRL2.1に準拠した空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを生成するときに,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組を設定するかどうかを示します。
- 戻り値:
- XBRL2.1に準拠した空のインスタンス文書を表すXBRLInstanceDocumentオブジェクトを生成するときに,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組を設定する場合はtrue,設定しない場合はfalseを返します。