6.6.7 XBRLInstanceDocumentインターフェース

public interface XBRLInstanceDocument
extends XBRLInstanceNode

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書全体を表します。
既存のインスタンス文書を読み込んでXBRLInstanceDocumentオブジェクトを作成する場合は,XBRLInstanceDocumentBuilderのparse()メソッドを使用します。また,インスタンス文書を新規に作成する場合は,XBRLInstanceDocumentBuilderのnewInstanceDocument()メソッドを使用してXBRLInstanceDocumentオブジェクトを生成します。
名前空間宣言
XBRLInstanceDocumentオブジェクトでは,XBRLNamespaceDeclarationオブジェクトを使用して,インスタンス文書に記述される名前空間宣言を管理します。XBRLInstanceDocumentオブジェクトに設定された名前空間宣言は,getNamespaceDeclarations()などのメソッドを使用して取得できます。
既存のインスタンス文書を編集する場合の名前空間宣言
既存のインスタンス文書からXBRLInstanceDocumentオブジェクトを生成した場合は,XBRLInstanceDocumentオブジェクトは,そのインスタンス文書に記述されていた名前空間宣言のリストを保持します。
このとき,同一の名前空間URIに対して複数の名前空間宣言が記述されていた場合は,そのうちの一つだけが保持され,そのほかの名前空間宣言は無視されます。また,同一の名前空間接頭辞に複数の名前空間URIが関連づけられていた場合は,名前空間接頭辞を自動的に生成することで,複数の名前空間URIに対して同一の名前空間接頭辞が重複して関連づけられることがないようにします。
既存のインスタンス文書からXBRLInstanceDocumentオブジェクトを生成したあとに,ユーザーアプリケーションが特定の編集操作を実行すると,XBRLInstanceDocumentオブジェクトに設定されている名前空間宣言に合わせてインスタンス文書中のXML要素やグローバル属性の名前空間接頭辞を変更する処理が実行されます。これを名前空間の正規化と呼びます。名前空間の正規化では,ルート要素以外のXML要素から名前空間宣言を削除します。既存のインスタンス文書からの名前空間宣言の読み込み,および名前空間の正規化に関する詳細については,「3.4 名前空間の正規化」を参照してください。
新規にインスタンス文書を作成する場合の名前空間宣言
XBRLInstanceDocumentBuilderのnewInstanceDocument()メソッドを使用してXBRLInstanceDocumentオブジェクトを生成した場合は,初期状態で標準的な名前空間の宣言が設定されます。初期状態で設定されている名前空間宣言を次の表に示します。

表6-22 インスタンス文書の新規作成時に初期状態で設定される名前空間宣言(XBRL2.0の場合)

項番名前空間接頭辞名前空間URI
1xbrlihttp://www.xbrl.org/2001/instance
2linkhttp://www.xbrl.org/2001/XLink/xbrllinkbase
3xlinkhttp://www.w3.org/1999/xlink
4xsihttp://www.w3.org/2001/XMLSchema-instance
5xhtmlhttp://www.w3.org/1999/xhtml

表6-23 インスタンス文書の新規作成時に初期状態で設定される名前空間宣言(XBRL2.1の場合)

項番名前空間接頭辞名前空間URI
1なし空文字列("")
2xbrlihttp://www.xbrl.org/2003/instance
3linkhttp://www.xbrl.org/2003/linkbase
4iso4217http://www.xbrl.org/2003/iso4217
5xlinkhttp://www.w3.org/1999/xlink
6xsihttp://www.w3.org/2001/XMLSchema-instance
7xhtmlhttp://www.w3.org/1999/xhtml
8xbrldihttp://xbrl.org/2006/xbrldi

注※ XBRL Dimensions1.0に対応している場合だけ存在します。


