6.7.9 XBRLDimensionalRelationshipSetインターフェース

public interface XBRLDimensionalRelationshipSet

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
プライマリー・アイテムに関連づいているDRSを表します。
メソッドの概要:
XBRLDimensionalRelationshipSetインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョンXBRL Dimensionsのバージョン
1XBRLTaxonomyItemgetTaxonomyItem()
  DRSに関連づいているプライマリー・アイテムの要素宣言を取得します。
2.11.0
2java.util.List<java.lang.String>getRoles()
  DRSに含まれているhas-hypercube関係が定義された,extended型要素のxlink:role属性のリストを取得します。
2.11.0
3java.util.List<XBRLHasHypercubeRelationship>getHasHypercubeRelationships(java.lang.String role)
  DRSに含まれているhas-hypercube関係のうち,引数roleに指定した値と同じxlink:role属性を持つextended型要素に定義された,has-hypercube関係のリストを取得します。
2.11.0
4java.util.List<XBRLHypercubeDimensionRelationship>getHypercubeDimensionRelationships(XBRLHasHypercubeRelationship relationship)
  DRSに含まれているhypercube-dimension関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているhypercube-dimension関係のリストを取得します。
2.11.0
5java.util.List<XBRLDimensionDomainRelationship>getDimensionDomainRelationships(XBRLHypercubeDimensionRelationship relationship)
  DRSに含まれているdimension-domain関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdimension-domain関係のリストを取得します。
2.11.0
6java.util.List<XBRLDomainMemberRelationship>getDomainMemberRelationships(XBRLDimensionDomainRelationship relationship)
  DRSに含まれているdomain-member関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdomain-member関係のリストを取得します。
2.11.0
7java.util.List<XBRLDomainMemberRelationship>getDomainMemberRelationships(XBRLDomainMemberRelationship relationship)
  DRSに含まれているdomain-member関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdomain-member関係のリストを取得します。
2.11.0
8XBRLDimensionDefaultRelationshipgetDimensionDefaultRelationship(XBRLHypercubeDimensionRelationship relationship)
  DRSに含まれているdimension-default関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdimension-default関係を取得します。
2.11.0
9java.util.List<XBRLDRSDimension>getDRSDimensions(java.lang.String role, int contextElementType)
  DRSに含まれているディメンジョンの要素宣言のうち,インスタンス文書に記述できるディメンジョンの要素宣言のリストを返します。
2.11.0
10java.util.List<XBRLDRSDimension>getDRSDimensions(java.lang.String role)
  DRSに含まれているディメンジョンの要素宣言のうち,XBRLインスタンス文書に記述できるディメンジョンの要素宣言のリストを返します。
2.11.0
11java.util.List<XBRLDRSMember>getDRSMembers(XBRLDRSDimension dimension)
  DRSに含まれている要素宣言のうち,指定されたディメンジョンのメンバとして,インスタンス文書に記述できる要素宣言のリストを返します。
2.11.0
12XBRLDRSMembergetDRSDefaultMember(XBRLDRSDimension dimension)
  DRSに含まれている要素宣言のうち,インスタンス文書に記述できる要素宣言のリストを返します。
2.11.0
<この項の構成>
(1) getTaxonomyItem
(2) getRoles
(3) getHasHypercubeRelationships
(4) getHypercubeDimensionRelationships
(5) getDimensionDomainRelationships
(6) getDomainMemberRelationships
(7) getDomainMemberRelationships
(8) getDimensionDefaultRelationship
(9) getDRSDimensions
(10) getDRSDimensions
(11) getDRSMembers
(12) getDRSDefaultMember

(1) getTaxonomyItem

public XBRLTaxonomyItem getTaxonomyItem()

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに関連づいているプライマリー・アイテムの要素宣言を取得します。
戻り値:
このDRSに関連づいているプライマリー・アイテムの要素宣言を表すXBRLTaxonomyItemオブジェクトを返します。

(2) getRoles

public java.util.List<java.lang.String> getRoles()

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているhas-hypercube関係が定義された,extended型要素のxlink:role属性のリストを取得します。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このDRSに含まれているhas-hypercube関係が定義された,extended型要素のxlink:role属性のリストを返します。

(3) getHasHypercubeRelationships

public java.util.List<XBRLHasHypercubeRelationship> getHasHypercubeRelationships ( java.lang.String role )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているhas-hypercube関係のうち,引数roleに指定した値と同じxlink:role属性を持つextended型要素に定義された,has-hypercube関係のリストを取得します。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
role - extended型要素のxlink:role属性の値を指定します。
戻り値:
このDRSに含まれているhas-hypercube関係のうち,引数roleに指定した値と同じxlink:role属性を持つextended型要素に定義された,has-hypercube関係のリストを返します。該当するhas-hypercube関係がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数roleにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数roleに空のURI参照を指定した場合にスローされます。[エラーコード:20110]

(4) getHypercubeDimensionRelationships

