6.6.12 XBRLInstanceElementインターフェース

public interface XBRLInstanceElement
extends XBRLInstanceNode

XBRLのバージョン:
2.0および2.1
説明:
インスタンス文書に記述されている要素を表します。要素は,タクソノミー文書で定義されるアイテムまたはタプルです。
要素がアイテムまたはタプルのどちらかは,getElementType()で調べることができます。getElementType()がITEM_ELEMENTを返した場合はXBRLInstanceItemへ,TUPLE_ELEMENTを返した場合はXBRLInstanceTupleへキャストできます。
XBRLInstanceElementオブジェクトは,XBRLInstanceDocumentオブジェクトまたはXBRLInstanceTupleオブジェクトの子となることができます。
非アクティブなXBRLInstanceElementオブジェクトを,XBRLInstanceDocumentオブジェクトまたはアクティブなXBRLInstanceTupleオブジェクトの子として設定すると,子として設定されたXBRLInstanceElementオブジェクトは非アクティブな状態からアクティブな状態へと変化します。
また,XBRLInstanceElementオブジェクトが非アクティブなXBRLInstanceTupleオブジェクトの子である場合はそのXBRLInstanceElementオブジェクトも非アクティブです。しかし,親である非アクティブなXBRLInstanceTupleオブジェクトまたはその祖先に当たるXBRLInstanceTupleオブジェクトが,XBRLInstanceDocumentオブジェクトまたはアクティブなXBRLInstanceTupleオブジェクトの子として設定され,アクティブになった場合,その子または子孫であるXBRLInstanceElementオブジェクトも同時にアクティブな状態へと変化します。
このようにしてXBRLInstanceElementオブジェクトが非アクティブな状態からアクティブな状態へ変化する際に,XBRLInstanceElementオブジェクトと関連づけられているXBRLFootnoteオブジェクトが非アクティブである場合,そのXBRLFootnoteオブジェクトはXBRLInstanceDocumentのaddFootnote()によってインスタンス文書へ自動的に追加されます。
フィールドの概要:
XBRLInstanceElementインターフェースのフィールドの概要を次の表に示します。

表6-30 XBRLInstanceElementインターフェースのフィールドの概要

項番説明
1static intITEM_ELEMENT
  このオブジェクトは,アイテムを表します。
2static intTUPLE_ELEMENT
  このオブジェクトは,タプルを表します。
メソッドの概要:
XBRLInstanceElementインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1XBRLTaxonomyElementgetTaxonomyElement()
  要素の要素宣言を取得します。
2.0および2.1
2intgetElementType()
  オブジェクトの型を表すコードを取得します。
2.0および2.1
3java.lang.StringgetNamespaceURI()
  要素が属する名前空間URIを取得します。
2.0および2.1
4java.lang.StringgetPrefix()
  要素の名前空間接頭辞を取得します。
2.0および2.1
5java.lang.StringgetName()
  要素の名前を取得します。
2.0および2.1
6java.lang.StringgetId()
  要素のid属性の値を取得します。
2.0および2.1
7voidsetId(java.lang.String id)
  要素のid属性の値を設定します。
2.0および2.1
8java.util.List<XBRLLabel>getLabels()
  要素に関連づけられているラベルのリストを取得します。
2.0および2.1
9java.util.List<XBRLLabel>getLabelsByLang(java.lang.String lang)
  要素に関連づけられているラベルのうち,指定した言語のラベルのリストを取得します。
2.0および2.1
10java.util.List<XBRLLabel>getLabelsByRole(java.lang.String role)
  要素に関連づけられているラベルのうち,指定したロールを持つラベルのリストを取得します。
2.0および2.1
11XBRLLabelgetLabel(java.lang.String lang, java.lang.String role)
  要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルを取得します。
2.0および2.1
12java.util.List<XBRLLabel>getLabels(java.lang.String lang, java.lang.String role)
  要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルのリストを取得します。
2.1
13java.util.List<XBRLLabelRelationship>getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素の要素宣言とラベルの関係を表すXBRLLabelRelationshipオブジェクトのリストを取得します。
2.1
14java.util.List<XBRLReference>getReferences()
  要素に関連づけられている文献への参照のリストを取得します。
2.0および2.1
15java.util.List<XBRLReference>getReferences(java.lang.String role)
  要素に関連づけられている文献への参照のうち,指定したロールを持つ文献への参照のリストを取得します。