名前空間宣言の追加および接頭辞の変更は,addNamespaceDeclaration()メソッドを使用します。次の操作をした際に,XBRLNamespaceDeclarationオブジェクトを使用して名前空間宣言を設定していないとエラーが発生します。このため,インスタンス文書で使用するすべての名前空間について,addNamespaceDeclaration()メソッドを使用して,必ず名前空間宣言を追加してください。
  • XBRLInstanceDocumentのcreateItem()などのメソッドを使用してXML要素に対応するノードを生成する際に,そのXML要素が属する名前空間に対応する名前空間宣言が設定されていない場合にエラーが発生します。
  • XBRLInstanceItemのsetValue()メソッドまたはsetString()メソッドを使用して,xsd:QName型またはxsd:NOTATION型のアイテムに値を設定する際に,そのxsd:QName型データまたはxsd:NOTATION型データの名前空間に対応する名前空間宣言が設定されていない場合にエラーが発生します。
  • XBRLInstanceDocumentのaddFootnote()メソッドやXBRLInstanceElementのaddFootnote()メソッドなどで脚注を操作する際に,脚注リンクを生成するために必要な名前空間URI(http://www.xbrl.org/2001/XLink/xbrllinkbaseおよびhttp://www.w3.org/1999/xlink)の名前空間宣言が設定されていない場合にエラーが発生します。
XBRL2.1の場合:名前空間に属さない要素や修飾名を使用する場合の注意事項
インスタンス文書を編集した結果,次の三つの状態がすべて重なってしまった場合,インスタンス文書をストリームへ出力してから再度読み込むと,名前空間に属していなかった要素や修飾名がデフォルトの名前空間に属するように変更されてしまうおそれがあります。
  • 名前空間に属さない要素や修飾名が,インスタンス文書中に存在する
  • インスタンス文書のルート要素が,XML文書のルート要素ではない
  • インスタンス文書のルート要素の祖先要素に,デフォルトの名前空間の宣言が存在する
このような問題を回避するために,XBRLInstanceDocumentオブジェクト生成時には,デフォルトの名前空間を解除する宣言(xmlns="")がXBRLInstanceDocumentオブジェクトに追加されます。デフォルトの名前空間を解除する宣言が追加されていると,祖先要素で宣言されているデフォルトの名前空間はインスタンス文書中では無効となるため,名前空間に属さない要素や修飾名は再度読み込んだ際にも名前空間に属さないままとなり,前述の問題は発生しません。しかし,デフォルトの名前空間を解除する宣言を明示的に削除した場合や,既存のインスタンス文書でデフォルトの名前空間が宣言されていた場合は,デフォルトの名前空間を解除する宣言が追加されていない状態となるため,前述の問題が顕在化するおそれがあります。
このため,デフォルトの名前空間を解除する宣言を削除することは推奨しません。また,名前空間に属さない要素や修飾名をインスタンス文書中で使用する場合は,デフォルトの名前空間を解除する宣言をXBRLInstanceDocumentオブジェクトへ追加しておくことを推奨します。
デフォルトの名前空間を解除する宣言は,次に示すコードによってXBRLInstanceDocumentオブジェクトへ追加できます。
idoc.addNamespaceDeclaration(new XBRLNamespaceDeclaration(null, ""));
xsi:schemaLocation属性
XBRLInstanceDocumentオブジェクトでは,XBRLSchemaLocationオブジェクトを使用してインスタンス文書のルート要素のxsi:schemaLocation属性の内容を管理します。
既存のインスタンス文書を編集する場合のxsi:schemaLocation属性
既存のインスタンス文書からXBRLInstanceDocumentオブジェクトを生成した場合,XBRLInstanceDocumentオブジェクトは,そのインスタンス文書のルート要素のxsi:schemaLocation属性を読み取り,名前空間URIとスキーマ文書の位置を示すURIの組のリストを保持します。
インスタンス文書を新規に作成する場合のxsi:schemaLocation属性
XBRLInstanceDocumentBuilder.newInstanceDocument(XBRLTaxonomyDocument)などのメソッドを使用してXBRLInstanceDocumentオブジェクトを生成した場合には,ルート要素のxsi:schemaLocation属性の初期値としてタクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組が設定されます。xsi:schemaLocation属性の内容は,addSchemaLocation()メソッドやremoveSchemaLocation()メソッドを使用して内容の追加・変更・削除ができるため,必要な場合にはこれらのメソッドを使用してxsi:schemaLocation属性の内容を適切に設定してください。
また,XBRL2.1の場合,タクソノミー文書に対象名前空間URIが同じであるタクソノミー本体が複数含まれる場合があります。XBRLInstanceDocumentBuilder.newInstanceDocument(XBRLTaxonomyDocument)などのメソッドを使用してXBRLInstanceDocumentオブジェクトを生成した際に,複数のタクソノミー本体で対象名前空間URIが重複している場合は,タクソノミー文書の解析で先に解析されたタクソノミー本体が優先され,ほかのタクソノミー本体は無視されます。
なお,uCosminexus Business Reporting Processorのバージョンが05-00以降の場合に,XBRLInstanceDocumentBuilderインターフェースのisCreatingSchemaLocations()メソッドが返す値がtrueのときは,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組が設定されます。isCreatingSchemaLocations()メソッドが返す値がfalseのときは,ルート要素のxsi:schemaLocation属性の初期値として,タクソノミー文書に含まれる各タクソノミー本体の対象名前空間URIと位置を示す絶対URIの組が設定されません。
メソッドの概要:
XBRLInstanceDocumentインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョンXBRL Dimensionsのバージョン
1XBRLDocumentManagergetOwnerDocumentManager()
  インスタンス文書を所有するXBRLDocumentManagerオブジェクトを取得します。
2.0および2.1該当しない
2intgetXBRLVersion()
  インスタンス文書が準拠しているXBRLのバージョンを取得します。
2.0および2.1該当しない
3PTVInstancegetPTVInstance()
  インスタンス文書の解析時に生成されたPTVIを取得します。
2.1該当しない
4XBRLIdManagergetIdManager()
  インスタンス文書のIDを管理するXBRLIdManagerオブジェクトを取得します。
2.1該当しない
5XBRLTaxonomyDocumentgetTaxonomyDocument()
  インスタンス文書が参照するタクソノミー文書を取得します。
2.0および2.1該当しない
6org.w3c.dom.ElementgetInstanceRoot()
  インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトを取得します。
2.0および2.1該当しない
7java.util.List<XBRLNamespaceDeclaration>getNamespaceDeclarations()
  インスタンス文書に記述されている名前空間宣言のリストを取得します。
2.0および2.1該当しない
8XBRLNamespaceDeclarationgetNamespaceDeclarationByURI(java.lang.String uri)
  指定した名前空間URIの名前空間宣言を取得します。
2.0および2.1該当しない
9XBRLNamespaceDeclarationgetNamespaceDeclarationByPrefix(java.lang.String prefix)
  指定した名前空間接頭辞の名前空間宣言を取得します。
2.0および2.1該当しない
10XBRLNamespaceDeclarationaddNamespaceDeclaration(XBRLNamespaceDeclaration newNamespaceDeclaration)
  インスタンス文書のルート要素に名前空間宣言を追加します。
2.0および2.1該当しない
11XBRLNamespaceDeclarationremoveNamespaceDeclaration(XBRLNamespaceDeclaration oldNamespaceDeclaration)
  インスタンス文書から名前空間宣言を削除します。
2.0および2.1該当しない
12java.util.List<XBRLSchemaLocation>getSchemaLocations()
  インスタンス文書のルート要素のxsi:schemaLocation属性に記述されている名前空間URIと,スキーマ文書の位置を示すURIの組を表すオブジェクトのリストを取得します。
2.0および2.1該当しない
13XBRLSchemaLocationgetSchemaLocation(java.lang.String namespaceURI)
  インスタンス文書のルート要素のxsi:schemaLocation属性に記述されている名前空間URIと,スキーマ文書の位置を示すURIの組を表すオブジェクトのリストの中から,指定した名前空間URIのオブジェクトを取得します。
2.0および2.1該当しない
14XBRLSchemaLocationaddSchemaLocation(XBRLSchemaLocation newSchemaLocation)
  インスタンス文書のルート要素のxsi:schemaLocation属性に,名前空間URIとスキーマ文書の位置を示すURIの組を追加します。
2.0および2.1該当しない
15XBRLSchemaLocationremoveSchemaLocation(XBRLSchemaLocation oldSchemaLocation)
  インスタンス文書のルート要素のxsi:schemaLocation属性から,指定された名前空間URIとスキーマ文書の位置を示すURIの組を削除します。
2.0および2.1該当しない
16java.lang.StringgetBase()
  インスタンス文書のルート要素のxml:base属性の値を取得します。
2.1該当しない
17voidsetBase(java.lang.String base)
  インスタンス文書のルート要素のxml:base属性の値を設定します。
2.1該当しない
18java.lang.StringgetId()
  インスタンス文書のルート要素のid属性の値を取得します。
2.1該当しない
19voidsetId(java.lang.String id)
  インスタンス文書のルート要素のid属性の値を設定します。
2.1該当しない
20java.util.List<XBRLSchemaRef>getSchemaRefs()
  インスタンス文書に記述されている<link:schemaRef>要素のリストを取得します。
2.1該当しない
21XBRLSchemaRefaddSchemaRef(XBRLSchemaRef newSchemaRef)
  インスタンス文書に<link:schemaRef>要素を追加します。
2.1該当しない
22XBRLSchemaRefcreateSchemaRef(java.lang.String href, java.lang.String base)
  <link:schemaRef>要素を表すXBRLSchemaRefオブジェクトを新規に生成します。
2.1該当しない
23java.util.List<XBRLLinkbaseRef>getLinkbaseRefs()
  インスタンス文書に記述されている<link:linkbaseRef>要素のリストを取得します。
2.0および2.1該当しない
24java.util.List<XBRLLinkbaseRef>getLinkbaseRefs(java.lang.String role)
  インスタンス文書に記述されている<link:linkbaseRef>要素のうち,引数roleと同じ値のxlink:role属性を持つ<link:linkbaseRef>要素のリストを取得します。
2.0および2.1該当しない
25XBRLLinkbaseRefaddLinkbaseRef(XBRLLinkbaseRef newLinkbaseRef)
  インスタンス文書に<link:linkbaseRef>要素を追加します。
2.0および2.1該当しない
26XBRLLinkbaseRefremoveLinkbaseRef(XBRLLinkbaseRef oldLinkbaseRef)
  インスタンス文書に記述されている<link:linkbaseRef>要素を削除します。
2.0該当しない
27XBRLLinkbaseRefcreateLinkbaseRef(java.lang.String role, java.lang.String href)
  <link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを新規に生成します。
2.0および2.1該当しない
28XBRLLinkbaseRefcreateLinkbaseRef(java.lang.String role, java.lang.String href, java.lang.String base)
  <link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを新規に生成します。
2.1該当しない
29java.util.List<XBRLRoleRef>getRoleRefs()
  インスタンス文書に記述されている<link:roleRef>要素のリストを取得します。
2.1該当しない
30XBRLRoleRefgetRoleRef(java.lang.String roleURI)
  インスタンス文書に記述されている<link:roleRef>要素のうち,指定したroleURIと同じ値のroleURI属性を持つ<link:roleRef>要素を取得します。
2.1該当しない
31XBRLRoleRefaddRoleRef(XBRLRoleRef newRoleRef)
  インスタンス文書に<link:roleRef>要素を追加します。
2.1該当しない
32XBRLRoleRefcreateRoleRef(java.lang.String href, java.lang.String roleURI, java.lang.String base)
  <link:roleRef>要素であるXBRLRoleRefオブジェクトを新規に生成します。
2.1該当しない
33java.util.List<XBRLArcroleRef>getArcroleRefs()
  インスタンス文書に記述されている<link:arcroleRef>要素のリストを取得します。
2.1該当しない
34XBRLArcroleRefgetArcroleRef(java.lang.String arcroleURI)
  インスタンス文書に記述されている<link:arcroleRef>要素のうち,引数arcroleURIと同じ値のarcroleURI属性を持つ<link:arcroleRef>要素を取得します。
2.1該当しない
35XBRLArcroleRefaddArcroleRef(XBRLArcroleRef newArcroleRef)
  インスタンス文書に<link:arcroleRef>要素を追加します。
2.1該当しない
36XBRLArcroleRefcreateArcroleRef(java.lang.String href, java.lang.String arcroleURI, java.lang.String base)
  <link:arcroleRef>要素であるXBRLArcroleRefオブジェクトを新規に生成します。
2.1該当しない
37java.util.List<XBRLContext>getContexts()
  インスタンス文書に記述されているコンテキスト要素のリストを取得します。
2.0および2.1該当しない
38XBRLContextaddContext(XBRLContext newContext)
  インスタンス文書にコンテキスト要素を追加します。
2.0および2.1該当しない
39XBRLContextremoveContext(XBRLContext oldContext)
  インスタンス文書からコンテキスト要素を削除します。
2.0および2.1該当しない
40XBRLNumericContextcreateNumericContext(XBRLEntity entity, XBRLPeriod period, XBRLUnit unit, XBRLScenario scenario, int precision, boolean cwa)
  数値コンテキスト要素を新規に生成します。
2.0該当しない
41XBRLNonNumericContextcreateNonNumericContext(XBRLEntity entity, XBRLPeriod period, XBRLUnit unit, XBRLScenario scenario)
  非数値コンテキスト要素を新規に生成します。
2.0該当しない
42XBRLContext2createContext(XBRLEntity entity, XBRLPeriod period, XBRLScenario scenario)
  コンテキスト要素を新規に生成します。
2.1該当しない
43java.util.List<XBRLUnit2>getUnits()
  インスタンス文書に記述されている単位要素のリストを取得します。
2.1該当しない
44XBRLUnit2addUnit(XBRLUnit2 newUnit)
  インスタンス文書に単位要素を追加します。
2.1該当しない
45XBRLUnit2removeUnit(XBRLUnit2 oldUnit)
  インスタンス文書から単位要素を削除します。
2.1該当しない
46XBRLUnit2createUnit(XBRLQName[] measures)
  単位要素であるXBRLUnit2オブジェクトを新規に生成します。
2.1該当しない
47XBRLUnit2createUnit(XBRLQName[] numerator, XBRLQName[] denominator)
  分数を指定して,単位要素であるXBRLUnit2オブジェクトを新規に生成します。
2.1該当しない
48java.util.List<XBRLInstanceElement>getChildElements()
  インスタンス文書のルート要素の子要素のリストを取得します。
2.0および2.1該当しない
49java.util.List<XBRLInstanceElement>getChildElements(java.lang.String namespaceURI, java.lang.String name)
  インスタンス文書のルート要素の子要素のうち,指定した名前を持つ子要素のリストを取得します。
2.0および2.1該当しない
50XBRLInstanceElementappendChildElement(XBRLInstanceElement newElement)
  インスタンス文書のルート要素の子要素のリストの末尾に,指定した要素を追加します。
2.0および2.1該当しない
51XBRLInstanceElementinsertChildElementBefore(XBRLInstanceElement newElement, XBRLInstanceElement refElement)
  引数newElementに指定した要素を,このインスタンス文書のルート要素の既存の子要素の前に挿入します。
2.0および2.1該当しない
52XBRLInstanceElementreplaceChildElement(XBRLInstanceElement newElement, XBRLInstanceElement oldElement)
  引数oldElementに指定した子要素を,引数newElementに指定した要素で置き換えます。
2.0および2.1該当しない
53XBRLInstanceElementremoveChildElement(XBRLInstanceElement oldElement)
  インスタンス文書のルート要素の子要素を削除します。
2.0および2.1該当しない
54java.util.List<XBRLInstanceElement>getElements()
  このインスタンス文書に存在する要素のリストを取得します。
2.0および2.1該当しない
55java.util.List<XBRLInstanceElement>getElements(java.lang.String namespaceURI, java.lang.String name)
  このインスタンス文書に存在する,指定した名前の要素のリストを取得します。
2.0および2.1該当しない
56XBRLInstanceItemcreateItem(java.lang.String namespaceURI, java.lang.String name, XBRLContext context)
  アイテムを新規に生成します。
2.0該当しない
57XBRLInstanceItemcreateNumericItem(java.lang.String namespaceURI, java.lang.String name, XBRLContext context, XBRLUnit2 unit, XBRLPrecision precision, XBRLDecimals decimals)
  数値アイテムを新規に生成します。
2.1該当しない
58XBRLInstanceItemcreateNonNumericItem(java.lang.String namespaceURI, java.lang.String name, XBRLContext2 context)
  非数値アイテムを新規に生成します。
2.1該当しない
59XBRLInstanceTuplecreateTuple(java.lang.String namespaceURI, java.lang.String name)
  タプルを新規に生成します。
2.0および2.1該当しない
60XBRLEntitycreateEntity(XBRLIdentifier identifier, XBRLSegment segment)
  エンティティ要素を表すXBRLEntityオブジェクトを新規に生成します。
2.0および2.1該当しない
61XBRLPeriodcreatePeriod(int periodType, XBRLDateUnion instant, XBRLDateUnion startDate, XBRLDateUnion endDate, XBRLDuration duration)
  時期要素であるXBRLPeriodオブジェクトを新規に生成します。
2.0および2.1該当しない
62XBRLPeriodcreatePeriod()
  時期要素であるXBRLPeriodオブジェクトを新規に生成します。
2.1該当しない
63XBRLPeriodcreatePeriod(XBRLDateUnion instant)
  時期要素であるXBRLPeriodオブジェクトを新規に生成します。
2.1該当しない
64XBRLPeriodcreatePeriod(XBRLDateUnion startDate, XBRLDateUnion endDate)
  時期要素であるXBRLPeriodオブジェクトを新規に生成します。
2.1該当しない
65XBRLUnitcreateUnit(XBRLMeasureOrOperator measureOrOperator)
  単位要素であるXBRLUnitオブジェクトを新規に生成します。
2.0該当しない
66XBRLScenariocreateScenario(java.lang.String name)
  シナリオ要素であるXBRLScenarioオブジェクトを新規に生成します。
2.0該当しない
67XBRLScenariocreateScenario()
  シナリオ要素であるXBRLScenarioオブジェクトを新規に生成します。
2.1該当しない
68XBRLIdentifiercreateIdentifier(java.lang.String namespaceURI, java.lang.String value)
  識別子要素であるXBRLIdentifierオブジェクトを新規に生成します。
2.0および2.1該当しない
69XBRLSegmentcreateSegment(java.lang.String name)
  セグメント要素であるXBRLSegmentオブジェクトを新規に生成します。
2.0該当しない
70XBRLSegmentcreateSegment()
  セグメント要素であるXBRLSegmentオブジェクトを新規に生成します。
2.1該当しない
71XBRLMeasurecreateMeasure(XBRLQName value)
  計量要素であるXBRLMeasureオブジェクトを新規に生成します。
2.0該当しない
72XBRLOperatorcreateOperator(java.lang.String kind, XBRLMeasureOrOperator lhs, XBRLMeasureOrOperator rhs)
  演算子要素であるXBRLOperatorオブジェクトを新規に生成します。
2.0該当しない
73java.util.List<XBRLFootnote>getFootnotes()
  インスタンス文書に記述されている脚注のリストを取得します。
2.0および2.1該当しない
74java.util.List<XBRLFootnote>getFootnotesByLang(java.lang.String lang)
  インスタンス文書に記述されている脚注のうち,指定した言語の脚注を取得します。
2.0および2.1該当しない
75java.util.List<XBRLFootnote>getFootnotesByRole(java.lang.String role)
  インスタンス文書に記述されている脚注のうち,指定したロールの脚注を取得します。
2.0および2.1該当しない
76java.util.List<XBRLFootnote>getFootnotes(java.lang.String lang, java.lang.String role)
  インスタンス文書に記述されている脚注のうち,指定した言語およびロールの脚注を取得します。
2.0および2.1該当しない
77XBRLFootnoteaddFootnote(XBRLFootnote newFootnote)
  インスタンス文書に脚注を追加します。
2.0および2.1該当しない
78XBRLFootnoteremoveFootnote(XBRLFootnote oldFootnote)
  インスタンス文書から脚注を削除します。
2.0および2.1該当しない
79XBRLFootnotecreateFootnote(java.lang.String lang, java.lang.String role, java.lang.String title)
  脚注であるXBRLFootnoteオブジェクトを新規に生成します。
2.0および2.1該当しない
80XBRLFootnotecreateFootnote(java.lang.String footnoteLinkRole, java.lang.String lang, java.lang.String role, java.lang.String title)
  脚注であるXBRLFootnoteオブジェクトを新規に生成します。カスタムロールを指定できます。
2.1該当しない
81XBRLInstanceNodeimportNode(XBRLInstanceNode sourceNode, boolean deep)
  ほかのXBRLInstanceDocumentオブジェクトで生成されたノードをインポートします。
2.0および2.1該当しない
82XBRLInstanceDocumentcloneNode(org.w3c.dom.Document w3cdomDocument, boolean deep)
  インスタンス文書を複製します。
2.1該当しない
83XBRLExplicitMembercreateExplicitMember(XBRLQName dimension, XBRLQName value)
  <xbrldi:explicitMember>要素を表すXBRLExplicitMemberオブジェクトを新規に生成します。
2.11.0
84XBRLTypedMembercreateTypedMember(XBRLQName dimension)
  <xbrldi:typedMember>要素を表すXBRLTypedMemberオブジェクトを新規に生成します。
2.11.0
85intgetDimensionsVersion()
  インスタンス文書が準拠しているXBRL Dimensionsのバージョンを取得します。
2.1該当しない
<この項の構成>
(1) getOwnerDocumentManager
(2) getXBRLVersion
(3) getPTVInstance
(4) getIdManager
(5) getTaxonomyDocument
(6) getInstanceRoot
(7) getNamespaceDeclarations
(8) getNamespaceDeclarationByURI
(9) getNamespaceDeclarationByPrefix
(10) addNamespaceDeclaration
(11) removeNamespaceDeclaration
(12) getSchemaLocations
(13) getSchemaLocation
(14) addSchemaLocation
(15) removeSchemaLocation
(16) getBase
(17) setBase
(18) getId
(19) setId
(20) getSchemaRefs
(21) addSchemaRef
(22) createSchemaRef
(23) getLinkbaseRefs
(24) getLinkbaseRefs
(25) addLinkbaseRef
(26) removeLinkbaseRef
(27) createLinkbaseRef
(28) createLinkbaseRef
(29) getRoleRefs
(30) getRoleRef
(31) addRoleRef
(32) createRoleRef
(33) getArcroleRefs
(34) getArcroleRef
(35) addArcroleRef
(36) createArcroleRef
(37) getContexts
(38) addContext
(39) removeContext
(40) createNumericContext
(41) createNonNumericContext
(42) createContext
(43) getUnits
(44) addUnit
(45) removeUnit
(46) createUnit
(47) createUnit
(48) getChildElements
(49) getChildElements
(50) appendChildElement
(51) insertChildElementBefore
(52) replaceChildElement
(53) removeChildElement
(54) getElements
(55) getElements
(56) createItem
(57) createNumericItem
(58) createNonNumericItem
(59) createTuple
(60) createEntity
(61) createPeriod
(62) createPeriod
(63) createPeriod
(64) createPeriod
(65) createUnit
(66) createScenario
(67) createScenario
(68) createIdentifier
(69) createSegment
(70) createSegment
(71) createMeasure
(72) createOperator
(73) getFootnotes
(74) getFootnotesByLang
(75) getFootnotesByRole
(76) getFootnotes
(77) addFootnote
(78) removeFootnote
(79) createFootnote
(80) createFootnote
(81) importNode
(82) cloneNode
(83) createExplicitMember
(84) createTypedMember
(85) getDimensionsVersion

(1) getOwnerDocumentManager

public XBRLDocumentManager getOwnerDocumentManager()

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

(2) getXBRLVersion

public int getXBRLVersion()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書が準拠しているXBRLのバージョンを取得します。
戻り値:
このインスタンス文書がXBRL2.0に準拠している場合はXBRLConstants.XBRL_2_0,XBRL2.1に準拠している場合はXBRLConstants.XBRL_2_1を返します。

(3) getPTVInstance

public PTVInstance getPTVInstance()

XBRLのバージョン:
2.1
説明:
インスタンス文書の解析時に生成されたPTVIを取得します。
インスタンス文書を解析する際に完全な妥当性検証を実行した場合は,このメソッドでPTVIを取得できます。
ただし,インスタンス文書が次の方法で生成された場合は,PTVIは生成されないため,このメソッドではPTVIを取得できません。
  • インスタンス文書が新規作成されたものである場合
  • インスタンス文書がほかのインスタンス文書を複製して生成された場合
  • インスタンス文書を解析する際に,完全な妥当性検証が実行されていない場合
完全な妥当性検証およびPTVIの詳細については,「2.10 PTVIの生成(XBRL2.1の場合)」を参照してください。
また,インスタンス文書の内容を変更しても,その変更はPTVIに反映されません。このメソッドが返すPTVIはインスタンス文書の解析時に生成され,その後は変更されません。
戻り値:
インスタンス文書の解析時に生成されたPTVIを表すPTVInstanceオブジェクトを返します。PTVIが生成されていない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(4) getIdManager

public XBRLIdManager getIdManager()

XBRLのバージョン:
2.1
説明:
インスタンス文書のIDを管理するXBRLIdManagerオブジェクトを取得します。
戻り値:
このインスタンス文書のIDを管理するXBRLIdManagerオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(5) getTaxonomyDocument

public XBRLTaxonomyDocument getTaxonomyDocument()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書が参照するタクソノミー文書を取得します。
戻り値:
このインスタンス文書が参照するタクソノミー文書を表す,XBRLTaxonomyDocumentオブジェクトを返します。

(6) getInstanceRoot

public org.w3c.dom.Element getInstanceRoot()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトを取得します。
このgetInstanceRoot()メソッドが返したorg.w3c.dom.Elementオブジェクトに対して,属性の追加・変更・削除,または,子要素の追加・削除などの更新操作をしないでください。更新操作をした場合,XBRL DOMが正常に動作しないおそれがあります。
XBRL2.1の場合:W3C DOMのAPIを使用して,このgetInstanceRoot()メソッドが返したorg.w3c.dom.Elementオブジェクトが表すインスタンス文書のルート要素を,他インスタンス文書内以外の任意の位置に移動できます。ほかのインスタンス文書内に,インスタンス文書のルート要素を移動することはできません。
戻り値:
インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトを返します。

(7) getNamespaceDeclarations

public java.util.List<XBRLNamespaceDeclaration> getNamespaceDeclarations()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている名前空間宣言のリストを取得します。
このメソッドが返す名前空間宣言のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる名前空間宣言に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトのリストを返します。
正規化される文書を対象に実行した場合,戻り値のリストに含まれるXBRLNamespaceDeclarationオブジェクトの接頭辞は,常に正規化後の値になります。

(8) getNamespaceDeclarationByURI

public XBRLNamespaceDeclaration getNamespaceDeclarationByURI(java.lang.String uri)

XBRLのバージョン:
2.0および2.1
説明:
指定した名前空間URIの名前空間宣言を取得します。
指定した名前空間URIがデフォルトの名前空間を表す場合は,このメソッドが返したXBRLNamespaceDeclarationオブジェクトのgetPrefix()は,nullを返します。このメソッドの戻り値がnullとなるわけではありません。
引数:
uri - 名前空間URIを指定します。
戻り値:
引数uriで指定した名前空間URIの名前空間宣言を表す,XBRLNamespaceDeclarationオブジェクトを返します。引数uriで指定した名前空間URIの名前空間宣言がこのインスタンス文書で定義されていない場合はnullを返します。
正規化される文書を対象に実行した場合,戻り値のXBRLNamespaceDeclarationオブジェクトの接頭辞は,常に正規化後の値になります。
例外:
XBRLDOMRuntimeException -
  • 引数uriにnullを指定した場合にスローされます。[エラーコード:20002]

(9) getNamespaceDeclarationByPrefix

public XBRLNamespaceDeclaration getNamespaceDeclarationByPrefix(java.lang.String prefix)

XBRLのバージョン:
2.0および2.1
説明:
指定した名前空間接頭辞の名前空間宣言を取得します。
引数:
prefix - 名前空間接頭辞を指定します。デフォルトの名前空間の宣言を取得する場合はnullを指定します。
正規化される文書を対象に実行する場合,引数の接頭辞に正規化後の値を指定する必要があります。
戻り値:
引数prefixで指定した名前空間接頭辞の名前空間宣言を表す,XBRLNamespaceDeclarationオブジェクトを返します。引数prefixで指定した名前空間接頭辞の名前空間宣言が,このインスタンス文書にない場合はnullを返します。
正規化される文書を対象に実行した場合,戻り値のXBRLNamespaceDeclarationオブジェクトの接頭辞は,常に正規化後の値になります。

(10) addNamespaceDeclaration

public XBRLNamespaceDeclaration addNamespaceDeclaration(XBRLNamespaceDeclaration newNamespaceDeclaration)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素に名前空間宣言を追加します。
追加しようとした名前空間宣言の名前空間URIが,すでに別の名前空間接頭辞に対応づけられて宣言されている場合は,既存の名前空間宣言が削除されます。引数に指定したXBRLNamespaceDeclarationオブジェクトが,すでにこのXBRLInstanceDocumentオブジェクトに追加されている場合は,何もしません。
ある名前空間URIの名前空間宣言がすでに追加されていて,その名前空間URIに対応する名前空間接頭辞を変更したい場合は,同じ名前空間URIと別の新しい名前空間接頭辞を持つXBRLNamespaceDeclarationオブジェクトを作成し,それを引数に指定してこのメソッドを呼び出してください。
すでに設定されている名前空間の名前空間接頭辞が変更された場合,この名前空間に属する要素の名前空間接頭辞が変更されます。ただし,<xbrli:scenario>要素と<xbrli:segment>要素の内容には任意のXML要素を記述できるため,これら二つの要素の子孫ノードについては,名前空間接頭辞は設定しません。
引数:
newNamespaceDeclaration - 追加する名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトを指定します。
戻り値:
追加された名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newNamespaceDeclarationにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newNamespaceDeclarationに指定した名前空間接頭辞が,すでに別の名前空間URIに対応づけられて宣言されている場合にスローされます。[エラーコード:20037]
  • 引数newNamespaceDeclarationに指定された名前空間接頭辞がnullで,かつ,指定された名前空間に属するグローバル属性がインスタンス文書中に存在する場合にスローされます。[エラーコード:20036]
  • 引数newNamespaceDeclarationに指定した名前空間接頭辞が「xml」で始まる場合にスローされます。「xml」の大文字・小文字は区別されません。[エラーコード:20038]
  • 引数newNamespaceDeclarationに指定した名前空間URIが,http://www.w3.org/XML/1998/namespaceまたはhttp://www.w3.org/2000/xmlns/の場合にスローされます。[エラーコード:20039]
  • 引数newNamespaceDeclarationに指定された名前空間接頭辞がnullで,かつ,指定された名前空間URIが空文字列("")でなく,かつ,名前空間に属さない要素または修飾名がインスタンス文書中に存在する場合にスローされます。[エラーコード:20070]
  • 引数newNamespaceDeclarationに指定された名前空間接頭辞が,空文字列("")の場合にスローされます。[エラーコード:20027]

(11) removeNamespaceDeclaration

public XBRLNamespaceDeclaration removeNamespaceDeclaration(XBRLNamespaceDeclaration oldNamespaceDeclaration)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書から名前空間宣言を削除します。
引数:
oldNamespaceDeclaration - 削除する名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトを指定します。
戻り値:
削除された名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数oldNamespaceDeclarationにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldNamespaceDeclarationに指定された名前空間宣言が,このインスタンス文書に記述されていない場合にスローされます。[エラーコード:20040]
  • 引数oldNamespaceDeclarationに指定された名前空間接頭辞が,このインスタンス文書で使用されている場合にスローされます。[エラーコード:20041]
  • XBRL2.1の場合:引数oldNamespaceDeclarationに指定された名前空間接頭辞がnullで,かつ指定された名前空間URIが空文字列("")で,かつ名前空間に属さない要素または修飾名がインスタンス文書中に存在するときにスローされます。[エラーコード:20107]

(12) getSchemaLocations

public java.util.List<XBRLSchemaLocation> getSchemaLocations()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素のxsi:schemaLocation属性に記述されている名前空間URIと,スキーマ文書の位置を示すURIの組を表すオブジェクトのリストを取得します。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLSchemaLocationオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
XBRLSchemaLocationオブジェクトのリストを返します。

(13) getSchemaLocation

public XBRLSchemaLocation getSchemaLocation(java.lang.String namespaceURI)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素のxsi:schemaLocation属性に記述されている名前空間URIと,スキーマ文書の位置を示すURIの組を表すオブジェクトのリストの中から,指定した名前空間URIのオブジェクトを取得します。
引数:
namespaceURI - 名前空間URIを指定します。
戻り値:
引数namespaceURIで指定した名前空間URIと,そのスキーマ文書の位置を示すURIの組を表す,XBRLSchemaLocationオブジェクトを返します。引数namespaceURIで指定した名前空間URIのXBRLSchemaLocationオブジェクトがない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 引数namespaceURIにnullを指定した場合にスローされます。[エラーコード:20002]

(14) addSchemaLocation

public XBRLSchemaLocation addSchemaLocation(XBRLSchemaLocation newSchemaLocation)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素のxsi:schemaLocation属性に,名前空間URIとスキーマ文書の位置を示すURIの組を追加します。追加しようとした名前空間URIの組がすでにある場合は,最初に既存のものが削除されます。引数に指定したXBRLSchemaLocationオブジェクトがすでにこのXBRLInstanceDocumentオブジェクトに追加されている場合は,何もしません。
引数:
newSchemaLocation - 追加する名前空間URIとスキーマ文書の位置を示すURIの組を表す,XBRLSchemaLocationオブジェクトを指定します。
戻り値:
追加されたXBRLSchemaLocationオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newSchemaLocationにnullを指定した場合にスローされます。[エラーコード:20002]

(15) removeSchemaLocation

public XBRLSchemaLocation removeSchemaLocation(XBRLSchemaLocation oldSchemaLocation)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素のxsi:schemaLocation属性から,指定された名前空間URIとスキーマ文書の位置を示すURIの組を削除します。
引数:
oldSchemaLocation - 削除する名前空間URIとスキーマ文書の位置を示すURIの組を表す,XBRLSchemaLocationオブジェクトを指定します。
戻り値:
削除されたXBRLSchemaLocationオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数oldSchemaLocationにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldSchemaLocationに指定したXBRLSchemaLocationオブジェクトが,このインスタンス文書にない場合にスローされます。[エラーコード:20042]

(16) getBase

public java.lang.String getBase()

XBRLのバージョン:
2.1
説明:
インスタンス文書のルート要素のxml:base属性の値を取得します。
戻り値:
インスタンス文書のルート要素のxml:base属性の値を返します。xml:base属性がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(17) setBase

public void setBase(java.lang.String base)

XBRLのバージョン:
2.1
説明:
インスタンス文書のルート要素のxml:base属性の値を設定します。
このメソッドでxml:base属性の値を設定しても,インスタンス文書中に記述されている<link:schemaRef>要素などのxlink:href属性に指定された相対URIを解決し直すことはありません。このsetBase()メソッドは,単にxml:base属性の値を設定するだけです。ただし,このsetBase()メソッドによってxml:base属性の値を変更すると,インスタンス文書を出力して再度解析した際の相対URIの解決結果が変わるおそれがあるため,注意してください。
引数:
base - xml:base属性の値を指定します。xml:base属性を削除する場合はnullを指定します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数baseに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]