public java.util.List<XBRLHypercubeDimensionRelationship> getHypercubeDimensionRelationships ( XBRLHasHypercubeRelationship relationship )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているhypercube-dimension関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているhypercube-dimension関係のリストを取得します。
引数relationshipと結び付いているhypercube-dimension関係とは,次のどちらかのことです。
  • 引数relationshipにxbrldt:targetRole属性が設定されている場合は,そのxbrldt:targetRole属性の値と同じ値のxlink:role属性を持つhypercube-dimension関係を示します。
  • 引数relationshipにxbrldt:targetRole属性が設定されていない場合は,引数relationshipのxlink:role属性の値と同じ値のxlink:role属性を持つhypercube-dimension関係を示します。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
relationship - このDRSに含まれているhas-hypercube関係を指定します。
戻り値:
このDRSに含まれているhypercube-dimension関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているhypercube-dimension関係のリストを返します。該当するhypercube-dimension関係がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数relationshipにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数relationshipに指定したXBRLHasHypercubeRelationshipオブジェクトを所有するXBRLTaxonomyDocumentオブジェクトが,このXBRLDimensionalRelationshipSetオブジェクトを所有するXBRLTaxonomyDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20034]

(5) getDimensionDomainRelationships

public java.util.List<XBRLDimensionDomainRelationship> getDimensionDomainRelationships ( XBRLHypercubeDimensionRelationship relationship )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているdimension-domain関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdimension-domain関係のリストを取得します。
引数relationshipと結び付いているhypercube-dimension関係とは,次のどちらかのことです。
  • 引数relationshipにxbrldt:targetRole属性が設定されている場合は,そのxbrldt:targetRole属性の値と同じ値のxlink:role属性を持つdimension-domain関係を示します。
  • 引数relationshipにxbrldt:targetRole属性が設定されていない場合は,引数relationshipのxlink:role属性の値と同じ値のxlink:role属性を持つdimension-domain関係を示します。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
relationship - このDRSに含まれているhypercube-dimension関係を指定します。
戻り値:
このDRSに含まれているdimension-domain関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdimension-domain関係のリストを返します。該当するdimension-domain関係がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数relationshipにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数relationshipに指定したXBRLHypercubeDimensionRelationshipオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトが,このXBRLDimensionalRelationshipSetオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20034]

(6) getDomainMemberRelationships

public java.util.List<XBRLDomainMemberRelationship> getDomainMemberRelationships ( XBRLDimensionDomainRelationship relationship )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているdomain-member関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdomain-member関係のリストを取得します。
引数relationshipと結び付いているdomain-member関係とは,次のどちらかのことです。
  • 引数relationshipにxbrldt:targetRole属性が設定されている場合は,そのxbrldt:targetRole属性の値と同じ値のxlink:role属性を持つdomain-member関係を示します。
  • 引数relationshipにxbrldt:targetRole属性が設定されていない場合は,引数relationshipのxlink:role属性の値と同じ値のxlink:role属性を持つdomain-member関係を示します。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
relationship - このDRSに含まれているdimension-domain関係を指定します。
戻り値:
このDRSに含まれているdomain-member関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdomain-member関係のリストを返します。該当するdomain-member関係がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数relationshipにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数relationshipに指定したXBRLDimensionDomainRelationshipオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトが,このXBRLDimensionalRelationshipSetオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20034]

(7) getDomainMemberRelationships

public java.util.List<XBRLDomainMemberRelationship> getDomainMemberRelationships ( XBRLDomainMemberRelationship relationship )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているdomain-member関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdomain-member関係のリストを取得します。
引数relationshipと結び付いているdomain-member関係とは,次のどちらかのことです。
  • 引数relationshipにxbrldt:targetRole属性が設定されている場合は,そのxbrldt:targetRole属性の値と同じ値のxlink:role属性を持つdomain-member関係を示します。
  • 引数relationshipにxbrldt:targetRole属性が設定されていない場合は,引数relationshipのxlink:role属性の値と同じ値のxlink:role属性を持つdomain-member関係を示します。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
relationship - このDRSに含まれているdomain-member関係を指定します。
戻り値:
このDRSに含まれているdomain-member関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdomain-member関係のリストを返します。該当するdomain-member関係がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数relationshipにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数relationshipに指定したXBRLDomainMemberRelationshipオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトが,このXBRLDimensionalRelationshipSetオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20034]

(8) getDimensionDefaultRelationship

public XBRLDimensionDefaultRelationship getDimensionDefaultRelationship (  
 XBRLHypercubeDimensionRelationship  relationship )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているdimension-default関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdimension-default関係を取得します。
引数relationshipと結び付いているdimension-default関係とは,次のどちらかのことです。
  • 引数relationshipにxbrldt:targetRole属性が設定されている場合は,そのxbrldt:targetRole属性の値と同じ値のxlink:role属性を持つdimension-default関係を示します。
  • 引数relationshipにxbrldt:targetRole属性が設定されていない場合は,引数relationshipのxlink:role属性の値と同じ値のxlink:role属性を持つdimension-default関係を示します。