2.0および2.1
16java.util.List<XBRLReferenceRelationship>getReferenceRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素の要素宣言と文献への参照の関係を表すXBRLReferenceRelationshipオブジェクトのリストを取得します。
2.1
17booleanisNillable()
  要素の要素宣言のnillable属性の値を取得します。
2.1
18booleanisNil()
  要素のxsi:nil属性の値を取得します。
2.1
19voidsetNil(java.lang.Boolean nil)
  要素のxsi:nil属性の値を設定します。
2.1
20java.util.List<XBRLFootnote>getFootnotes()
  要素に関連づけられている脚注のリストを取得します。
2.0および2.1
21java.util.List<XBRLFootnote>getFootnotesByLang(java.lang.String lang)
  要素に関連づけられている脚注のうち,指定した言語の脚注のリストを取得します。
2.0および2.1
22java.util.List<XBRLFootnote>getFootnotesByRole(java.lang.String role)
  要素に関連づけられている脚注のうち,指定したロールの脚注のリストを取得します。
2.0および2.1
23java.util.List<XBRLFootnote>getFootnotes(java.lang.String lang, java.lang.String role)
  要素に関連づけられている脚注のうち,指定した言語およびロールの脚注のリストを取得します。
2.0および2.1
24XBRLFootnoteaddFootnote(XBRLFootnote newFootnote)
  要素に脚注を関連づけます。
2.0および2.1
25XBRLFootnoteaddFootnote(XBRLFootnote newFootnote, java.lang.String arcrole, java.math.BigDecimal order)
  要素に脚注を関連づけます。カスタムアークロールを使用できます。
2.1
26XBRLFootnoteremoveFootnote(XBRLFootnote oldFootnote)
  要素と脚注の関連づけを削除します。
2.0および2.1
27XBRLFootnoteremoveFootnote(XBRLFootnote oldFootnote, java.lang.String arcrole, java.math.BigDecimal order)
  要素と脚注の関連づけを削除します。
2.1
28java.util.List<XBRLFootnoteRelationship>getFootnoteRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素と脚注の関係を表すXBRLFootnoteRelationshipオブジェクトのリストを取得します。
2.1
29booleanisNilAttributeSpecified()
  要素にxsi:nil属性が定義されていたかどうかを調べます。
2.1
30java.util.List<XBRLDefinitionRelationship>getDefinitionRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素の要素宣言とほかの要素宣言の関係を表すXBRLDefinitionRelationshipオブジェクトのリストを取得します。
2.1
<この項の構成>
(1) getTaxonomyElement
(2) getElementType
(3) getNamespaceURI
(4) getPrefix
(5) getName
(6) getId
(7) setId
(8) getLabels
(9) getLabelsByLang
(10) getLabelsByRole
(11) getLabel
(12) getLabels
(13) getLabelRelationships
(14) getReferences
(15) getReferences
(16) getReferenceRelationships
(17) isNillable
(18) isNil
(19) setNil
(20) getFootnotes
(21) getFootnotesByLang
(22) getFootnotesByRole
(23) getFootnotes
(24) addFootnote
(25) addFootnote
(26) removeFootnote
(27) removeFootnote
(28) getFootnoteRelationships
(29) isNilAttributeSpecified
(30) getDefinitionRelationships

(1) getTaxonomyElement

public XBRLTaxonomyElement getTaxonomyElement()

XBRLのバージョン:
2.0および2.1
説明:
要素の要素宣言を取得します。
戻り値:
この要素の要素宣言を表すXBRLTaxonomyElementオブジェクトを返します。

(2) getElementType

public int getElementType()

XBRLのバージョン:
2.0および2.1
説明:
オブジェクトの型を表すコードを取得します。
戻り値:
オブジェクトの型を表すコードを返します。戻り値のコードは,XBRLInstanceElementインターフェースのフィールド値のどれかです。

(3) getNamespaceURI

public java.lang.String getNamespaceURI()

XBRLのバージョン:
2.0および2.1
説明:
要素が属する名前空間URIを取得します。
戻り値:
この要素が属する名前空間URIを返します。

(4) getPrefix

public java.lang.String getPrefix()

XBRLのバージョン:
2.0および2.1
説明:
要素の名前空間接頭辞を取得します。
戻り値:
この要素の名前空間接頭辞を返します。この要素がデフォルトの名前空間に属する場合はnullを返します。
インスタンス文書を編集して名前空間が正規化された場合,正規化の前後で戻り値の接頭辞が異なります。正規化前は,既存の文書で指定された接頭辞を返します。正規化後は,正規化によって変更された接頭辞を返します。

(5) getName