(18) getId

public java.lang.String getId()

XBRLのバージョン:
2.1
説明:
インスタンス文書のルート要素のid属性の値を取得します。
戻り値:
インスタンス文書のルート要素のid属性の値を返します。id属性がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(19) setId

public void setId(java.lang.String id)

XBRLのバージョン:
2.1
説明:
インスタンス文書のルート要素のid属性の値を設定します。
引数:
id - id属性の値を指定します。id属性を削除する場合はnullを指定します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数idに指定した値がxsd:NCName型でない場合にスローされます。[エラーコード:20108]
  • 引数idで指定されたのと同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]

(20) getSchemaRefs

public java.util.List<XBRLSchemaRef> getSchemaRefs()

XBRLのバージョン:
2.1
説明:
インスタンス文書に記述されている<link:schemaRef>要素のリストを取得します。
このメソッドが返す<link:schemaRef>要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる<link:schemaRef>要素に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に記述されている<link:schemaRef>要素をすべて含むXBRLSchemaRefオブジェクトのリストを返します。このインスタンス文書に<link:schemaRef>要素が記述されていない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(21) addSchemaRef

public XBRLSchemaRef addSchemaRef(XBRLSchemaRef newSchemaRef)
                    throws XBRLDOMException

XBRLのバージョン:
2.1
説明:
インスタンス文書に<link:schemaRef>要素を追加します。指定されたXBRLSchemaRefオブジェクトがすでにこのインスタンス文書に記述されている場合は,何もしません。
このメソッドを呼び出すと,指定された<link:schemaRef>要素が指すタクソノミー本体がタクソノミー文書にない場合は,そのタクソノミー本体を読み込んで解析し,タクソノミー文書に追加します。タクソノミー本体の解析処理は,このXBRLInstanceDocumentオブジェクトを生成する際に使用されたXBRLInstanceDocumentBuilderオブジェクトの設定に従って実行されます。追加されたタクソノミー本体の情報は,このXBRLInstanceDocumentオブジェクトが参照するXBRLTaxonomyDocumentオブジェクトに直ちに反映されます。
<link:schemaRef>要素が指すタクソノミー本体を読み込んで解析する際に,そのタクソノミー本体がほかのタクソノミー本体やリンクベースを参照していて,かつ,それらがタクソノミー文書に存在しない場合は,それらのほかのタクソノミー本体やリンクベースも読み込んで解析し,タクソノミー文書へ追加します。
指定された<link:schemaRef>要素が指すタクソノミー本体がすでにタクソノミー文書に存在する場合は,タクソノミー本体の解析はされません。単にインスタンス文書に<link:schemaRef>要素が追加されるだけです。
引数:
newSchemaRef - 追加する<link:schemaRef>要素を表すXBRLSchemaRefオブジェクトを指定します。
戻り値:
追加された<link:schemaRef>要素を表すXBRLSchemaRefオブジェクトを返します。
例外:
XBRLDOMException -
  • 引数newSchemaRefに指定されたXBRLSchemaRefオブジェクトが指すタクソノミー本体の解析処理でエラーが検出された場合に,スローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数newSchemaRefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newSchemaRefに指定されたXBRLSchemaRefオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]

(22) createSchemaRef

public XBRLSchemaRef createSchemaRef(java.lang.String href,
                                    java.lang.String base)

XBRLのバージョン:
2.1
説明:
<link:schemaRef>要素を表すXBRLSchemaRefオブジェクトを新規に生成します。
引数:
href - <link:schemaRef>要素のxlink:href属性の値を指定します。
base - <link:schemaRef>要素のxml:base属性の値を指定します。xml:base属性が不要な場合はnullを指定します。
戻り値:
新しく生成されたXBRLSchemaRefオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数hrefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数hrefまたはbaseに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]

(23) getLinkbaseRefs

public java.util.List<XBRLLinkbaseRef> getLinkbaseRefs()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている<link:linkbaseRef>要素のリストを取得します。
このメソッドが返す<link:linkbaseRef>要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる<link:linkbaseRef>要素に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に存在する<link:linkbaseRef>要素をすべて含む,XBRLLinkbaseRefオブジェクトのリストを返します。このインスタンス文書に<link:linkbaseRef>要素がない場合は,要素数が0のリストを返します。

(24) getLinkbaseRefs

public java.util.List<XBRLLinkbaseRef> getLinkbaseRefs(java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている<link:linkbaseRef>要素のうち,引数roleと同じ値のxlink:role属性を持つ<link:linkbaseRef>要素のリストを取得します。
このメソッドが返す<link:linkbaseRef>要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる<link:linkbaseRef>要素に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
role - 取得したい<link:linkbaseRef>要素のxlink:role属性の値を指定します。xlink:role 属性を持たない<link:linkbaseRef>要素を取得したい場合はnullを指定します。
戻り値:
引数roleと同じ値のxlink:role属性を持つ<link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトのリストを返します。このインスタンス文書に,引数roleと同じ値のxlink:role属性を持つ<link:linkbaseRef>要素がない場合は,要素数が0のリストを返します。

(25) addLinkbaseRef

public XBRLLinkbaseRef addLinkbaseRef(XBRLLinkbaseRef newLinkbaseRef)
                      throws XBRLDOMException

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に<link:linkbaseRef>要素を追加します。指定したXBRLLinkbaseRefオブジェクトが,すでにこのインスタンス文書にある場合は,何もしません。
このメソッドを呼び出すと,引数newLinkbaseRefに指定したXBRLLinkbaseRefオブジェクトが参照するリンクベースを読み込んで解析します。リンクベース解析処理は,このXBRLInstanceDocumentオブジェクトを生成する際に使用された,XBRLInstanceDocumentBuilderオブジェクトの設定に従って実行されます。
このメソッドの呼び出しによって追加されたリンクベースの情報は,このXBRLInstanceDocumentオブジェクトが参照するXBRLTaxonomyDocumentオブジェクトに直ちに反映されます。
XBRL2.1の場合:<link:linkbaseRef>要素が指すリンクベースを読み込んで解析をする際に,そのリンクベースがほかのタクソノミー本体やリンクベースを参照していて,かつ,それらのタクソノミー本体やリンクベースがタクソノミー文書に存在しない場合は,それらのほかのタクソノミー本体やリンクベースも読み込んで解析を行い,タクソノミー文書へ追加します。
引数:
newLinkbaseRef - 追加する<link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを指定します。
戻り値:
追加された<link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを返します。
例外:
XBRLDOMException -
  • 引数newLinkbaseRefに指定したXBRLLinkbaseRefオブジェクトが参照するリンクベースの解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 引数newLinkbaseRefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newLinkbaseRefに指定したXBRLLinkbaseRefオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]

