6.8.16 XBRLTaxonomyElementインターフェース

public interface XBRLTaxonomyElement
extends XBRLTaxonomyNode

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述される要素の要素宣言を表します。
フィールドの概要:
XBRLTaxonomyElementインターフェースのフィールドの概要を次の表に示します。

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

項番説明
1static intITEM_ELEMENT
  このオブジェクトは,アイテムの要素宣言を表します。
2static intTUPLE_ELEMENT
  このオブジェクトは,タプルの要素宣言を表します。
3static intOTHER_ELEMENT
  このオブジェクトは,アイテムまたはタプル以外の要素の要素宣言を表します。
4static intHYPERCUBE_ITEM_ELEMENT
  このオブジェクトは,ハイパーキューブの要素宣言を表します。
5static intDIMENSION_ITEM_ELEMENT
  このオブジェクトは,ディメンジョンの要素宣言を表します。
メソッドの概要:
XBRLTaxonomyElementインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1intgetElementType()
  オブジェクトの型を表すコードを取得します。
2.0および2.1
2java.lang.StringgetNamespaceURI()
  要素が属する名前空間URIを取得します。
2.0および2.1
3java.lang.StringgetName()
  要素の名前を取得します。
2.0および2.1
4XBRLQNamegetType()
  要素の型を示す修飾名を取得します。
2.0および2.1
5XBRLQNamegetSubstitutionGroup()
  要素のヘッド要素の修飾名を取得します。
2.0および2.1
6booleanisAbstract()
  要素が抽象的かどうかを調べます。
2.0および2.1
7booleanisNillable()
  要素の要素宣言のnillable属性の値を取得します。
2.1
8java.lang.StringgetId()
  要素のid属性の値を取得します。
2.0および2.1
9java.lang.StringgetBalance()
  要素宣言のxbrli:balance属性を取得します。
2.0および2.1
10java.util.List<XBRLLabel>getLabels()
  要素に関連づけられているラベルのリストを取得します。
2.0および2.1
11java.util.List<XBRLLabel>getLabelsByLang(java.lang.String lang)
  要素に関連づけられているラベルのうち,指定した言語のラベルのリストを取得します。
2.0および2.1
12java.util.List<XBRLLabel>getLabelsByRole(java.lang.String role)
  要素に関連づけられているラベルのうち,指定したロールを持つラベルのリストを取得します。
2.0および2.1
13XBRLLabelgetLabel(java.lang.String lang, java.lang.String role)
  要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルを取得します。
2.0および2.1
14java.util.List<XBRLLabel>getLabels(java.lang.String lang, java.lang.String role)
  要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルのリストを取得します。
2.1
15java.util.List<XBRLLabelRelationship>getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素の要素宣言とラベルの関係を表すXBRLLabelRelationshipオブジェクトのリストを取得します。
2.1
16java.util.List<XBRLReference>getReferences()
  要素に関連づけられている文献への参照のリストを取得します。
2.0および2.1
17java.util.List<XBRLReference>getReferences(java.lang.String role)
  要素に関連づけられている文献への参照のうち,指定したロールを持つ文献への参照のリストを取得します。
2.0および2.1
18java.util.List<XBRLReferenceRelationship>getReferenceRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素の要素宣言と文献への参照の関係を表すXBRLReferenceRelationshipオブジェクトのリストを取得します。
2.1
19java.util.List<XBRLCalculationRelationship>getCalculationRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素宣言とほかの要素宣言との関係を表すXBRLCalculationRelationshipオブジェクトのリストを取得します。
2.1
20java.util.List<XBRLDefinitionRelationship>getDefinitionRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素宣言とほかの要素宣言の関係を表すXBRLDefinitionRelationshipオブジェクトのリストを取得します。
2.1
21java.util.List<XBRLPresentationRelationship>getPresentationRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)
  要素宣言とほかの要素宣言の関係を表すXBRLPresentationRelationshipオブジェクトのリストを取得します。
2.1
22XBRLTaxonomyTypeDefinitiongetTaxonomyTypeDefinition()
  要素の型定義を表すXBRLTaxonomyTypeDefinitionオブジェクトを取得します。
2.1
<この項の構成>
(1) getElementType
(2) getNamespaceURI
(3) getName
(4) getType
(5) getSubstitutionGroup
(6) isAbstract
(7) isNillable
(8) getId
(9) getBalance
(10) getLabels
(11) getLabelsByLang
(12) getLabelsByRole
(13) getLabel
(14) getLabels
(15) getLabelRelationships
(16) getReferences
(17) getReferences
(18) getReferenceRelationships
(19) getCalculationRelationships
(20) getDefinitionRelationships
(21) getPresentationRelationships
(22) getTaxonomyTypeDefinition

(1) getElementType

public int getElementType()

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

(2) getNamespaceURI

public java.lang.String getNamespaceURI()

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

(3) getName

public java.lang.String getName()

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

(4) getType

public XBRLQName getType()

XBRLのバージョン:
2.0および2.1
説明:
要素の型を示す修飾名を取得します。
戻り値:
この要素の型を示す修飾名を返します。要素宣言にtype属性の指定がない場合はnullを返します。

(5) getSubstitutionGroup

public XBRLQName getSubstitutionGroup()

XBRLのバージョン:
2.0および2.1
説明:
要素のヘッド要素の修飾名を取得します。
戻り値:
この要素のヘッド要素の修飾名を返します。要素宣言にsubstitutionGroup属性の指定がない場合はnullを返します。

(6) isAbstract

public boolean isAbstract()