public java.lang.String getName()

XBRLのバージョン:
2.0および2.1
説明:
要素の名前を取得します。
戻り値:
この要素の名前を返します。

(6) getId

public java.lang.String getId()

XBRLのバージョン:
2.0および2.1
説明:
要素のid属性の値を取得します。
戻り値:
この要素のid属性の値を表す文字列を返します。この要素がid属性を持たない場合はnullを返します。

(7) setId

public void setId(java.lang.String id)

XBRLのバージョン:
2.0および2.1
説明:
要素のid属性の値を設定します。
id属性を削除したい場合は,引数idにnullを指定してください。ただし,この要素がアクティブで,かつ,脚注と関連づけられている場合は,id属性を削除できません。
引数:
id - id属性の値を指定します。id属性を削除する場合はnullを指定してください。
例外:
XBRLDOMRuntimeException -
  • 引数idに指定した値がxsd:NCName型でない場合にスローされます。[エラーコード:20108]
  • この要素がインスタンス文書中に存在していて,かつ,引数idで指定されたのと同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]
  • この要素がアクティブで,かつ,脚注と関連づけられていて,かつ,引数idにnullを指定した場合にスローされます。[エラーコード:20146]

(8) getLabels

public java.util.List<XBRLLabel> getLabels()

XBRLのバージョン:
2.0および2.1
説明:
要素に関連づけられているラベルのリストを取得します。リストの各要素は,XBRLLabelへキャストできます。
XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetLabels()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
しかし,XBRLTaxonomyDocumentインターフェースのgetLabels()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
  • XBRL2.1の場合:
    このメソッドでは,要素とラベルの関係を定義している<link:labelArc>要素のアークロール,および,その<link:labelArc>要素を含んでいるラベルリンクのロールについては考慮しません。特定の値のロールを持つラベルリンクに記述され,かつ,特定の値のアークロールを持つような<link:labelArc>要素によって関連づけられたラベルを取得したい場合は,XBRLInstanceElement.getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
戻り値:
この要素に関連づけられているラベルを表すXBRLLabelオブジェクトのリストを返します。この要素に関連づけられているラベルがない場合は,要素数が0のリストを返します。

(9) getLabelsByLang

public java.util.List<XBRLLabel> getLabelsByLang(java.lang.String lang)

XBRLのバージョン:
2.0および2.1
説明:
要素に関連づけられているラベルのうち,指定した言語のラベルのリストを取得します。リストの各要素は,XBRLLabelへキャストできます。
XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetLabelsByLang()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
しかし,XBRLTaxonomyDocumentインターフェースのgetLabelsByLang()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
  • XBRL2.1の場合:
    このメソッドでは,要素とラベルの関係を定義している<link:labelArc>要素のアークロール,および,その<link:labelArc>要素を含んでいるラベルリンクのロールについては考慮しません。特定の値のロールを持つラベルリンクに記述され,かつ,特定の値のアークロールを持つような<link:labelArc>要素によって関連づけられたラベルを取得したい場合は,XBRLInstanceElement.getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
引数:
lang - ラベルの言語を指定します。
戻り値:
この要素のラベルを表すXBRLLabelオブジェクトのリストを返します。指定した言語のラベルがない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(10) getLabelsByRole