(26) removeLinkbaseRef

public XBRLLinkbaseRef removeLinkbaseRef(XBRLLinkbaseRef oldLinkbaseRef)

XBRLのバージョン:
2.0
説明:
インスタンス文書に記述されている<link:linkbaseRef>要素を削除します。
このメソッドの呼び出しによって削除されたリンクベースの情報は,このXBRLInstanceDocumentオブジェクトが参照するXBRLTaxonomyDocumentオブジェクトに直ちに反映されます。
引数:
oldLinkbaseRef - 削除する<link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを指定します。
戻り値:
削除された<link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数oldLinkbaseRefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldLinkbaseRefに指定した<link:linkbaseRef>要素が,このインスタンス文書にない場合にスローされます。[エラーコード:20047]

(27) createLinkbaseRef

public XBRLLinkbaseRef createLinkbaseRef(java.lang.String role,
                                        java.lang.String href)

XBRLのバージョン:
2.0および2.1
説明:
<link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを新規に生成します。
XBRL2.1の場合,このメソッドで生成された<link:linkbaseRef>要素にはxml:base属性は付きません。<link:linkbaseRef>要素にxml:base属性を付けたい場合は,createLinkbaseRef(java.lang.String role, java.lang.String href, java.lang.String base)メソッドを使用してください。
引数:
role - <link:linkbaseRef>要素のxlink:role属性の値を指定します。xlink:role属性が不要な場合はnullを指定します。
href - <link:linkbaseRef>要素のxlink:href属性の値を指定します。
戻り値:
新しく生成されたXBRLLinkbaseRefオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数hrefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数roleまたはhrefに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • 引数roleに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]

(28) createLinkbaseRef

public XBRLLinkbaseRef createLinkbaseRef(java.lang.String role,
                                        java.lang.String href,
                                        java.lang.String base)

XBRLのバージョン:
2.1
説明:
<link:linkbaseRef>要素を表すXBRLLinkbaseRefオブジェクトを新規に生成します。
引数:
role - <link:linkbaseRef>要素のxlink:role属性の値を指定します。xlink:role属性が不要な場合はnullを指定します。
href - <link:linkbaseRef>要素のxlink:href属性の値を指定します。
base - <link:linkbaseRef>要素のxml:base属性の値を指定します。xml:base属性が不要な場合はnullを指定します。
戻り値:
新しく生成されたXBRLLinkbaseRefオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数hrefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数role,hrefまたはbaseに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • 引数roleに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]

(29) getRoleRefs

public java.util.List<XBRLRoleRef> getRoleRefs()

XBRLのバージョン:
2.1
説明:
インスタンス文書に記述されている<link:roleRef>要素のリストを取得します。
このメソッドが返す<link:roleRef>要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる<link:roleRef>要素に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に存在する<link:roleRef>要素をすべて含むXBRLRoleRefオブジェクトのリストを返します。このインスタンス文書に<link:roleRef>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(30) getRoleRef

public XBRLRoleRef getRoleRef(java.lang.String roleURI)

XBRLのバージョン:
2.1
説明:
インスタンス文書に記述されている<link:roleRef>要素のうち,指定したroleURIと同じ値のroleURI属性を持つ<link:roleRef>要素を取得します。
引数:
roleURI - 取得したい<link:roleRef>要素のroleURI属性の値を指定します。
戻り値:
このインスタンス文書に存在する<link:roleRef>要素のうち,引数roleURIと同じ値のroleURI属性を持つ<link:roleRef>要素を返します。引数roleURIと同じ値のroleURI属性を持つ<link:roleRef>要素が存在しない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数roleURIにnullを指定した場合にスローされます。[エラーコード:20002]

(31) addRoleRef

public XBRLRoleRef addRoleRef(XBRLRoleRef newRoleRef)
                  throws XBRLDOMException

XBRLのバージョン:
2.1
説明:
インスタンス文書に<link:roleRef>要素を追加します。指定されたXBRLRoleRefオブジェクトがすでにこのインスタンス文書に存在する場合は,何もしません。
<link:roleRef>要素は,タクソノミー本体に記述された<link:roleType>要素を指します。このメソッドを呼び出すと,<link:roleType>要素が記述されているタクソノミー本体がタクソノミー文書に存在しない場合は,そのタクソノミー本体を読み込んで解析を行い,タクソノミー文書へ追加します。タクソノミー本体の解析処理は,このXBRLInstanceDocumentオブジェクトを生成する際に使用されたXBRLInstanceDocumentBuilderオブジェクトの設定に従って実行されます。追加されたタクソノミー本体の情報は,このXBRLInstanceDocumentオブジェクトが参照するXBRLTaxonomyDocumentオブジェクトに直ちに反映されます。
<link:roleRef>要素が指すタクソノミー本体を読み込んで解析を行う際に,そのタクソノミー本体がほかのタクソノミー本体やリンクベースを参照していて,かつ,それらがタクソノミー文書に存在しない場合は,それらのほかのタクソノミー本体やリンクベースも読み込んで解析を行い,タクソノミー文書へ追加します。
<link:roleType>要素が記述されているタクソノミー本体がすでにタクソノミー文書に存在する場合は,タクソノミー本体の解析処理は行われません。単にインスタンス文書に<link:roleRef>要素が追加されるだけです。
追加した<link:roleRef>要素が指す<link:roleType>要素は,引数newRoleRefに指定したXBRLRoleRefオブジェクトに対してgetRoleType()メソッドを呼び出すことによって取得できます。
引数:
newRoleRef - 追加する<link:roleRef>要素を表すXBRLRoleRefオブジェクトを指定します。
戻り値:
追加された<link:roleRef>要素を表すXBRLRoleRefオブジェクトを返します。
例外:
XBRLDOMException -
  • タクソノミー本体の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数newRoleRefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newRoleRefに指定されたXBRLRoleRefオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合に,スローされます。[エラーコード:20021]
  • 引数newRoleRefに指定された<link:roleRef>要素のroleURI属性と同じ値のroleURI属性を持つ<link:roleRef>要素がインスタンス文書中に存在する場合にスローされます。[エラーコード:20111]

(32) createRoleRef

public XBRLRoleRef createRoleRef(java.lang.String href,
                                java.lang.String roleURI,
                                java.lang.String base)

XBRLのバージョン:
2.1
説明:
<link:roleRef>要素であるXBRLRoleRefオブジェクトを新規に生成します。
引数:
href - <link:roleRef>要素のxlink:href属性の値を指定します。
roleURI - <link:roleRef>要素のroleURI属性の値を指定します。
base - <link:roleRef>要素のxml:base属性の値を指定します。xml:base属性が不要な場合はnullを指定します。
戻り値:
新しく作成されたXBRLRoleRefオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数hrefまたはroleURIにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数href,roleURIまたはbaseに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • 引数roleURIに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]
  • 引数roleURIに指定したロールがXBRL仕様で規定されている標準値である場合にスローされます。[エラーコード:20113]

(33) getArcroleRefs

public java.util.List<XBRLArcroleRef> getArcroleRefs()

XBRLのバージョン:
2.1
説明:
インスタンス文書に記述されている<link:arcroleRef>要素のリストを取得します。
このメソッドが返す<link:arcroleRef>要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる<link:arcroleRef>要素に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に存在する<link:arcroleRef>要素をすべて含むXBRLArcroleRefオブジェクトのリストを返します。このインスタンス文書に<link:arcroleRef>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(34) getArcroleRef

public XBRLArcroleRef getArcroleRef(java.lang.String arcroleURI)

XBRLのバージョン:
2.1
説明:
インスタンス文書に記述されている<link:arcroleRef>要素のうち,引数arcroleURIと同じ値のarcroleURI属性を持つ<link:arcroleRef>要素を取得します。
引数:
arcroleURI - 取得したい<link:arcroleRef>要素のarcroleURI属性の値を指定します。
戻り値:
このインスタンス文書に存在する<link:arcroleRef>要素のうち,引数arcroleURIと同じ値のarcroleURI属性を持つ<link:arcroleRef>要素を表すXBRLArcroleRefオブジェクトを返します。引数arcroleURIと同じ値のarcroleURI属性を持つ<link:arcroleRef>要素が存在しない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数arcroleURIにnullを指定した場合にスローされます。[エラーコード:20002]

(35) addArcroleRef

public XBRLArcroleRef addArcroleRef(XBRLArcroleRef newArcroleRef)
                     throws XBRLDOMException

XBRLのバージョン:
2.1
説明:
インスタンス文書に<link:arcroleRef>要素を追加します。指定されたXBRLArcroleRefオブジェクトがすでにこのインスタンス文書に存在する場合は,何もしません。
<link:arcroleRef>要素は,タクソノミー本体に記述された<link:arcroleType>要素を指します。このメソッドを呼び出すと,<link:arcroleType>要素が記述されているタクソノミー本体がタクソノミー文書に存在しない場合は,そのタクソノミー本体を読み込んで解析を行い,タクソノミー文書へ追加します。タクソノミー本体の解析処理は,このXBRLInstanceDocumentオブジェクトを生成する際に使用されたXBRLInstanceDocumentBuilderオブジェクトの設定に従って実行されます。追加されたタクソノミー本体の情報は,このXBRLInstanceDocumentオブジェクトが参照するXBRLTaxonomyDocumentオブジェクトに直ちに反映されます。
<link:arcroleRef>要素が指すタクソノミー本体を読み込んで解析を行う際に,そのタクソノミー本体がほかのタクソノミー本体やリンクベースを参照していて,かつ,それらがタクソノミー文書に存在しない場合は,それらのほかのタクソノミー本体やリンクベースも読み込んで解析を行い,タクソノミー文書へ追加します。
<link:arcroleType>要素が記述されているタクソノミー本体がすでにタクソノミー文書に存在する場合は,タクソノミー本体の解析処理は行われません。単にインスタンス文書に<link:arcroleRef>要素が追加されるだけです。
追加した<link:arcroleRef>要素が指す<link:arcroleType>要素は,引数newArcroleRefに指定したXBRLArcroleRefオブジェクトに対してgetArcroleType()メソッドを呼び出すことによって取得できます。
引数:
newArcroleRef - 追加する<link:arcroleRef>要素を表すXBRLArcroleRefオブジェクトを指定します。
戻り値:
追加された<link:arcroleRef>要素を表すXBRLArcroleRefオブジェクトを返します。
例外:
XBRLDOMException -
  • タクソノミー本体の解析処理でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数newArcroleRefにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newArcroleRefに指定されたXBRLArcroleRefオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数newArcroleRefに指定された<link:arcroleRef>要素のarcroleURI属性と同じ値のarcroleURI属性を持つ<link:arcroleRef>要素がインスタンス文書中に存在する場合にスローされます。[エラーコード:20112]

(36) createArcroleRef

public XBRLArcroleRef createArcroleRef(java.lang.String href,
                                      java.lang.String arcroleURI,
                                      java.lang.String base)

XBRLのバージョン:
2.1
説明:
<link:arcroleRef>要素であるXBRLArcroleRefオブジェクトを新規に生成します。
引数:
href - <link:arcroleRef>要素のxlink:href属性の値を指定します。
arcroleURI - <link:arcroleRef>要素のarcroleURI属性の値を指定します。
base - <link:arcroleRef>要素のxml:base属性の値を指定します。xml:base属性が不要な場合はnullを指定します。
戻り値:
新しく作成されたXBRLArcroleRefオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数hrefまたはarcroleURIにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数href,arcroleURIまたはbaseに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • 引数arcroleURIに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]
  • 引数arcroleURIに指定したアークロールがXBRL仕様で規定されている標準値である場合にスローされます。[エラーコード:20114]

(37) getContexts

public java.util.List<XBRLContext> getContexts()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されているコンテキスト要素のリストを取得します。
このメソッドが返すコンテキストのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるコンテキストに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に存在するコンテキストをすべて含む,XBRLContextオブジェクトのリストを返します。このインスタンス文書にコンテキストがない場合は,要素数が0のリストを返します。

(38) addContext

public XBRLContext addContext(XBRLContext newContext)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書にコンテキスト要素を追加します。指定したXBRLContextオブジェクトがすでにこのインスタンス文書に存在する場合は,何もしません。
引数:
newContext - 追加するコンテキストを表すXBRLContextオブジェクトを指定します。
戻り値:
追加されたコンテキストを表すXBRLContextオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newContextにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newContextに指定したコンテキストのid属性と同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]
  • 引数newContextに指定したXBRLContextオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]

(39) removeContext

public XBRLContext removeContext(XBRLContext oldContext)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書からコンテキスト要素を削除します。
コンテキストを削除すると,そのコンテキストを参照しているアイテムもすべて,インスタンス文書から自動的に削除されます。
引数:
oldContext - 削除するコンテキストを表すXBRLContextオブジェクトを指定します。
戻り値:
削除されたコンテキストを表すXBRLContextオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数oldContextにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldContextに指定したコンテキストが,このインスタンス文書にない場合にスローされます。[エラーコード:20043]

(40) createNumericContext

public XBRLNumericContext createNumericContext(XBRLEntity entity,
                                              XBRLPeriod period,
                                              XBRLUnit unit,
                                              XBRLScenario scenario,
                                              int precision,
                                              boolean cwa)

XBRLのバージョン:
2.0
説明:
数値コンテキスト要素を新規に生成します。
数値コンテキストのid属性の値は,このメソッドで数値コンテキストを生成する際に自動的に採番されます。id属性の値は,数値コンテキストを生成する際に自動的に採番されますが,XBRLContextのsetId()メソッドを使用して任意の値を設定することもできます。自動採番機能の詳細については,「3.3 ID管理と採番」を参照してください。
引数:
entity - エンティティ要素を表すXBRLEntityオブジェクトを指定します。
period - 時期要素を表すXBRLPeriodオブジェクトを指定します。
unit - 単位要素を表すXBRLUnitオブジェクトを指定します。
scenario - シナリオ要素を表すXBRLScenarioオブジェクトを指定します。シナリオ要素がない場合はnullを指定します。
precision - precision属性の値を指定します。1以上の値を指定します。
cwa - cwa属性の値を指定します。
戻り値:
新しく生成されたXBRLNumericContextオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数entity,periodまたはunitにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数entity,period,unitまたはscenarioに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数entity,period,unitまたはscenarioに指定したオブジェクトが,すでにほかのXBRLContextオブジェクトに設定されている場合にスローされます。[エラーコード:20005]
  • 引数precisionに,0以下の値を指定した場合にスローされます。[エラーコード:20014]