XBRLのバージョン:
2.0および2.1
説明:
要素が抽象的かどうかを調べます。
この要素が抽象的かどうかは,要素宣言のabstract属性の値によって決まります。abstract属性の値がtrueの場合は抽象的です。値がfalseか,またはabstract属性の指定が省略された場合は抽象的ではありません。
戻り値:
この要素が抽象的の場合はtrue,抽象的でない場合はfalseを返します。

(7) isNillable

public boolean isNillable()

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

(8) getId

public java.lang.String getId()

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

(9) getBalance

public java.lang.String getBalance()

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

(10) getLabels

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

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

(11) getLabelsByLang

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

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

(12) getLabelsByRole

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

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

(13) getLabel

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

XBRLのバージョン:
2.0および2.1
説明:
要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルを取得します。
XBRL2.1の場合:このメソッドでは,要素とラベルの関係を定義している<link:labelArc>要素のアークロール,および,その<link:labelArc>要素を含んでいるラベルリンクのロールについては考慮しません。特定の値のロールを持つラベルリンクに記述され,かつ,特定の値のアークロールを持つような<link:labelArc>要素によって関連づけられたラベルを取得したい場合は,XBRLTaxonomyElement.getLabelRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを使用してください。
同じ言語とロールを持つ複数のラベルが関連づけられている場合の動作
一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられていた場合の動作は,XBRLのバージョンによって異なります。次に,XBRLの各バージョンでの動作を示します。
  • XBRL2.0の場合
    一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられている場合は,priority属性の値が最も大きいアークによって関連づけられているラベルがこのメソッドによって取得できます。このとき,priority属性の値が2番目以降のアークによって関連づけられたラベルは上書きされるため,XBRLTaxonomyElement.getLabels()などのほかのメソッドで取得できません。一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられていて,かつ,それらの関連づけを定義しているアークのうちpriority属性の値が最も大きいアークが複数存在する場合は,タクソノミー文書の解析処理でエラーが発生します。このエラーを無視した場合にどちらのアークによって関連づけられたラベルが取得できるかについては,不定です。
  • XBRL2.1の場合
    一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられている場合,order属性の値が最も小さいアークによって関連づけられているラベルが,このメソッドによって取得できます。このとき,XBRL2.0の場合とは異なり,各ラベルを関連づけているアークのpriority属性の値は影響しません。一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられていて,かつ,それらの関連づけを定義しているアークのうちorder属性の値が最も小さいアークが複数存在する場合,どのアークによって関連づけられたラベルが取得できるかについては,不定です。この要素に対して同じ言語とロールを持つラベルが複数関連づけられている場合に,このメソッドでは取得できないほかのラベルを取得したい場合は,XBRLTaxonomyElement.getLabels(java.lang.String lang, java.lang.String role)メソッドを使用してください。また,このメソッドでは取得できないほかのラベルは,XBRLTaxonomyElement.getLabels()などのメソッドでも取得できます。
一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられている場合の例を次の図に示します。

図6-17 一つの要素に対して同じ言語とロールを持つラベルが複数関連づけられている場合の例

[図データ]
この例では,要素Xに同じ言語とロールを持つラベルA,ラベルB,ラベルCが関連づけられています。この要素Xに対して,getLabel("ja",xxx)を呼び出した場合の結果を次に示します。
XBRL2.0の場合:priority属性の値が最も大きいアークTによって関連づけられているラベルBが取得できます。しかし,getLabels()などのほかのメソッドを使用して,ラベルAおよびラベルCを取得できません。
XBRL2.1の場合:order属性の値が最も小さいアークRによって関連づけられているラベルAが取得できます。また,getLabels()などのほかのメソッドを使用して,ラベルBおよびラベルCを取得することもできます。
引数:
lang - ラベルの言語を指定します。
role - ラベルのロールを指定します。ロールを持たないラベルを取得する場合はnullを指定します。
戻り値:
この要素のラベルを表すXBRLLabelオブジェクトを返します。指定した言語とロールを持つラベルがない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(14) getLabels

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

XBRLのバージョン:
2.1
説明:
要素に関連づけられているラベルのうち,指定した言語とロールを持つラベルのリストを取得します。
このメソッドでは,要素とラベルの関係を定義している<link:labelArc>要素のアークロール,および,その<link:labelArc>要素を含んでいるラベルリンクのロールについては考慮しません。特定の値のロールを持つラベルリンクに記述され,かつ,特定の値のアークロールを持つような<link:labelArc>要素によって関連づけられたラベルを取得したい場合は,XBRLTaxonomyElement.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]

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

(16) getReferences

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

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

(17) getReferences

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

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

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

(19) getCalculationRelationships

public java.util.List<XBRLCalculationRelationship> getCalculationRelationships(java.lang.String extendedLinkRole,
                                                 java.lang.String arcrole)

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

(20) 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]

(21) getPresentationRelationships

public java.util.List<XBRLPresentationRelationship> getPresentationRelationships(java.lang.String extendedLinkRole,
                                                  java.lang.String arcrole)

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

(22) getTaxonomyTypeDefinition

public XBRLTaxonomyTypeDefinition getTaxonomyTypeDefinition()

XBRLのバージョン:
2.1
説明:
要素の型定義を表すXBRLTaxonomyTypeDefinitionオブジェクトを取得します。この要素に名前を持たない型として定義された型定義か,type属性により指定した型定義が,このタクソノミー文書に名前付きで定義された型定義である場合のみ取得することができます。
戻り値:
この要素の型定義を表すXBRLTaxonomyTypeDefinitionオブジェクトを返します。この要素にstringのような事前定義型が指定されている場合にnullが返ります。type属性,局所型定義のいずれも定義されていない場合にもnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]