引数:
relationship - このDRSに含まれているhypercube-dimension関係を指定します。
戻り値:
このDRSに含まれているdimension-default関係のうち,引数relationshipのto側のリソースを始点に持ち,かつ,引数relationshipと結び付いているdimension-default関係を返します。該当するdimension-default関係がない場合は,nullを返します。
例外:
XBRLDOMRuntimeException -
  • 引数relationshipにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数relationshipに指定したXBRLHypercubeDimensionRelationshipオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトが,このXBRLDimensionalRelationshipSetオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20034]

(9) getDRSDimensions

public java.util.List<XBRLDRSDimension> getDRSDimensions ( java.lang.String  role ,
   int contextElementType )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているディメンジョンの要素宣言のリストを返します。リストに含まれるのは,次の条件をすべて満たしているディメンジョンの要素宣言です。
  • このDRSに含まれているhas-hypercube関係のうち,引数roleに指定した値と同じxlink:role属性を持つhas-hypercube関係からたどることができる
  • このDRSに含まれているhas-hypercube関係のうち,引数contextElementTypeに指定した値と同じxbrldt:contextElement属性の種類を持つhas-hypercube関係からたどることができる
  • インスタンス文書に記述できる
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
role - extended型要素のxlink:role属性の値を指定します。
contextElementType - <link:definitionArc>要素のxbrldt:contextElement属性の種類を指定します。指定できる値は次のどちらかです。
  • XBRLHasHypercubeRelationship.CONTEXTELEMENT_SCENARIO
  • XBRLHasHypercubeRelationship.CONTEXTELEMENT_SEGMENT
戻り値:
このDRSに含まれているディメンジョンの要素宣言のうち,インスタンス文書に記述できるディメンジョンの要素宣言のリストを返します。該当するディメンジョンの要素宣言がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数roleにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数roleに空のURI参照を指定した場合にスローされます。[エラーコード:20110]
  • 引数contextElementTypeに不正な値を指定した場合にスローされます。引数contextElementTypeに指定できる値は,XBRLHasHypercubeRelationship.CONTEXTELEMENT_SCENARIO,またはXBRLHasHypercubeRelationship.CONTEXTELEMENT_SEGMENTです。[エラーコード:20014]

(10) getDRSDimensions

public java.util.List<XBRLDRSDimension> getDRSDimensions ( java.lang.String role )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれているディメンジョンの要素宣言のリストを返します。リストに含まれるのは,次の条件をすべて満たしているディメンジョンの要素宣言です。
  • このDRSに含まれているhas-hypercube関係のうち,引数roleに指定された値と同じxlink:role属性を持つhas-hypercube関係からたどることができる
  • インスタンス文書に記述できる
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
role - extended型要素のxlink:role属性の値を指定します。
戻り値:
このDRSに含まれているディメンジョンの要素宣言のうち,インスタンス文書に記述できるディメンジョンの要素宣言のリストを返します。該当するディメンジョンの要素宣言がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数roleにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数roleに空のURI参照を指定した場合にスローされます。[エラーコード:20110]

(11) getDRSMembers

public java.util.List<XBRLDRSMember> getDRSMembers ( XBRLDRSDimension dimension )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれている要素宣言のリストを返します。リストに含まれるのは,次の条件をすべて満たしている要素宣言です。
  • このDRSに含まれているhas-hypercube関係のうち,引数dimensionのgetRoleメソッドで取得した値と同じxlink:role属性を持つhas-hypercube関係からたどることができる,ディメンジョンの要素宣言のメンバである
  • このDRSに含まれているhas-hypercube関係のうち,引数dimensionのgetContextElementTypeメソッドで取得した値と同じxbrldt:contextElement属性の種類を持つhas-hypercube関係からたどることができる,ディメンジョンの要素宣言のメンバである
  • インスタンス文書に記述できる
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
dimension - インスタンス文書に記述できるディメンジョンを表すXBRLDRSDimensionオブジェクトを指定します。
戻り値:
このDRSに含まれている要素宣言のうち,指定されたディメンジョンのメンバとして,インスタンス文書に記述できる要素宣言のリストを返します。該当する要素宣言がない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数dimensionにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数dimensionに指定されたXBRLDRSDimensionオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトが,このXBRLDimensionalRelationshipSetオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20034]

(12) getDRSDefaultMember

public XBRLDRSMember getDRSDefaultMember ( XBRLDRSDimension dimension )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
DRSに含まれている要素宣言のうち,指定されたディメンジョンのデフォルトメンバを返します。
引数:
dimension - インスタンス文書に記述できるディメンジョンを表すXBRLDRSDimensionオブジェクトを指定します。
戻り値:
このDRSに含まれている要素宣言のうち,指定されたディメンジョンのデフォルトメンバを返します。該当する要素宣言がない場合は,nullを返します。
例外:
XBRLDOMRuntimeException -
  • 引数dimensionにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数dimensionに指定されたXBRLDRSDimensionオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトが,このXBRLDimensionalRelationshipSetオブジェクトを所有しているXBRLTaxonomyDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20034]