(41) createNonNumericContext

public XBRLNonNumericContext createNonNumericContext(XBRLEntity entity,
                                                    XBRLPeriod period,
                                                    XBRLUnit unit,
                                                    XBRLScenario scenario)

XBRLのバージョン:
2.0
説明:
非数値コンテキスト要素を新規に生成します。
非数値コンテキストのid属性の値は,このメソッドで非数値コンテキストを生成する際に自動的に採番されます。id属性の値は,非数値コンテキストを生成する際に自動的に採番されますが,XBRLContextのsetId()メソッドを使用して任意の値を設定することもできます。自動採番機能の詳細については,「3.3 ID管理と採番」を参照してください。
引数:
entity - エンティティ要素を表すXBRLEntityオブジェクトを指定します。
period - 時期要素を表すXBRLPeriodオブジェクトを指定します。
unit - 単位要素を表すXBRLUnitオブジェクトを指定します。単位要素がない場合はnullを指定します。
scenario - シナリオ要素を表すXBRLScenarioオブジェクトを指定します。シナリオ要素がない場合はnullを指定します。
戻り値:
新しく生成されたXBRLNonNumericContextオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数entity,periodまたはunitにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数entity,period,unitまたはscenarioに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数entity,period,unitまたはscenarioに指定したオブジェクトが,すでにほかのXBRLContextオブジェクトに設定されている場合にスローされます。[エラーコード:20005]

(42) createContext

public XBRLContext2 createContext(XBRLEntity entity,
                                 XBRLPeriod period,
                                 XBRLScenario scenario)

XBRLのバージョン:
2.1
説明:
コンテキスト要素を新規に生成します。
コンテキストのid属性の値は,このメソッドでコンテキストを生成する際に自動的に採番されます。id属性の値は,コンテキストを生成する際に自動的に採番されますが,XBRLContextのsetId()メソッドを使用して任意の値を設定することもできます。自動採番の詳細については,「3.3 ID管理と採番」を参照してください。
引数:
entity - エンティティ要素を表すXBRLEntityオブジェクトを指定します。
period - 時期要素を表すXBRLPeriodオブジェクトを指定します。
scenario - シナリオ要素を表すXBRLScenarioオブジェクトを指定します。シナリオ要素がない場合はnullを指定します。
戻り値:
新しく生成されたXBRLContext2オブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数entityまたはperiodにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数entity,periodまたはscenarioに指定されたオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数entity,periodまたはscenarioに指定されたオブジェクトが,すでにほかのXBRLContextオブジェクトに設定されている場合にスローされます。[エラーコード:20005]

(43) getUnits

public java.util.List<XBRLUnit2> getUnits()

XBRLのバージョン:
2.1
説明:
インスタンス文書に記述されている単位要素のリストを取得します。
このメソッドが返す単位要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる単位要素に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に存在する単位要素をすべて含むXBRLUnit2オブジェクトのリストを返します。このインスタンス文書に単位要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(44) addUnit

public XBRLUnit2 addUnit(XBRLUnit2 newUnit)

XBRLのバージョン:
2.1
説明:
インスタンス文書に単位要素を追加します。指定されたXBRLUnit2オブジェクトがすでにこのインスタンス文書に存在する場合は,何もしません。
引数:
newUnit - 追加する単位要素を表すXBRLUnit2オブジェクトを指定します。
戻り値:
追加された単位要素を表すXBRLUnit2オブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数newUnitにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newUnitに指定されたXBRLUnit2オブジェクトを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数newUnitに指定された単位要素のid属性と同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]

(45) removeUnit

public XBRLUnit2 removeUnit(XBRLUnit2 oldUnit)

XBRLのバージョン:
2.1
説明:
インスタンス文書から単位要素を削除します。単位要素を削除すると,その単位要素を参照しているアイテムもすべて,インスタンス文書から自動的に削除されます。
引数:
oldUnit - 削除する単位要素を表すXBRLUnit2オブジェクトを指定します。
戻り値:
削除された単位要素を表すXBRLUnit2オブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数oldUnitにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldUnitに指定された単位要素が,このインスタンス文書に存在しない場合にスローされます。[エラーコード:20124]

(46) createUnit

public XBRLUnit2 createUnit(XBRLQName[] measures)

XBRLのバージョン:
2.1
説明:
単位要素であるXBRLUnit2オブジェクトを新規に生成します。
このメソッドで生成するXBRLUnit2オブジェクトの内容は,一つ以上の基本単位によって構成されます。つまり,XBRLUnit2.getUnitType()メソッドはXBRLUnit2.MULTIPLYを返します。
単位要素の内容には,「基本単位を表すXBRLQNameオブジェクトの名前空間URIが"http://www.xbrl.org/2003/instance"である場合,基本単位を表すXBRLQNameオブジェクトのローカルパートは,"pure"または"shares"のどちらかでなければならない」という制約があります。この制約に違反する単位要素を生成しようとした場合は,XBRLDOMRuntimeExceptionがスローされます。
単位要素のid属性の値は,このメソッドで単位要素を生成する際に自動的に採番されます。id属性の値は,単位要素を生成する際に自動的に採番されますが,XBRLUnit2のsetId()メソッドを使用して任意の値を設定することもできます。自動採番の詳細については,「3.3 ID管理と採番」を参照してください。
引数:
measures - 基本単位を表すXBRLQNameオブジェクトの配列を指定します。配列の要素数は1以上である必要があります。基本単位を表す<xbrli:measure>要素のインスタンス文書中での出現順は,この引数に指定された配列の中でのXBRLQNameオブジェクトの順序と同じになります。
戻り値:
新しく生成されたXBRLUnit2オブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数measuresにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数measuresに指定した配列の要素数が0である場合にスローされます。[エラーコード:20013]
  • 引数measuresに指定した配列中に値がnullである要素が存在する場合にスローされます。[エラーコード:20012]
  • 引数measuresに指定した配列中のXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言がXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
  • 引数measuresに指定した配列中のXBRLQNameオブジェクトが名前空間に属さず,かつ,XBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]
  • 引数measuresに指定した配列の中に,上記の制約に違反するXBRLQNameオブジェクトがある場合にスローされます。[エラーコード:20125]

(47) createUnit

public XBRLUnit2 createUnit(XBRLQName[] numerator,
                           XBRLQName[] denominator)

XBRLのバージョン:
2.1
説明:
分数を指定して,単位要素であるXBRLUnit2オブジェクトを新規に生成します。
このメソッドで生成するXBRLUnit2オブジェクトの内容は,分数です。つまり,XBRLUnit2.getUnitType()メソッドはXBRLUnit2.DIVIDEを返します。
単位要素の内容には次のような制約があります。これらの制約に違反する単位要素を生成しようとした場合は,XBRLDOMRuntimeExceptionがスローされます。
  • 分子と分母に同じ基本単位を含めてはいけません。同じ基本単位とは,基本単位を表すXBRLQNameオブジェクトの名前空間URIとローカルパートが同じであるもののことです。
  • 基本単位を表すXBRLQNameオブジェクトの名前空間URIが"http://www.xbrl.org/2003/instance" である場合,基本単位を表すXBRLQNameオブジェクトのローカルパートは,"pure"または"shares"のどちらかである必要があります。
単位要素のid属性の値は,このメソッドで単位要素を生成する際に自動的に採番されます。id属性の値は,単位要素を生成する際に自動的に採番されますが,XBRLUnit2のsetId()メソッドを使用して任意の値を設定することもできます。自動採番の詳細については,「3.3 ID管理と採番」を参照してください。
引数:
numerator - 分数の分子を構成する基本単位を表すXBRLQNameオブジェクトの配列を指定します。配列の要素数は1以上である必要があります。分数の分子を構成する基本単位を表す<xbrli:measure>要素のインスタンス文書中での出現順は,この引数に指定された配列の中でのXBRLQNameオブジェクトの順序と同じになります。
denominator - 分数の分母を構成する基本単位を表すXBRLQNameオブジェクトの配列を指定します。配列の要素数は1以上である必要があります。分数の分母を構成する基本単位を表す<xbrli:measure>要素のインスタンス文書中での出現順は,この引数に指定された配列の中でのXBRLQNameオブジェクトの順序と同じになります。
戻り値:
新しく生成されたXBRLUnit2オブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数numeratorまたはdenominatorにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数numeratorまたはdenominatorに指定した配列の要素数が0である場合にスローされます。[エラーコード:20013]
  • 引数numeratorまたはdenominatorに指定した配列中に値がnullである要素が存在する場合にスローされます。[エラーコード:20012]
  • 引数numeratorまたはdenominatorに指定した配列中のXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言がXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
  • 引数numeratorまたはdenominatorに指定した配列中のXBRLQNameオブジェクトが名前空間に属さず,かつ,XBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]
  • 引数numeratorとdenominatorで指定した単位要素の内容が,上記の制約に違反している場合にスローされます。[エラーコード:20125,20126]

(48) getChildElements

public java.util.List<XBRLInstanceElement> getChildElements()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素の子要素のリストを取得します。子要素は,アイテムまたはタプルです。
このメソッドが返すリスト中でのXBRLInstanceElementオブジェクトの順序は,インスタンス文書での要素の出現順と同じです。
このメソッドが返すXBRLInstanceElementオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLInstanceElementオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書のルート要素の子要素をすべて含む,XBRLInstanceElementオブジェクトのリストを返します。インスタンス文書のルート要素に子要素がない場合は,要素数が0のリストを返します。

(49) getChildElements

public java.util.List<XBRLInstanceElement> getChildElements(java.lang.String namespaceURI,
                                      java.lang.String name)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素の子要素のうち,指定した名前を持つ子要素のリストを取得します。子要素は,アイテムまたはタプルです。
インスタンス文書のルート要素の子要素として,同じ名前の要素が二つ以上存在することがあります。このため,このメソッドは,指定した名前の子要素を,XBRLInstanceElementオブジェクトのリストとして返します。リスト中でのXBRLInstanceElementオブジェクトの順序は,インスタンス文書での要素の出現順と同じです。
このメソッドが返すXBRLInstanceElementオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLInstanceElementオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
namespaceURI - 子要素の名前空間URIを指定します。
name - 子要素の名前を指定します。
戻り値:
引数namespaceURIで指定した名前空間URIに属し,引数nameで指定した名前を持つ子要素をすべて含む,XBRLInstanceElementオブジェクトのリストを返します。指定した子要素がない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]

(50) appendChildElement

public XBRLInstanceElement appendChildElement(XBRLInstanceElement newElement)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素の子要素のリストの末尾に,指定した要素を追加します。子要素は,アイテムまたはタプルです。
指定した要素がすでにほかのオブジェクトの子となっている場合は,最初に既存の親から指定した要素が削除されます。
引数:
newElement - 追加する子要素を表すXBRLInstanceElementオブジェクトを指定します。
戻り値:
追加された子要素を表すXBRLInstanceElementオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newElementにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newElementに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数newElementに指定した要素が非アクティブで,かつ,引数newElementに指定した要素(タプルの場合は子孫要素を含む)のid属性と同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]

(51) insertChildElementBefore

public XBRLInstanceElement insertChildElementBefore(XBRLInstanceElement newElement,
                                                   XBRLInstanceElement refElement)

XBRLのバージョン:
2.0および2.1
説明:
引数newElementに指定した要素を,このインスタンス文書のルート要素の既存の子要素の前に挿入します。子要素は,アイテムまたはタプルです。
引数refElementがnullの場合,引数newElementに指定した要素は,このインスタンス文書のルート要素の子要素のリストの末尾に挿入されます。指定した要素がすでにほかのオブジェクトの子となっている場合は,最初に既存の親から指定した要素が削除されます。引数newElementに指定したXBRLInstanceElementオブジェクトが,引数refElementに指定したXBRLInstanceElementオブジェクトと同じ場合は,このメソッドは何もしません。
引数:
newElement - 挿入する子要素を表すXBRLInstanceElementオブジェクトを指定します。
refElement - 参照する子要素を表すXBRLInstanceElementオブジェクトを指定します。引数newElementで指定した子要素は,この子要素の直前に挿入されます。
戻り値:
挿入された子要素を表すXBRLInstanceElementオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newElementにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数refElementに指定した子要素が,このインスタンス文書のルート要素の子要素でない場合にスローされます。[エラーコード:20035]
  • 引数newElementに指定した要素が非アクティブで,かつ引数newElementに指定した要素(タプルの場合は子孫要素を含む)のid属性と同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]
  • 引数newElementに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]

(52) replaceChildElement

public XBRLInstanceElement replaceChildElement(XBRLInstanceElement newElement,
                                              XBRLInstanceElement oldElement)

XBRLのバージョン:
2.0および2.1
説明:
引数oldElementに指定した子要素を,引数newElementに指定した要素で置き換えます。子要素は,アイテムまたはタプルです。
指定した要素がすでにほかのオブジェクトの子となっている場合は,最初に既存の親から指定した要素が削除されます。引数newElementに指定したXBRLInstanceElementオブジェクトが引数oldElementに指定したXBRLInstanceElementオブジェクトと同じ場合は,このメソッドは何もしません。
置き換える前に,id属性の値が重複していないかがチェックされます。このチェックは,引数oldElementを含む置き換えられる前の文書の状態を基に実行されます。例えば,引数newElementに指定した要素が非アクティブで,かつ,引数newElementに指定した要素(タプルの場合は子孫要素を含む)のid属性の値が,引数oldElementで指定した要素(タプルの場合は子孫要素を含む)のid属性の値と重複している場合は,XBRLDOMRuntimeExceptionがスローされます。置き換えの対象となる要素のid属性と同じ値のid属性を持つ別の要素をインスタンス文書に追加したい場合は,XBRLInstanceDocument.removeChildElement(XBRLInstanceElement oldElement)メソッドで置き換えの対象となる要素を削除してから,追加してください。
引数:
newElement - 挿入する子要素を表すXBRLInstanceElementオブジェクトを指定します。
oldElement - 置き換えの対象となる子要素を表すXBRLInstanceElementオブジェクトを指定します。
戻り値:
置き換えの対象となった子要素を表すXBRLInstanceElementオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newElementまたはoldElementにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldElementに指定した子要素が,このインスタンス文書のルート要素の子要素でない場合にスローされます。[エラーコード:20035]
  • 引数newElementに指定した要素が非アクティブで,かつ引数newElementに指定した要素(タプルの場合は子孫要素を含む)のid属性と同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]
  • 引数newElementに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]

(53) removeChildElement