public java.util.List<XBRLLabel> getLabelsByRole(java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
要素に関連づけられているラベルのうち,指定したロールを持つラベルのリストを取得します。リストの各要素は,XBRLLabelへキャストできます。
XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetLabelsByRole()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
しかし,XBRLTaxonomyDocumentインターフェースのgetLabelsByRole()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
  • XBRL2.1の場合:
    このメソッドでは,要素とラベルの関係を定義している<link:labelArc>要素のアークロール,および,その<link:labelArc>要素を含んでいるラベルリンクのロールについては考慮しません。特定の値のロールを持つラベルリンクに記述され,かつ,特定の値のアークロールを持つような<link:labelArc>要素によって関連づけられたラベルを取得したい場合は,XBRLInstanceElement.getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
引数:
role - ラベルのロールを指定します。ロールを持たないラベルを取得する場合はnullを指定します。
戻り値:
この要素のラベルを表すXBRLLabelオブジェクトのリストを返します。指定したロールを持つラベルがない場合は,要素数が0のリストを返します。

(11) getLabel

public XBRLLabel getLabel(java.lang.String lang,
                         java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルを取得します。
一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられていた場合の動作は,XBRLのバージョンによって異なります。詳細については,XBRLTaxonomyElementインターフェースの「6.8.16(13) getLabel」を参照してください。
  • XBRL2.1の場合:
    このメソッドでは,要素とラベルの関係を定義している<link:labelArc>要素のアークロール,および,その<link:labelArc>要素を含んでいるラベルリンクのロールについては考慮しません。特定の値のロールを持つラベルリンクに記述され,かつ,特定の値のアークロールを持つような<link:labelArc>要素によって関連づけられたラベルを取得したい場合は,XBRLInstanceElement.getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
引数:
lang - ラベルの言語を指定します。
role - ラベルのロールを指定します。ロールを持たないラベルを取得する場合はnullを指定します。
戻り値:
この要素のラベルを表すXBRLLabelオブジェクトを返します。指定した言語とロールを持つラベルがない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(12) getLabels

public java.util.List<XBRLLabel> getLabels(java.lang.String lang,
                               java.lang.String role)

XBRLのバージョン:
2.1
説明:
要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルのリストを取得します。
このメソッドでは,要素とラベルの関係を定義している<link:labelArc>要素のアークロール,および,その<link:labelArc>要素を含んでいるラベルリンクのロールについては考慮しません。特定の値のロールを持つラベルリンクに記述され,かつ,特定の値のアークロールを持つような<link:labelArc>要素によって関連づけられたラベルを取得したい場合は,XBRLInstanceElement.getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
lang - ラベルの言語を指定します。
role - ラベルのロールを指定します。ロールを持たないラベルを取得する場合はnullを指定します。
戻り値:
この要素のラベルを表すXBRLLabelオブジェクトのリストを返します。指定された言語とロールを持つラベルが存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(13) getLabelRelationships

public java.util.List<XBRLLabelRelationship> getLabelRelationships(java.lang.String extendedLinkRole,
                                           java.lang.String arcrole)

XBRLのバージョン:
2.1
説明:
要素の要素宣言とラベルの関係を表すXBRLLabelRelationshipオブジェクトのリストを取得します。
この要素の要素宣言に関連づけられたラベルは,このメソッドが返すリストに含まれる各XBRLLabelRelationshipオブジェクトに対してgetTo()メソッドを呼び出すことによって取得できます。また,このメソッドが返すリストに含まれる各XBRLLabelRelationshipオブジェクトに対してgetFrom()メソッドを呼び出した場合の戻り値は,この要素の要素宣言を表すXBRLTaxonomyElementオブジェクトとなります。
このメソッドが返すリストに含まれるXBRLLabelRelationshipオブジェクトの並びは,各XBRLLabelRelationshipオブジェクトが表す関係を定義しているアークのorder属性の値によって昇順にソートされています。アークにorder属性が指定されていない場合は,1が指定されたものと仮定します。詳細については,XBRLRelationshipインターフェースの「6.7.7(4) getOrder」を参照してください。アークのorder属性の値が同じであるXBRLLabelRelationshipオブジェクトが複数ある場合,それらのXBRLLabelRelationshipオブジェクトの並び順は不定です。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelRelationshipオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
extendedLinkRole - 関係を定義しているアークを含むラベルリンクのロールを指定します。
arcrole - 関係を定義しているアークのアークロールを指定します。
戻り値:
引数extendedLinkRoleで指定されたロールを持つラベルリンクに属し,かつ,引数arcroleで指定されたアークロールを持つアークによって定義された,この要素の要素宣言とラベルの関係を表すXBRLLabelRelationshipオブジェクトのリストを返します。指定された関係が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数extendedLinkRoleまたはarcroleにnullを指定した場合にスローされます。[エラーコード:20002]

(14) getReferences

public java.util.List<XBRLReference> getReferences()

XBRLのバージョン:
2.0および2.1
説明:
要素に関連づけられている文献への参照のリストを取得します。
XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetReferences()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
しかし,XBRLTaxonomyDocumentインターフェースのgetReferences()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
このメソッドが返すXBRLReferenceオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLReferenceオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
  • XBRL2.1の場合:
    このメソッドでは,要素と文献への参照の関係を定義している<link:referenceArc>要素のアークロール,および,その<link:referenceArc>要素を含んでいるリファレンスリンクのロールについては考慮しません。特定の値のロールを持つリファレンスリンクに記述され,かつ,特定の値のアークロールを持つような<link:referenceArc>要素によって関連づけられた文献への参照を取得したい場合は,XBRLInstanceElement.getReferenceRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
戻り値:
文献への参照を表すXBRLReferenceオブジェクトのリストを返します。

(15) getReferences

public java.util.List<XBRLReference> getReferences(java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
要素に関連づけられている文献への参照のうち,指定したロールを持つ文献への参照のリストを取得します。リストの各要素は,XBRLReferenceにキャストできます。
XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetReferences()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
しかし,XBRLTaxonomyDocumentインターフェースのgetReferences()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
このメソッドが返すXBRLReferenceオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLReferenceオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
  • XBRL2.1の場合:
    このメソッドでは,要素と文献への参照の関係を定義している<link:referenceArc>要素のアークロール,および,その<link:referenceArc>要素を含んでいるリファレンスリンクのロールについては考慮しません。特定の値のロールを持つリファレンスリンクに記述され,かつ,特定の値のアークロールを持つような<link:referenceArc>要素によって関連づけられた文献への参照を取得したい場合は,XBRLInstanceElement.getReferenceRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
引数:
role - 文献への参照のロールを指定します。ロールを持たない文献への参照を取得する場合はnullを指定します。
戻り値:
この要素の文献への参照を表すXBRLReferenceオブジェクトのリストを返します。指定したロールを持つ文献への参照がない場合は,要素数が0のリストを返します。

(16) getReferenceRelationships

public java.util.List<XBRLReferenceRelationship> getReferenceRelationships(java.lang.String extendedLinkRole,
                                               java.lang.String arcrole)

XBRLのバージョン:
2.1
説明:
要素の要素宣言と文献への参照の関係を表すXBRLReferenceRelationshipオブジェクトのリストを取得します。
この要素の要素宣言に関連づけられた文献への参照は,このメソッドが返すリストに含まれる各XBRLReferenceRelationshipオブジェクトに対してgetTo()メソッドを呼び出すことによって取得できます。また,このメソッドが返すリストに含まれる各XBRLReferenceRelationshipオブジェクトに対してgetFrom()メソッドを呼び出した場合の戻り値は,この要素の要素宣言を表すXBRLTaxonomyElementオブジェクトとなります。
このメソッドが返すリストに含まれるXBRLReferenceRelationshipオブジェクトの並びは,各XBRLReferenceRelationshipオブジェクトが表す関係を定義しているアークのorder属性の値によって昇順にソートされています。アークにorder属性が指定されていない場合は,1が指定されたものと仮定します。詳細については,XBRLRelationshipインターフェースの「6.7.7(4) getOrder」を参照してください。アークのorder属性の値が同じであるXBRLReferenceRelationshipオブジェクトが複数ある場合,それらのXBRLReferenceRelationshipオブジェクトの並び順は不定です。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLReferenceRelationshipオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
extendedLinkRole - 関係を定義しているアークを含むリファレンスリンクのロールを指定します。
arcrole - 関係を定義しているアークのアークロールを指定します。
戻り値:
引数extendedLinkRoleで指定されたロールを持つリファレンスリンクに属し,かつ,引数arcroleで指定されたアークロールを持つアークによって定義された,この要素の要素宣言と文献への参照の関係を表すXBRLReferenceRelationshipオブジェクトのリストを返します。指定された関係が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数extendedLinkRoleまたはarcroleにnullを指定した場合にスローされます。[エラーコード:20002]

(17) isNillable

public boolean isNillable()

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

(18) isNil

public boolean isNil()

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

(19) setNil

public void setNil(java.lang.Boolean nil)

XBRLのバージョン:
2.1
説明:
要素のxsi:nil属性の値を設定します。
要素にxsi:nil属性を設定できるのは,この要素の要素宣言でnillable属性に"true"が指定されている場合だけです。要素宣言のnillable属性に"true"が指定されていない場合は,このメソッドはXBRLDOMRuntimeExceptionをスローします。要素宣言のnillable属性に"true"が指定されているかどうかは,XBRLInstanceElement.isNillable()メソッドを使用して調べることができます。
引数nilにjava.lang.Boolean.TRUEを指定した場合は,この要素の内容が自動的に削除されます。アイテムの場合は値が設定されていない(XBRLInstanceItem.hasValue()メソッドがfalseを返す)状態となり,タプルの場合は子要素がすべて削除された状態となります。このとき,この要素がアイテムで,かつ,precision属性またはdecimals属性のどちらかが指定されている場合は,それらの属性も削除されます。
この要素が数値アイテムで,かつ,ベースデータ型がFRACTION_ITEM以外で,かつ,アイテムのxsi:nil属性に "true" が指定されている場合に,このメソッドの引数nilにjava.lang.Boolean.FALSEまたはnullを指定すると,自動的にアイテムのprecision属性に"INF"が設定されます。precision属性やdecimals属性の値は,XBRLInstanceItem.setPrecision()メソッドやXBRLInstanceItem.setDecimals()メソッドを使用して必要に応じて設定してください。
引数:
nil - xsi:nil属性に"true"を指定する場合はjava.lang.Boolean.TRUE,"false"を指定する場合はjava.lang.Boolean.FALSEを指定します。xsi:nil属性を削除する場合はnullを指定してください。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • XBRLInstanceElement.isNillable()メソッドがfalseを返す場合(この要素の要素宣言でnillable属性に "false" が指定されているか,または,nillable属性が指定されていない場合)で,かつ,引数nilにnull以外の値を指定した場合にスローされます。[エラーコード:20129]

(20) getFootnotes

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

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

(21) getFootnotesByLang

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

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

(22) getFootnotesByRole

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

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

(23) getFootnotes

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

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

(24) addFootnote

public XBRLFootnote addFootnote(XBRLFootnote newFootnote)

XBRLのバージョン:
2.0および2.1
説明:
要素に脚注を関連づけます。指定したXBRLFootnoteオブジェクトが,すでにこのXBRLInstanceElementオブジェクトに関連づけられている場合は,何もしません。
この要素がアクティブで,かつ引数newFootnoteに指定した脚注がインスタンス文書にない場合は,脚注はインスタンス文書に自動的に追加されます。
XBRL2.1の場合,脚注がインスタンス文書へ自動的に追加されるときに,脚注のid属性と同じ値のid属性を持つ別の要素がすでにインスタンス文書に存在する場合は,BRLDOMRuntimeException例外がスローされます。
この要素がアクティブで,かつ,この要素がid属性を持っていない場合は,IDが自動的に採番されてid属性に設定されます。また,この要素が非アクティブである場合は,このメソッドを呼び出した時点ではid属性の値は自動採番されませんが,あとでこの要素をインスタンス文書へ追加する際に脚注が関連づけられている場合は,id属性の値が自動採番されて設定されます。id属性の値は,XBRLInstanceElement.setId(java.lang.String)を使用して任意の値を設定することもできます。自動採番の詳細については,「3.3 ID管理と採番」を参照してください。
  • XBRL2.1の場合:
    要素と脚注の関係を定義する<link:footnoteArc>要素のアークロールは,XBRL2.1の仕様で規定されている標準値である "http://www.xbrl.org/2003/arcrole/fact-footnote" が使用されます。また,<link:footnoteArc>要素のorder属性には"1"が設定されます。カスタムアークロールを使用したい場合や,order属性に"1"以外の値を設定したい場合は,XBRLInstanceElement.addFootnote(XBRLFootnote newFootnote, java.lang.String arcrole, java.math.BigDecimal order)メソッドを使用してください。
引数:
newFootnote - 脚注を表すXBRLFootnoteオブジェクトを指定します。
戻り値:
関連づけられた脚注を表すXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数newFootnoteにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newFootnoteに指定したXBRLFootnoteオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,この要素を所有するXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]

(25) addFootnote

public XBRLFootnote addFootnote(XBRLFootnote newFootnote,
                               java.lang.String arcrole,
                               java.math.BigDecimal order)

XBRLのバージョン:
2.1
説明:
要素に脚注を関連づけます。カスタムアークロールを使用できます。
要素と脚注の関係を定義する<link:footnoteArc>要素のアークロールは,引数arcroleで指定された値となります。また,<link:footnoteArc>要素のorder属性は,引数orderで指定された値となります。
引数newFootnoteに指定されたXBRLFootnoteオブジェクトが,引数arcroleおよびorderによって指定されたアークロールとorder属性を持つ<link:footnoteArc>要素によってすでにこのXBRLInstanceElementオブジェクトに関連づけられている場合は,何もしません。
この要素がアクティブで,かつ引数newFootnoteに指定された脚注がインスタンス文書に存在しない場合は,脚注はインスタンス文書に自動的に追加されます。このとき,インスタンス文書へ自動的に追加される脚注のid属性と同じ値のid属性を持つ別の要素がすでにインスタンス文書に存在する場合は,XBRLDOMRuntimeException例外がスローされます。
この要素がアクティブで,かつ,引数newFootnoteに指定された脚注がインスタンス文書に存在しない場合は,脚注はインスタンス文書に自動的に追加されます。
この要素がアクティブで,かつ,この要素がid属性を持っていない場合は,IDが自動的に採番されてid属性に設定されます。また,この要素が非アクティブである場合は,このメソッドを呼び出した時点ではid属性の値は自動採番されませんが,あとでこの要素をインスタンス文書へ追加する際に脚注が関連づけられている場合は,id属性の値が自動採番されて設定されます。id属性の値は,XBRLInstanceElement.setId(java.lang.String)を使用して任意の値を設定することもできます。自動採番の詳細については,「3.3 ID管理と採番」を参照してください。
引数:
newFootnote - 脚注を表すXBRLFootnoteオブジェクトを指定します。
arcrole - 要素と脚注の関係を定義する<link:footnoteArc>要素のアークロールを指定します。
order - 要素と脚注の関係を定義する<link:footnoteArc>要素のorder属性の値を指定します。
戻り値:
関連づけられた脚注を表すXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数newFootnote,arcroleまたはorderにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数newFootnoteに指定されたXBRLFootnoteオブジェクトを所有するXBRLInstanceDocumentオブジェクトが,この要素を所有するXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
  • 引数arcroleに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • 引数arcroleに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]
  • 引数arcroleに指定したアークロールがXBRL仕様で規定された標準値で,かつ,<link:footnoteArc>要素で利用できるものではない場合にスローされます。[エラーコード:20116]
  • 引数arcroleに指定したアークロールがカスタムアークロールで,かつ,そのカスタムアークロールの定義を指す<link:arcroleRef>要素がインスタンス文書に存在しない場合にスローされます。[エラーコード:20118]
  • 引数arcroleに指定したアークロールがカスタムアークロールで,かつ,<link:arcroleType>要素でそのカスタムアークロールが<link:footnoteArc>要素で利用できるように定義されていない場合にスローされます。[エラーコード:20120]

(26) removeFootnote

public XBRLFootnote removeFootnote(XBRLFootnote oldFootnote)

XBRLのバージョン:
2.0および2.1
説明:
要素と脚注の関連づけを削除します。
  • XBRL2.1の場合:
    要素と脚注の関係を定義する<link:footnoteArc>要素のアークロールは,XBRL2.1の仕様で規定されている標準値である"http://www.xbrl.org/2003/arcrole/fact-footnote"が仮定されます。また,<link:footnoteArc>要素のorder属性の値には"1"が仮定されます。カスタムアークロールを持つ<link:footnoteArc>要素によって定義されている関係や,order属性に"1"以外の値を持つ<link:footnoteArc>要素によって定義されている関係を削除したい場合は,XBRLInstanceElement.removeFootnote(XBRLFootnote oldFootnote, java.lang.String arcrole, java.math.BigDecimal order)メソッドを使用してください。
引数:
oldFootnote - 関連づけを削除する脚注を表すXBRLFootnoteオブジェクトを指定します。
戻り値:
関連づけが削除された脚注を表すXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数oldFootnoteにnullを指定した場合にスローされます。[エラーコード:20002]
  • XBRL2.0の場合:引数oldFootnoteに指定した脚注が,この要素に関連づけられていない場合にスローされます。[エラーコード:20053]
  • XBRL2.1の場合:引数oldFootnoteに指定された脚注が,アークロールがXBRL仕様で規定されている標準値である"http://www.xbrl.org/2003/arcrole/fact-footnote"で,かつ,order属性の値が"1"である<link:footnoteArc>要素によってこの要素に関連づけられていない場合にスローされます。[エラーコード:20123]

(27) removeFootnote

public XBRLFootnote removeFootnote(XBRLFootnote oldFootnote,
                                  java.lang.String arcrole,
                                  java.math.BigDecimal order)

XBRLのバージョン:
2.1
説明:
引数arcroleおよびorderによって指定されたアークロールとorder属性を持つ<link:footnoteArc>要素によって定義されている,この要素と脚注の関連づけを削除します。
引数:
oldFootnote - 関連づけを削除する脚注を表すXBRLFootnoteオブジェクトを指定します。
arcrole - 削除する関係を定義している<link:footnoteArc>要素のアークロールを指定します。
order - 削除する関係を定義している<link:footnoteArc>要素のorder属性の値を指定します。
戻り値:
関連づけが削除された脚注を表すXBRLFootnoteオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数oldFootnote,arcroleまたはorderにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数oldFootnoteに指定された脚注が,引数arcroleおよびorderによって指定されたアークロールとorder属性を持つ<link:footnoteArc>要素によってこの要素に関連づけられていない場合にスローされます。[エラーコード:20123]

(28) getFootnoteRelationships

public java.util.List<XBRLFootnoteRelationship> getFootnoteRelationships(java.lang.String extendedLinkRole,
                                              java.lang.String arcrole)

XBRLのバージョン:
2.1
説明:
要素と脚注の関係を表すXBRLFootnoteRelationshipオブジェクトのリストを取得します。
この要素に関連づけられた脚注は,このメソッドが返すリストに含まれる各XBRLFootnoteRelationshipオブジェクトに対してgetTo()メソッドを呼び出すことによって取得できます。また,このメソッドが返すリストに含まれる各XBRLFootnoteRelationshipオブジェクトに対してgetFrom()メソッドを呼び出した場合の戻り値は,この要素を表すXBRLInstanceElementオブジェクト自身となります。
このメソッドが返すリストに含まれるXBRLFootnoteRelationshipオブジェクトの並びは,各XBRLFootnoteRelationshipオブジェクトが表す関係を定義しているアークのorder属性の値によって昇順にソートされています。アークにorder属性が指定されていない場合は,1が指定されたものと仮定します。詳細については,XBRLRelationshipインターフェースの「6.7.7(4) getOrder」を参照してください。アークのorder属性の値が同じであるXBRLFootnoteRelationshipオブジェクトが複数ある場合,それらのXBRLFootnoteRelationshipオブジェクトの並び順は不定です。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLFootnoteRelationshipオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
extendedLinkRole - 関係を定義しているアークを含むリファレンスリンクのロールを指定します。
arcrole - 関係を定義しているアークのアークロールを指定します。
戻り値:
引数extendedLinkRoleで指定されたロールを持つ脚注リンクに属し,かつ,引数arcroleで指定されたアークロールを持つアークによって定義された,この要素と脚注の関係を表すXBRLFootnoteRelationshipオブジェクトのリストを返します。指定された関係が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数extendedLinkRoleまたはarcroleにnullを指定した場合にスローされます。[エラーコード:20002]

(29) isNilAttributeSpecified

public boolean isNilAttributeSpecified()

XBRLのバージョン:
2.1
説明:
要素にxsi:nil属性が定義されていたかどうかを調べます。
戻り値:
この要素にxsi:nil属性が定義されていた場合,trueを返します。xsi:nil属性が定義されていない場合はfalseを返します。
InstanceDocumentのcreateItemメソッド,createNumericItemメソッド,createNonNumericItemで新たに生成したXBRLInstanceElementのオブジェクトにおいて,本メソッドを実行した場合は,常にfalseを返します。

(30) getDefinitionRelationships

public java.util.List<XBRLDefinitionRelationship>
getDefinitionRelationships(java.lang.String extendedLinkRole,
                          java.lang.String arcrole)

XBRLのバージョン:
2.1
説明:
要素宣言とほかの要素宣言の関係を表すXBRLDefinitionRelationshipオブジェクトのリストを取得します。
この要素宣言に関連づけられたほかの要素宣言は,このメソッドが返すリストに含まれる各XBRLDefinitionRelationshipオブジェクトに対してgetTo()メソッドを呼び出すことによって取得できます。また,このメソッドが返すリストに含まれる各XBRLDefinitionRelationshipオブジェクトに対してgetFrom()メソッドを呼び出した場合の戻り値は,このXBRLTaxonomyElementオブジェクト自身となります。
このメソッドが返すリストに含まれるXBRLDefinitionRelationshipオブジェクトの並びは,各XBRLDefinitionRelationshipオブジェクトが表す関係を定義しているアークのorder属性の値によって昇順にソートされています。アークにorder属性が指定されていない場合は,1が指定されたものと仮定します。アークのorder属性の値が同じであるXBRLDefinitionRelationshipオブジェクトが複数ある場合,XBRLDefinitionRelationshipオブジェクトの並び順は不定です。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLDefinitionRelationshipオブジェクトに増減があった場合,その変更は直ちに反映されます。このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
extendedLinkRole - 関係を定義しているアークを含む定義リンクのロールを指定します。
arcrole - 関係を定義しているアークのアークロールを指定します。
戻り値:
引数extendedLinkRoleで指定されたロールを持つ定義リンクに属し,かつ,引数arcroleで指定されたアークロールを持つアークによって定義された,この要素の要素宣言とほかの要素宣言の関係を表すXBRLDefinitionRelationshipオブジェクトのリストを返します。指定された関係が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数extendedLinkRoleまたはarcroleにnullを指定した場合にスローされます。[エラーコード:20002]