public XBRLInstanceElement removeChildElement(XBRLInstanceElement oldElement)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書のルート要素の子要素を削除します。子要素は,アイテムまたはタプルです。
引数:
oldElement - 削除する子要素を表すXBRLInstanceElementオブジェクトを指定します。
戻り値:
削除された子要素を表すXBRLInstanceElementオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数oldElementにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldElementに指定した子要素が,このインスタンス文書のルート要素の子要素でない場合にスローされます。[エラーコード:20035]

(54) getElements

public java.util.List<XBRLInstanceElement> getElements()

XBRLのバージョン:
2.0および2.1
説明:
このインスタンス文書に存在する要素のリストを取得します。要素は,アイテムまたはタプルです。
getChildElements()が,このXBRLInstanceDocumentオブジェクトのルート要素の子要素を取得するのに対して,このメソッドは,インスタンス文書に存在する要素を取得する点が異なります。
このメソッドが返すXBRLInstanceElementオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLInstanceElementオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に存在する要素をすべて含むXBRLInstanceElementオブジェクトのリストを返します。このインスタンス文書に要素がない場合は,要素数が0のリストを返します。

(55) getElements

public java.util.List<XBRLInstanceElement> getElements(java.lang.String namespaceURI,
                                 java.lang.String name)

XBRLのバージョン:
2.0および2.1
説明:
このインスタンス文書に存在する,指定した名前の要素のリストを取得します。要素は,アイテムまたはタプルです。
getChildElements()が,このXBRLInstanceDocumentオブジェクトのルート要素の子要素を取得するのに対して,このメソッドは,インスタンス文書に存在する要素を取得する点が異なります。
このメソッドが返すXBRLInstanceElementオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLInstanceElementオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
namespaceURI - 取得する要素の名前空間URIを指定します。
name - 取得する要素の名前を指定します。
戻り値:
引数namespaceURIで指定した名前空間URIに属し,引数nameで指定した名前を持つ要素をすべて含む,XBRLInstanceElementオブジェクトのリストを返します。このインスタンス文書に指定した要素がない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]

(56) createItem

public XBRLInstanceItem createItem(java.lang.String namespaceURI,
                                  java.lang.String name,
                                  XBRLContext context)

XBRLのバージョン:
2.0
説明:
アイテムを新規に生成します。
このメソッドが返すXBRLInstanceItemオブジェクトは,値が設定されていない状態となります。つまり,XBRLInstanceItemのhasValue()はfalseを返します。このメソッドでXBRLInstanceItemオブジェクトを生成したあと,XBRLInstanceItem.setValue()メソッドまたはXBRLInstanceItem.setString()メソッドを使用して適切な値を設定してください。
アイテムのid属性の値は,このメソッドでアイテムを生成する際に自動的に採番されます。id属性の値は,アイテムを生成する際に自動的に採番されますが,XBRLInstanceElement.setId()メソッドを使用して任意の値を設定することもできます。自動採番の詳細については,「3.3 ID管理と採番」を参照してください。
引数:
namespaceURI - アイテムの名前空間URIを指定します。
name - アイテムの名前を指定します。
context - アイテムが参照するコンテキストを指定します。
戻り値:
新しく生成されたXBRLInstanceItemオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数namespaceURI,nameまたはcontextにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数namespaceURIおよびnameで指定したアイテムがタクソノミー文書で定義されていない場合にスローされます。[エラーコード:20044]
  • 引数contextに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数contextが表すコンテキストが,引数namespaceURIおよびnameで指定したアイテムのデータ型に合わない場合にスローされます。[エラーコード:20032]
  • 引数namespaceURIおよびnameで指定したアイテムが,タクソノミー文書で抽象的な要素として定義されている場合にスローされます。[エラーコード:20065]

(57) createNumericItem

public XBRLInstanceItem createNumericItem(java.lang.String namespaceURI,
                                         java.lang.String name,
                                         XBRLContext context,
                                         XBRLUnit2 unit,
                                         XBRLPrecision precision,
                                         XBRLDecimals decimals)

XBRLのバージョン:
2.1
説明:
数値アイテムを新規に生成します。
このメソッドが返すXBRLInstanceItemオブジェクトは数値アイテムを表すため,XBRLInstanceItem.isNumeric()メソッドはtrueを返します。
このメソッドが返すXBRLInstanceItemオブジェクトは,値が設定されていない状態となります。つまり,XBRLInstanceItem.hasValue()はfalseを返します。このメソッドでXBRLInstanceItemオブジェクトを生成したあと,XBRLInstanceItem.setValue()メソッドまたはXBRLInstanceItem.setString()メソッドを使用して適切な値を設定してください。
アイテムが参照する単位要素には,アイテムのベースデータ型によって幾つかの制約があります。これらの制約に違反する単位要素を設定しようとした場合は,XBRLDOMRuntimeExceptionがスローされます。単位要素の制約については,XBRLInstanceItemインターフェースの「6.6.13(8) setUnit」を参照してください。
このメソッドで生成されたアイテムは,id属性を持ちません。
引数:
namespaceURI - アイテムの名前空間URIを指定します。
name - アイテムの名前を指定します。
context - アイテムが参照するコンテキスト要素を指定します。
unit - アイテムが参照する単位要素を指定します。
precision - アイテムのベースデータ型がFRACTION_ITEM以外である場合は,アイテムの有効桁数を指定します。引数decimalsに小数位を指定する場合は,この引数にはnullを指定してください。また,アイテムのベースデータ型がFRACTION_ITEMである場合はnullを指定してください。
decimals - アイテムのベースデータ型がFRACTION_ITEM以外である場合は,アイテムの小数位を指定します。引数precisionに有効桁数を指定する場合は,この引数にはnullを指定してください。また,アイテムのベースデータ型がFRACTION_ITEMである場合はnullを指定してください。
戻り値:
新しく生成されたXBRLInstanceItemオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数namespaceURI,name,contextまたはunitにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数namespaceURIおよびnameで指定したアイテムがタクソノミー文書で定義されていない場合にスローされます。[エラーコード:20044]
  • 引数namespaceURIおよびnameで指定したアイテムが非数値である場合にスローされます。[エラーコード:20131]
  • 引数namespaceURIおよびnameで指定したアイテムがタクソノミー文書で抽象的な要素として定義されている場合にスローされます。[エラーコード:20065]
  • 引数contextまたはunitに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数contextに指定したコンテキスト要素の時期要素の内容が,生成するアイテムの要素宣言でのxbrli:periodType属性の指定と矛盾している場合にスローされます。xbrli:periodType属性の値が"instant"の場合は,時期要素の内容はXBRLPeriod.INSTANTでなければなりません。また,xbrli:periodType属性の値が"duration"の場合は,時期要素の内容はXBRLPeriod.FOREVERかXBRLPeriod.STARTDATE_ENDDATEである必要があります。[エラーコード:20140]
  • 引数unitに指定したXBRLUnit2オブジェクトが,アイテムのベースデータ型による単位要素の制約に違反している場合にスローされます。単位要素の制約については,XBRLInstanceItemインターフェースの「6.6.13(8) setUnit」を参照してください。[エラーコード:20127]
  • 引数namespaceURIおよびnameで指定したアイテムのベースデータ型がFRACTION_ITEMである場合に,引数precisionまたはdecimalsにnull以外の値を指定した場合にスローされます。[エラーコード:20133]
  • 引数namespaceURIおよびnameで指定したアイテムのベースデータ型がFRACTION_ITEM以外で,かつ,引数precisionおよびdecimalsの両方ともにnullを指定した場合にスローされます。有効桁数と小数位はどちらか一方を指定する必要があります。[エラーコード:20134]
  • 引数namespaceURIおよびnameで指定したアイテムのベースデータ型がFRACTION_ITEM以外で,かつ,引数precisionおよびdecimalsの両方ともにnull以外の値を指定した場合にスローされます。有効桁数と小数位は,どちらか一方だけを指定する必要があります。[エラーコード:20135]

(58) createNonNumericItem

public XBRLInstanceItem createNonNumericItem(java.lang.String namespaceURI,
                                            java.lang.String name,
                                            XBRLContext2 context)

XBRLのバージョン:
2.1
説明:
非数値アイテムを新規に生成します。
このメソッドが返すXBRLInstanceItemオブジェクトは非数値アイテムを表すため,XBRLInstanceItem.isNumeric()メソッドはfalseを返します。
このメソッドが返すXBRLInstanceItemオブジェクトは,値が設定されていない状態となります。つまり,XBRLInstanceItem.hasValue()はfalseを返します。このメソッドでXBRLInstanceItemオブジェクトを生成したあと,XBRLInstanceItem.setValue()メソッドまたはXBRLInstanceItem.setString()メソッドを使用して適切な値を設定してください。
このメソッドで生成されたアイテムは,id属性を持ちません。
引数:
namespaceURI - アイテムの名前空間URIを指定します。
name - アイテムの名前を指定します。
context - アイテムが参照するコンテキスト要素を指定します。
戻り値:
新しく生成されたXBRLInstanceItemオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数namespaceURI,nameまたはcontextにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数namespaceURIおよびnameで指定されたアイテムがタクソノミー文書で定義されていない場合にスローされます。[エラーコード:20044]
  • 引数namespaceURIおよびnameで指定したアイテムが数値である場合にスローされます。[エラーコード:20132]
  • 引数namespaceURIおよびnameで指定したアイテムがタクソノミー文書で抽象的な要素として定義されている場合にスローされます。[エラーコード:20065]
  • 引数contextに指定されたオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数contextに指定したコンテキスト要素の時期要素の内容が,生成するアイテムの要素宣言でのxbrli:periodType属性の指定と矛盾している場合にスローされます。xbrli:periodType属性の値が "instant" の場合は,時期要素の内容はXBRLPeriod.INSTANTである必要があります。また,xbrli:periodType属性の値が "duration" の場合は,時期要素の内容はXBRLPeriod.FOREVERかXBRLPeriod.STARTDATE_ENDDATEである必要があります。[エラーコード:20140]

(59) createTuple

public XBRLInstanceTuple createTuple(java.lang.String namespaceURI,
                                    java.lang.String name)

XBRLのバージョン:
2.0および2.1
説明:
タプルを新規に生成します。
  • XBRL2.0の場合:
    タプルのid属性の値は,このメソッドでタプルを生成する際に自動的に採番されます。自動採番機能の詳細については,「3.3 ID管理と採番」を参照してください。また,id属性値は,XBRLInstanceElementのsetId()メソッドを使用して任意の値を設定することもできます。
  • XBRL2.1の場合:
    このメソッドで生成されたタプルはid属性を持ちません。
引数:
namespaceURI - タプルの名前空間URIを指定します。
name - タプルの名前を指定します。
戻り値:
新しく生成されたXBRLInstanceTupleオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数namespaceURIおよびnameで指定したタプルがタクソノミー文書で定義されていない場合にスローされます。[エラーコード:20045]
  • 引数namespaceURIおよびnameで指定されたタプルが,タクソノミー文書で抽象的な要素として定義されている場合にスローされます。[エラーコード:20065]

(60) createEntity

public XBRLEntity createEntity(XBRLIdentifier identifier,
                              XBRLSegment segment)

XBRLのバージョン:
2.0および2.1
説明:
エンティティ要素を表すXBRLEntityオブジェクトを新規に生成します。
引数:
identifier - 識別子要素を指定します。
segment -セグメント要素を指定します。セグメント要素がない場合はnullを指定します。
戻り値:
新しく生成されたXBRLEntityオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数identifierにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数identifierまたはsegmentに指定したオブジェクトが,すでにほかのXBRLEntityオブジェクトに関連づけられている場合にスローされます。[エラーコード:20005]
  • 引数identifierまたはsegmentに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]

(61) createPeriod

public XBRLPeriod createPeriod(int periodType,
                              XBRLDateUnion instant,
                              XBRLDateUnion startDate,
                              XBRLDateUnion endDate,
                              XBRLDuration duration)

XBRLのバージョン:
2.0および2.1
説明:
時期要素であるXBRLPeriodオブジェクトを新規に生成します。
  • XBRL2.1の場合:
    xbrli:duration要素を使用できないため,引数periodTypeにXBRLPeriod.STARTDATE_DURATIONおよびXBRLPeriod.DURATION_ENDDATEを指定できません。
開始日と終了日のチェック
引数periodTypeにXBRLPeriod.STARTDATE_ENDDATEを指定した場合は,引数endDateで指定された終了日は引数startDateで指定された開始日よりも遅い日時である必要があります。終了日が開始日よりも遅い日時でない場合は,XBRLDOMRuntimeExceptionがスローされます。このチェックを行う際に,開始日または終了日に時間の部分がない場合(つまり,XBRLDateUnion.getMemberType()メソッドがXBRLDateUnion.DATEを返す場合)は,次の規則が適用されます。
  • 開始日に時間の部分がない場合は,日付の部分は同じで,時間の部分は00:00:00.000である日時が指定されたものとみなします。
  • 終了日に時間の部分がない場合は,XBRLのバージョンによって次のとおりに処理します。
    XBRL2.0の場合,日付の部分は同じで,時間の部分は00:00:00.000である日時が指定されたものとみなします。
    XBRL2.1の場合,日付の部分は一日足した値で,時間の部分は00:00:00.000である日時が指定されたものとみなします。
終了日の判定はXBRLのバージョンによって異なります。このため,終了日が開始日よりも遅いかどうかの判定結果が,XBRLのバージョンによって異なる場合があります。例えば,開始日と終了日がともに2004-04-01である場合,開始日は2004-04-01T00:00:00.000とみなされますが,終了日は,XBRL2.0の場合は2004-04-01T00:00:00.000,XBRL2.1の場合は2004-04-02T00:00:00.000とみなされます。この結果,XBRL2.0の場合は終了日が開始日よりの遅い日時ではないためエラーとなりますが,XBRL2.1では終了日は開始日よりも遅い日時となるためエラーとはなりません。
引数:
periodType - 時期要素の内容の意味を示すコードを指定します。
instant - ある特定の時点を指定します。ある特定の時点が不要な場合はnullを指定します。
startDate - 開始日を指定します。開始日が不要な場合はnullを指定します。
endDate - 終了日を指定します。終了日が不要な場合はnullを指定します。
duration - 継続期間を指定します。継続期間が不要な場合はnullを指定します。
戻り値:
新しく生成されたXBRLPeriodオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数の組み合わせが不正な場合にスローされます。引数instant,startDate,endDate,durationの組み合わせは,引数periodTypeの値によって異なります。詳細については,「6.6.22 XBRLPeriodインターフェース」を参照してください。[エラーコード:20056]
  • 引数periodTypeにXBRLPeriod.STARTDATE_ENDDATEを指定したときに,引数startDateで指定した開始日と引数endDateで指定した終了日の組み合わせが不正な場合にスローされます。終了日は開始日よりも遅い日付でなければなりません。[エラーコード:20057]
  • 引数periodTypeに不正な値を指定した場合にスローされます。引数periodTypeに指定できる値は,XBRLPeriod.INSTANT,XBRLPeriod.FOREVER,XBRLPeriod.STARTDATE_DURATION,XBRLPeriod.DURATION_ENDDATE,XBRLPeriod.STARTDATE_ENDDATEのどれかです。[エラーコード:20014]
  • 引数periodTypeにXBRLPeriod.STARTDATE_DURATIONまたはXBRLPeriod.DURATION_ENDDATEを指定し,かつ,引数durationにゼロ(例:P0Y)や負数(例:-P1Y)を表すXBRLDurationオブジェクトを指定した場合にスローされます。[エラーコード:20071]
  • XBRL2.1の場合:引数periodTypeにXBRLPeriod.STARTDATE_DURATIONまたはXBRLPeriod.DURATION_ENDDATEを指定した場合にスローされます。[エラーコード:20142]

(62) createPeriod

public XBRLPeriod createPeriod()

XBRLのバージョン:
2.1
説明:
時期要素であるXBRLPeriodオブジェクトを新規に生成します。
このメソッドで生成される時期要素の内容の意味は"永遠"です。つまり,XBRLPeriod.getPeriodType()メソッドはXBRLPeriod.FOREVERを返します。
戻り値:
新しく生成されたXBRLPeriodオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(63) createPeriod

public XBRLPeriod createPeriod(XBRLDateUnion instant)

XBRLのバージョン:
2.1
説明:
時期要素であるXBRLPeriodオブジェクトを新規に生成します。
このメソッドで生成される時期要素の内容の意味は"ある特定の時点"です。つまり,XBRLPeriod.getPeriodType()メソッドはXBRLPeriod.INSTANTを返します。
引数:
instant - ある特定の時点を指定します。
戻り値:
新しく生成されたXBRLPeriodオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数instantにnullを指定した場合にスローされます。[エラーコード:20002]

(64) createPeriod

public XBRLPeriod createPeriod(XBRLDateUnion startDate,
                              XBRLDateUnion endDate)

XBRLのバージョン:
2.1
説明:
時期要素であるXBRLPeriodオブジェクトを新規に生成します。
このメソッドで生成される時期要素の内容の意味は"開始日,終了日"です。つまり,XBRLPeriod.getPeriodType()メソッドはXBRLPeriod.STARTDATE_ENDDATEを返します。
引数endDateで指定された終了日は引数startDateで指定された開始日よりも遅い日時である必要があります。開始日と終了日のチェックに関する詳細については,「6.6.7(61) createPeriod」を参照してください。
引数:
startDate - 開始日を指定します。
endDate - 終了日を指定します。
戻り値:
新しく生成されたXBRLPeriodオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数startDateまたはendDateにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数startDateで指定された開始日と引数endDateで指定された終了日の組み合わせが不正な場合にスローされます。終了日は開始日よりも遅い日付である必要があります。[エラーコード:20057]

(65) createUnit

public XBRLUnit createUnit(XBRLMeasureOrOperator measureOrOperator)

XBRLのバージョン:
2.0
説明:
単位要素であるXBRLUnitオブジェクトを新規に生成します。
引数:
measureOrOperator - 計量要素または演算子要素を指定します。
戻り値:
新しく生成されたXBRLUnitオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数measureOrOperatorにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数measureOrOperatorに指定したオブジェクトが,すでにほかのXBRLUnitオブジェクトに関連づけられている場合にスローされます。[エラーコード:20005]
  • 引数measureOrOperatorに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]

(66) createScenario

public XBRLScenario createScenario(java.lang.String name)

XBRLのバージョン:
2.0
説明:
シナリオ要素であるXBRLScenarioオブジェクトを新規に生成します。
引数:
name - name属性の値を指定します。name属性が不要な場合はnullを指定します。
戻り値:
新しく生成されたXBRLScenarioオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]

(67) createScenario

public XBRLScenario createScenario()

XBRLのバージョン:
2.1
説明:
シナリオ要素であるXBRLScenarioオブジェクトを新規に生成します。
XBRL仕様では,シナリオ要素は一つ以上の子要素を持つ必要があると定義されています。しかし,このメソッドでシナリオ要素を生成した直後は,シナリオ要素の内容は空です。このため,このメソッドでシナリオ要素を生成した場合は,必ず子要素を追加してください。シナリオ要素の内容は,XBRLScenario.getContainerNode()メソッドを呼び出して取得したorg.w3c.dom.Nodeオブジェクトを使用して編集できます。詳細については,XBRLScenarioインターフェースの「6.6.24(3) getContainerNode」を参照してください。
戻り値:
新しく生成されたXBRLScenarioオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(68) createIdentifier

public XBRLIdentifier createIdentifier(java.lang.String namespaceURI,
                                      java.lang.String value)

XBRLのバージョン:
2.0および2.1
説明:
識別子要素であるXBRLIdentifierオブジェクトを新規に生成します。
引数:
namespaceURI - スキーマの名前空間URIを指定します。
value - 識別子を指定します。
戻り値:
新しく生成されたXBRLIdentifierオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数namespaceURIまたはvalueにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数namespaceURIに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • XBRL2.1の場合:引数namespaceURIに空文字列("")を指定した場合にスローされます。[エラーコード:20110]

(69) createSegment

public XBRLSegment createSegment(java.lang.String name)

XBRLのバージョン:
2.0
説明:
セグメント要素であるXBRLSegmentオブジェクトを新規に生成します。
引数:
name - name属性の値を指定します。name属性が不要な場合はnullを指定します。
戻り値:
新しく生成されたXBRLSegmentオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]

(70) createSegment

public XBRLSegment createSegment()

XBRLのバージョン:
2.1
説明:
セグメント要素であるXBRLSegmentオブジェクトを新規に生成します。
XBRL仕様では,セグメント要素は一つ以上の子要素を持つ必要があると定義されています。しかし,このメソッドでセグメント要素を生成した直後は,セグメント要素の内容は空です。このため,このメソッドでセグメント要素を生成した場合は,必ず子要素を追加してください。セグメント要素の内容は,XBRLSegment.getContainerNode()メソッドを呼び出して取得したorg.w3c.dom.Nodeオブジェクトを使用して編集できます。詳細については,XBRLSegmentインターフェースの「6.6.26(3) getContainerNode」を参照してください。
戻り値:
新しく生成されたXBRLSegmentオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(71) createMeasure

public XBRLMeasure createMeasure(XBRLQName value)

XBRLのバージョン:
2.0
説明:
計量要素であるXBRLMeasureオブジェクトを新規に生成します。
引数:
value - 計量を指定します。
戻り値:
新しく生成されたXBRLMeasureオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数valueにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数valueに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が,このXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
  • 引数valueに指定したXBRLQNameオブジェクトが名前空間に属さず,かつこのXBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]

(72) createOperator

public XBRLOperator createOperator(java.lang.String kind,
                                  XBRLMeasureOrOperator lhs,
                                  XBRLMeasureOrOperator rhs)

XBRLのバージョン:
2.0
説明:
演算子要素であるXBRLOperatorオブジェクトを新規に生成します。
引数:
kind - 乗算の場合はXBRLOperator.MULTIPLY,除算の場合はXBRLOperator.DIVIDEを指定します。
lhs - 演算子の左辺を指定します。
rhs - 演算子の右辺を指定します。
戻り値:
新しく生成されたXBRLOperatorオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数kind,lhsまたはrhsにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数lhsまたはrhsに指定したオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • 引数lhsまたはrhsに指定したオブジェクトが,すでにほかのXBRLOperatorオブジェクトに関連づけられている場合にスローされます。[エラーコード:20005]
  • 引数kindに,XBRLOperator.MULTIPLYまたはXBRLOperator.DIVIDE以外の文字列を指定した場合にスローされます。[エラーコード:20014]
  • 引数lhsと引数rhsに同じオブジェクトを指定した場合にスローされます。[エラーコード:20064]

(73) getFootnotes

public java.util.List<XBRLFootnote> getFootnotes()

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている脚注のリストを取得します。
XBRLInstanceDocumentインターフェースのgetFootnotes()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得する脚注のリストに含まれます。
しかし,XBRLInstanceElementインターフェースのgetFootnotes()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得する脚注のリストには含まれません。
このメソッドが返す脚注のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる脚注に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このインスタンス文書に存在する脚注をすべて含む,XBRLFootnoteオブジェクトのリストを返します。このインスタンス文書に脚注がない場合は,要素数が0のリストを返します。

(74) getFootnotesByLang

public java.util.List<XBRLFootnote> getFootnotesByLang(java.lang.String lang)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている脚注のうち,指定した言語の脚注を取得します。
XBRLInstanceDocumentインターフェースのgetFootnotesByLang()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得する脚注のリストに含まれます。
しかし,XBRLInstanceElementインターフェースのgetFootnotesByLang()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得する脚注のリストには含まれません。
このメソッドが返す脚注のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる脚注に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
lang - 脚注の言語を指定します。
戻り値:
指定した言語の脚注をすべて含むXBRLFootnoteオブジェクトのリストを返します。このインスタンス文書に指定した言語の脚注がない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(75) getFootnotesByRole

public java.util.List<XBRLFootnote> getFootnotesByRole(java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている脚注のうち,指定したロールの脚注を取得します。
XBRLInstanceDocumentインターフェースのgetFootnotesByRole()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得する脚注のリストに含まれます。
しかし,XBRLInstanceElementインターフェースのgetFootnotesByRole()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得する脚注のリストには含まれません。
このメソッドが返す脚注のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる脚注に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
role - 脚注のロールを指定します。ロールを持たない脚注を取得する場合はnullを指定します。
戻り値:
指定したロールを持つ脚注をすべて含むXBRLFootnoteオブジェクトのリストを返します。このインスタンス文書に指定したロールを持つ脚注が存在しない場合は,要素数が0のリストを返します。

(76) getFootnotes

public java.util.List<XBRLFootnote> getFootnotes(java.lang.String lang,
                                  java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている脚注のうち,指定した言語およびロールの脚注を取得します。
XBRLInstanceDocumentインターフェースのgetFootnotes()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得する脚注のリストに含まれます。
しかし,XBRLInstanceElementインターフェースのgetFootnotes()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得する脚注のリストには含まれません。
このメソッドが返す脚注のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる脚注に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
lang - 脚注の言語を指定します。
role - 脚注のロールを指定します。ロールを持たない脚注を取得する場合はnullを指定します。
戻り値:
指定した言語とロールを持つ脚注をすべて含む,XBRLFootnoteオブジェクトのリストを返します。このインスタンス文書に指定した言語とロールを持つ脚注がない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(77) addFootnote

public XBRLFootnote addFootnote(XBRLFootnote newFootnote)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に脚注を追加します。指定したXBRLFootnoteオブジェクトがすでにこのインスタンス文書にある場合は,何もしません。
引数:
newFootnote - 追加する脚注を表すXBRLFootnoteオブジェクトを指定します。
戻り値:
追加された脚注を表すXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newFootnoteにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newFootnoteに指定したXBRLFootnoteオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトではない場合にスローされます。[エラーコード:20021]
  • XBRL2.1の場合:引数newFootnoteに指定された脚注のid属性と同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]

(78) removeFootnote

public XBRLFootnote removeFootnote(XBRLFootnote oldFootnote)

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書から脚注を削除します。
脚注をインスタンス文書から削除すると,その脚注と要素の関連づけもすべて削除されます。削除されるのは関連づけであり,要素がインスタンス文書から削除されるわけではありません。
引数:
oldFootnote - 削除する脚注を表すXBRLFootnoteオブジェクトを指定します。
戻り値:
削除された脚注を表すXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数oldFootnoteにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldFootnoteに指定した脚注が,このインスタンス文書にない場合にスローされます。[エラーコード:20046]

(79) createFootnote

public XBRLFootnote createFootnote(java.lang.String lang,
                                  java.lang.String role,
                                  java.lang.String title)

XBRLのバージョン:
2.0および2.1
説明:
脚注であるXBRLFootnoteオブジェクトを新規に生成します。
  • XBRL2.1の場合:
    脚注が属する脚注リンクのロールは,XBRL2.1の仕様で規定されている標準値である"http://www.xbrl.org/2003/role/link" が仮定されます。脚注が属する脚注リンクのロールとしてカスタムロールを指定したい場合は,createFootnote(java.lang.String footnoteLinkRole, java.lang.String lang, java.lang.String role, java.lang.String title)メソッドを使用してください。
引数:
lang - 脚注の言語を指定します。
role - 脚注のロールを指定します。ロールが不要な場合はnullを指定します。
title - 脚注のタイトルを指定します。タイトルが不要な場合はnullを指定します。
戻り値:
新しく生成されたXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数roleに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • 引数roleに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]
  • XBRL2.1の場合:引数roleに指定したロールがXBRL仕様で規定された標準値で,かつ,脚注で利用できるものではない場合にスローされます。[エラーコード:20115]
  • XBRL2.1の場合:引数roleに指定したロールがカスタムロールで,かつ,そのカスタムロールの定義を指す<link:roleRef>要素がインスタンス文書に存在しない場合にスローされます。[エラーコード:20117]
  • XBRL2.1の場合:引数roleに指定したロールがカスタムロールで,かつ,<link:roleType>要素でそのカスタムロールが脚注で利用できるように定義されていない場合にスローされます。[エラーコード:20119]

(80) createFootnote

public XBRLFootnote createFootnote(java.lang.String footnoteLinkRole,
                                  java.lang.String lang,
                                  java.lang.String role,
                                  java.lang.String title)

XBRLのバージョン:
2.1
説明:
脚注であるXBRLFootnoteオブジェクトを新規に生成します。カスタムロールを指定できます。
このメソッドで生成された脚注はid属性を持ちません。
引数:
footnoteLinkRole - 脚注が属する脚注リンクのロールを指定します。
lang - 脚注の言語を指定します。
role - 脚注のロールを指定します。ロールが不要な場合はnullを指定します。
title - 脚注のタイトルを指定します。タイトルが不要な場合はnullを指定します。
戻り値:
新しく生成されたXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数footnoteLinkRoleまたはlangにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数footnoteLinkRoleまたはroleに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • 引数footnoteLinkRoleまたはroleに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]
  • 引数footnoteLinkRoleに指定したロールがXBRL仕様で規定された標準値で,かつ,脚注リンクで利用できるものではない場合にスローされます。[エラーコード:20115]
  • 引数roleに指定したロールがXBRL仕様で規定された標準値で,かつ,脚注で利用できるものではない場合にスローされます。[エラーコード:20115]
  • 引数footnoteLinkRoleまたはroleに指定したロールがカスタムロールで,かつ,そのカスタムロールの定義を指す<link:roleRef>要素がインスタンス文書に存在しない場合にスローされます。[エラーコード:20117]
  • 引数footnoteLinkRoleに指定したロールがカスタムロールで,かつ,<link:roleType>要素でそのカスタムロールが脚注リンクで利用できるように定義されていない場合にスローされます。[エラーコード:20119]
  • 引数roleに指定したロールがカスタムロールで,かつ,<link:roleType>要素でそのカスタムロールが脚注で利用できるように定義されていない場合にスローされます。[エラーコード:20119]

(81) importNode

public XBRLInstanceNode importNode(XBRLInstanceNode sourceNode,
                                  boolean deep)

XBRLのバージョン:
2.0および2.1
説明:
ほかのXBRLInstanceDocumentオブジェクトで生成されたノードをインポートします。
このメソッドが返すノードはアクティブではなく,また,親ノードを持ちません。つまり,このメソッドが返すXBRLInstanceNodeオブジェクトのisActive()はfalseを返し,また,getParentNode()はnullを返します。
引数sourceNodeに指定したノードを所有するXBRLInstanceDocumentオブジェクトが,このXBRLInstanceDocumentオブジェクトである場合は,importNode()メソッドの動作は,引数sourceNodeに対してcloneNode()メソッドを呼び出した場合と同じ動作となります。この場合の動作の詳細については,XBRLInstanceNodeインターフェースの「6.6.14(5) cloneNode」を参照してください。
ノードをインポートする処理は,ノードの型によって異なります。ノードのインポートを次の表に示します。

表6-25 ノードのインポート

項番ノードの型説明
1INSTANCE_DOCUMENT_NODEこの型のノードはインポートできません。インポートしようとすると例外が発生します。
2SCHEMA_REF_NODEサブツリーが存在しないため,引数deepの値は影響しません。
3LINKBASE_REF_NODE
4ROLE_REF_NODE
5ARCROLE_REF_NODE
6NUMERIC_CONTEXT_NODE引数deepの値に関係なく,常にサブツリーがインポートされます。
インポートされたコンテキスト要素のid属性の値は採番し直されます。
7NON_NUMERIC_CONTEXT_NODE
8CONTEXT2_NODE
9UNIT2_NODEサブツリー※1が存在しないため,引数deepの値は影響しません。インポートされた単位要素のid属性の値は採番し直されます。
10ITEM_NODEアイテムにはサブツリー※1が存在しないため,引数deepの値は影響しません。
アイテムをインポートする際に,インポート元が参照しているコンテキスト要素も同時にインポートされます。
XBRL2.1の場合:数値アイテムをインポートするときは,インポート元が参照している単位要素も同時にインポートされます。
インポート元のアイテムが脚注と関連づけられていた場合でも,その脚注は自動的にインポートされません。インポートされたアイテムはどの脚注とも関連づけされません。
アイテムをインポートする場合は,インポートしようとしたアイテムと同じ名前空間URIおよび名前のアイテムが,インポート先のインスタンス文書が参照するタクソノミー文書で定義されている必要があります。同じ名前空間URIおよび名前のアイテムが定義されていない場合は,例外が発生します。また,同じ名前空間URIおよび名前のアイテムが定義されている場合でも,データ型が異なるために,インポート元のアイテムの値をインポート先のアイテムへ設定できない場合は,例外が発生します。
XBRL2.1の場合:インポート元でのアイテムの要素宣言と,インポート先でのアイテムの要素宣言は,次の定義内容が同じである必要があります。
  • ベースデータ型
  • xbrli:periodType属性の値
インポート元とインポート先とで上記の定義内容が異なるアイテムをインポートしようとした場合は,例外が発生します。
 
XBRL2.1の場合:インポート元のアイテムのxsi:nil属性に"true"が指定されていて,かつ,インポート先のアイテムの要素宣言のnillable属性に"true"が指定されていない場合は,インポート先のアイテムにxsi:nil属性を設定できないため例外が発生します。
 
XBRL2.0の場合:インポートされたアイテムのid属性の値は採番し直されます。
XBRL2.1の場合:インポートされたアイテムはid属性を持ちません。
11TUPLE_NODE引数deepがtrueの場合は,タプルの子要素もすべてインポートされます。
引数deepがfalseの場合は,子要素はインポートされません。
タプルをインポートする場合は,インポートしようとしたタプルと同じ名前空間URIおよび名前のタプルが,インポート先のインスタンス文書が参照するタクソノミー文書で定義されている必要があります。同じ名前空間URIおよび名前のタプルが定義されていない場合は,例外が発生します。
 
XBRL2.1の場合:インポート元のタプルのxsi:nil属性に "true" が指定されていて,かつ,インポート先のタプルの要素宣言のnillable属性に"true"が指定されていない場合は,インポート先のタプルにxsi:nil属性を設定できないため例外が発生します。
 
XBRL2.0の場合:インポートされたタプルのid属性の値は採番し直されます。
XBRL2.1の場合:インポートされたタプルはid属性を持ちません。
12ENTITY_NODE引数deepの値に関係なく,常にサブツリーがインポートされます。
13PERIOD_NODE
14UNIT_NODE
15OPERATOR_NODE
16IDENTIFIER_NODEサブツリー※1がないため,引数deepの値は影響しません。
17SEGMENT_NODEXBRL Dimensions1.0ではない場合:サブツリー※1が存在しないため,引数deepの値は影響しません。
XBRL Dimensions1.0の場合:引数deepがtrueの場合は,セグメント要素に含まれている<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素がすべてインポートされます。
引数deepがfalseの場合は,セグメント要素に含まれている<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素がすべてインポートされません。
18MEASURE_NODEサブツリー※1がないため,引数deepの値は影響しません。
19SCENARIO_NODEXBRL Dimensions1.0ではない場合:サブツリー※1が存在しないため,引数deepの値は影響しません。
XBRL Dimensions1.0の場合:引数deepがtrueの場合は,シナリオ要素に含まれている<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素がすべてインポートされます。
引数deepがfalseの場合は,シナリオ要素に含まれている<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素がすべてインポートされません。
20FOOTNOTE_NODEサブツリー※1がないため,引数 deep の値は影響しません。
なお,インポート元の脚注がアイテムと関連づけられていた場合でも,そのアイテムは自動的にインポートされません。インポートされた脚注はどのアイテムとも関連づけられていない状態となります。
XBRL2.1の場合:インポートされた脚注はid属性を持ちません。
21EXPLICIT_MEMBER_NODE※2サブツリー※1が存在しないため,引数deepの値は影響しません。
22TYPED_MEMBER_NODE※2サブツリー※1が存在しないため,引数deepの値は影響しません。

注※1 ここでのサブツリーとは,XBRL DOMのノード(XBRLInstanceNodeオブジェクト)によって構築されるツリーでのサブツリーのことです。W3C DOMのノード(org.w3c.dom.Nodeオブジェクト)によって構築されるツリーでのサブツリーではないので注意してください。

例えば,単位要素の子として記述される<xbrli:divide>要素は,XBRL DOMではXBRLUnit2オブジェクトの子ノードとしては表現されませんが,W3C DOMでは<xbrli:divide>要素は<xbrli:unit>要素を表すノードの子ノードとして表現されます。そのため,XBRLUnit2オブジェクトをインポートすると,W3C DOMではサブツリーとなっている<xbrli:divide>要素を表すノードやその子孫(<xbrli:unitNumerator>要素を表すノードや<xbrli:unitDenominator>要素を表すノード)もインポートされます。

これは,データ型がFRACTION_ITEMであるアイテム,XHTMLのタグを内容として持つ脚注,任意の子要素を記述できるセグメント要素やシナリオ要素についても同じです。

注※2 XBRL Dimensions1.0の場合だけ存在します。


引数:
sourceNode - インポートされるノードを表すXBRLInstanceNodeオブジェクトを指定します。
deep - 引数sourceNodeに指定したノードのサブツリーをインポートする場合はtrue,サブツリーをインポートしない場合はfalseを指定します。
戻り値:
インポートされたノードを返します。
例外:
XBRLDOMRuntimeException -
  • 引数sourceNodeにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数sourceNodeに指定されたノードを所有するXBRLInstanceDocumentオブジェクトが準拠しているXBRLのバージョンと,このXBRLInstanceDocumentオブジェクトが準拠しているXBRLのバージョンが異なる場合にスローされます。[エラーコード:20104]
  • 引数sourceNodeに指定したノードが,インポートできない型である場合にスローされます。[エラーコード:20048]
  • XBRL2.1の場合:引数sourceNodeに指定されたノードの型がITEM_NODEで,かつ,インポート元でのアイテムの要素宣言とインポート先でのアイテムの要素宣言で,ベースデータ型またはxbrli:periodType属性の値が異なる場合にスローされます。[エラーコード:20145]

(82) cloneNode

public XBRLInstanceDocument cloneNode(org.w3c.dom.Document w3cdomDocument,
                                     boolean deep)

XBRLのバージョン:
2.1
説明:
インスタンス文書を複製します。
引数deepがtrueの場合は,インスタンス文書のルート要素の内容がすべて複製されます。引数deepがfalseの場合は,インスタンス文書のルート要素の内容は複製されません。つまり,複製されたインスタンス文書は空です。ただし,名前空間宣言やxsi:schemaLocation属性など,ルート要素の属性は常に複製されます。
ルート要素の挿入
複製されたXBRLInstanceDocumentオブジェクトのルート要素は,複製直後はDOMツリーにつながっていない状態となっています。このため,ユーザーアプリケーションでは,W3C DOMのAPIを使用して,複製されたインスタンス文書のルート要素を引数w3cdomDocumentに指定したXML文書の任意の位置へ挿入する必要があります。ただし,同一XML文書に記述されているほかのインスタンス文書の中に挿入してはいけません。インスタンス文書のルート要素を表すorg.w3c.dom.Elementオブジェクトは,XBRLInstanceDocument.getInstanceRoot()メソッドを使用して取得できます。
出発点となったタクソノミー本体およびリンクベースの指定
引数deepがfalseの場合は,複製元の<link:schemaRef>要素や<link:linkbaseRef>要素は複製されません。このため,引数deepにfalseを指定してインスタンス文書を複製した場合は,タクソノミー文書を構築する際の出発点となったタクソノミー本体およびリンクベースのリストをXBRLTaxonomyDocument.getStartingPoints()メソッドによって取得し,出発点となったタクソノミー本体およびリンクベースを指す<link:schemaRef>要素および<link:linkbaseRef>要素をインスタンス文書に追加する必要があります。このとき,各要素のxlink:href属性に指定するURIは,絶対URI,相対URIのどちらでもかまいません。ただし,インスタンス文書をストリームへ出力してから再度読み込んだ際に,それらのURIは適切な文書へ解決される必要があります。なお,必要な<link:schemaRef>要素および<link:linkbaseRef>要素を追加しなかった場合は,インスタンス文書をストリームへ出力してから再度読み込んだ場合に,タクソノミー文書を構成するタクソノミー本体またはリンクベースが不足するおそれがあるため,注意してください。
参照するタクソノミー文書
複製されたXBRLInstanceDocumentオブジェクトは,複製元のXBRLInstanceDocumentオブジェクトが参照しているXBRLTaxonomyDocumentオブジェクトの複製を参照します。つまり,XBRLInstanceDocument.getTaxonomyDocument()メソッドの戻り値は,複製元のXBRLInstanceDocumentオブジェクトと複製先のXBRLInstanceDocumentオブジェクトで異なります。ただし,それぞれが参照するXBRLTaxonomyDocumentオブジェクトの内容は同じです。
ルート要素のid属性
複製されたインスタンス文書のルート要素はid属性を持ちません。引数deepにtrueが指定された場合は,インスタンス文書の内容が複製されますが,複製された各ノードがid属性を持つかどうかについては,XBRLInstanceNodeインターフェースの「6.6.14(5) cloneNode」を参照してください。
XBRLIdCreatorオブジェクトの引き継ぎ
インスタンス文書のIDを管理するXBRLIdManagerオブジェクトは新規に作成されるため,複製元のインスタンス文書と複製されたインスタンス文書とでIDを管理するXBRLIdManagerオブジェクトは異なります。ただし,XBRLIdManagerオブジェクトに設定されているXBRLIdCreatorオブジェクトは引き継がれます。つまり,複製元のXBRLInstanceDocumentオブジェクトと複製されたXBRLInstanceDocumentオブジェクトとで,getIdManager()メソッドが返すXBRLIdManagerオブジェクトは異なりますが,getIdManager().getIdCreator()によって取得できるXBRLIdCreatorオブジェクトは同一のものとなります。このため,インスタンス文書を複製する際にコンテキスト要素などのid属性の値が採番し直されますが,このときに複製元と同じXBRLIdCreatorオブジェクトを使用してIDが生成されることになります。
引数:
w3cdomDocument - インスタンス文書を挿入したいXML文書を表すorg.w3c.dom.Documentオブジェクトを指定します。
deep - ノードのサブツリーを複製する場合はtrue,サブツリーを複製しない場合はfalseを指定します。
戻り値:
このノードの複製を返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数w3cdomDocumentにnullを指定した場合にスローされます。[エラーコード:20002]

(83) createExplicitMember

public XBRLExplicitMember createExplicitMember(XBRLQName dimension,
                                              XBRLQName value)

XBRLバージョン:
2.1
XBRL Dimensionsバージョン:
1.0
説明:
<xbrldi:explicitMember>要素を表すXBRLExplicitMemberオブジェクトを新規に生成します。
引数:
dimension - dimension属性の値を指定します。
value - <xbrldi:explicitMember>要素の内容を指定します。
戻り値:
新しく生成されたXBRLExplicitMemberオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
  • 引数dimensionまたは引数valueにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数dimensionまたは引数valueに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が,このXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
  • 引数dimensionまたは引数valueに指定されたXBRLQNameオブジェクトが名前空間に属さないで,かつ,このXBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]
  • 引数dimensionで指定したディメンジョンがタクソノミー文書で定義されていない場合にスローされます。[エラーコード:22106]
  • 引数valueで指定したアイテムがタクソノミー文書で定義されていない場合にスローされます。[エラーコード:20044]

(84) createTypedMember

public XBRLTypedMember createTypedMember(XBRLQName dimension)

XBRLバージョン:
2.1
XBRL Dimensionsバージョン:
1.0
説明:
<xbrldi:typedMember>要素を表すXBRLTypedMemberオブジェクトを新規に生成します。
引数:
dimension - dimension属性の値を指定します。
戻り値:
新しく生成されたXBRLTypedMemberオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
  • 引数dimensionにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数dimensionに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が,このXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
  • 引数dimensionに指定したXBRLQNameオブジェクトが名前空間に属さないで,かつ,XBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]
  • 引数dimensionで指定したディメンジョンがタクソノミー文書で定義されていない場合にスローされます。[エラーコード:22106]

(85) getDimensionsVersion

public int getDimensionsVersion()

XBRLバージョン:
2.1
説明:
インスタンス文書が準拠しているXBRL Dimensionsのバージョンを取得します。
cbrp.parse.DimensionsVersionプロパティの値は,インスタンス文書がXBRL2.1に準拠している場合だけ使用されます。インスタンス文書がほかのXBRLのバージョンに準拠している場合は,cbrp.parse.DimensionsVersionプロパティの値は使用されません。
戻り値:
このインスタンス文書がXBRL Dimensions1.0に準拠している場合はXBRLConstants.DIMENSIONS_1_0を返します。XBRL Dimensions1.0に準拠していない場合はXBRLConstants.DIMENSIONS_NONEを返します。