uCosminexus Business Reporting Processor 開発者ガイド

[目次][用語][索引][前へ][次へ]

6.7.7 XBRLRelationshipインターフェース

public interface XBRLRelationship

XBRLのバージョン:
2.1

説明:
アークで定義された関係を表します。

フィールドの概要:
XBRLRelationshipインターフェースのフィールドの概要を次の表に示します。

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

項番 説明
1 static int LABEL_ARC
  関係が<link:labelArc>要素によって定義されたことを示します。
2 static int REFERENCE_ARC
  関係が<link:referenceArc>要素によって定義されたことを示します。
3 static int CALCULATION_ARC
  関係が<link:calculationArc>要素によって定義されたことを示します。
4 static int DEFINITION_ARC
  関係が<link:definitionArc>要素によって定義されたことを示します。
5 static int PRESENTATION_ARC
  関係が<link:presentationArc>要素によって定義されたことを示します。
6 static int FOOTNOTE_ARC
  関係が<link:footnoteArc>要素によって定義されたことを示します。
7 static int HAS_HYPERCUBE_ARC
  関係が<link:definitionArc>要素によって定義されたhas-hypercube関係であることを示します。
8 static int HYPERCUBE_DIMENSION_ARC
  関係が<link:definitionArc>要素によって定義されたhypercube-dimension関係であることを示します。
9 static int DIMENSION_DOMAIN_ARC
  関係が<link:definitionArc>要素によって定義されたdimension-domain関係であることを示します。
10 static int DOMAIN_MEMBER_ARC
  関係が<link:definitionArc>要素によって定義されたdomain-member関係であることを示します。
11 static int DIMENSION_DEFAULT_ARC
  関係が<link:definitionArc>要素によって定義されたdimension-default関係であることを示します。

メソッドの概要:
XBRLRelationshipインターフェースのメソッドの概要を次の表に示します。

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

項番 説明 XBRLのバージョン
1 int getArcType()
  関係を定義したアークの種類を調べます。
2.1
2 java.lang.String getExtendedLinkRole()
  関係を定義したアークを含む拡張リンクのロールを取得します。
2.1
3 java.lang.String getArcrole()
  関係を定義したアークのアークロールを取得します。
2.1
4 java.math.BigDecimal getOrder()
  関係を定義したアークのorder属性の値を取得します。
2.1
5 java.lang.Object getFrom()
  関係のfrom側のリソースを取得します。
2.1
6 java.lang.Object getTo()
  関係のto側のリソースを取得します。
2.1
7 java.math.BigInteger getPriority()
  関係を定義したアークのpriority属性の値を取得します。
2.1
8 boolean isOrderAttributeSpecified()
  関係を定義したアークのorder属性が定義されているかを判定します。
2.1
<この項の構成>
(1) getArcType
(2) getExtendedLinkRole
(3) getArcrole
(4) getOrder
(5) getFrom
(6) getTo
(7) getPriority
(8) isOrderAttributeSpecified

(1) getArcType

public int getArcType()

XBRLのバージョン:
2.1

説明:
関係を定義したアークの種類を調べます。
この関係を定義したアークの種類に応じて,このXBRLRelationshipオブジェクトを,各種のアークに特化したインターフェースへキャストできます。アークの種類とインターフェースの関係を次の表に示します。

表6-72 アークの種類とインターフェースの関係

項番 関係を定義したアークの種類
(getArcType()メソッドが返すコード)
対応するインターフェース
1 LABEL_ARC XBRLLabelRelationship
2 REFERENCE_ARC XBRLReferenceRelationship
3 CALCULATION_ARC XBRLCalculationRelationship
4 DEFINITION_ARC XBRLDefinitionRelationship
5 PRESENTATION_ARC XBRLPresentationRelationship
6 FOOTNOTE_ARC XBRLFootnoteRelationship
7 HAS_HYPERCUBE_ARC XBRLHasHypercubeRelationship
8 HYPERCUBE_DIMENSION_ARC XBRLHypercubeDimensionRelationship
9 DIMENSION_DOMAIN_ARC XBRLDimensionDomainRelationship
10 DOMAIN_MEMBER_ARC XBRLDomainMemberRelationship
11 DIMENSION_DEFAULT_ARC XBRLDimensionDefaultRelationship

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


戻り値:
この関係を定義したアークの種類を返します。

(2) getExtendedLinkRole

public java.lang.String getExtendedLinkRole()

XBRLのバージョン:
2.1

説明:
関係を定義したアークを含む拡張リンクのロールを取得します。

戻り値:
この関係を定義したアークを含む拡張リンクのロールを返します。

(3) getArcrole

public java.lang.String getArcrole()

XBRLのバージョン:
2.1

説明:
関係を定義したアークのアークロールを取得します。

戻り値:
この関係を定義したアークのアークロールを返します。

(4) getOrder

public java.math.BigDecimal getOrder()

XBRLのバージョン:
2.1

説明:
関係を定義したアークのorder属性の値を取得します。

戻り値:
この関係を定義したアークのorder属性の値を返します。order属性がない場合は1を返します。

(5) getFrom

public java.lang.Object getFrom()

XBRLのバージョン:
2.1

説明:
関係のfrom側のリソースを取得します。
このメソッドの戻り値は,関係を定義したアークの種類によって異なります。アークの種類とfrom側のリソースの関係を,次の表に示します。

表6-73 アークの種類とfrom側のリソースの関係

項番 関係を定義したアークの種類
(getArcType()メソッドが返すコード)
from側のリソース
(getFrom()メソッドが返すオブジェクト)
1 LABEL_ARC XBRLTaxonomyElement
2 REFERENCE_ARC XBRLTaxonomyElement
3 CALCULATION_ARC XBRLTaxonomyElement
4 DEFINITION_ARC XBRLTaxonomyElement
5 PRESENTATION_ARC XBRLTaxonomyElement
6 FOOTNOTE_ARC XBRLInstanceElement
7 HAS_HYPERCUBE_ARC XBRLTaxonomyItem
8 HYPERCUBE_DIMENSION_ARC XBRLTaxonomyHypercubeItem
9 DIMENSION_DOMAIN_ARC XBRLTaxonomyDimensionItem
10 DOMAIN_MEMBER_ARC XBRLTaxonomyItem
11 DIMENSION_DEFAULT_ARC XBRLTaxonomyDimensionItem

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


戻り値:
この関係のfrom側のリソースを表すオブジェクトを返します。

(6) getTo

public java.lang.Object getTo()

XBRLのバージョン:
2.1

説明:
関係のto側のリソースを取得します。
このメソッドの戻り値は,関係を定義したアークの種類によって異なります。アークの種類とto側のリソースの関係を次の表に示します。

表6-74 アークの種類とto側のリソースの関係

項番 関係を定義したアークの種類
(getArcType()メソッドが返すコード)
to側のリソース
(getTo()メソッドが返すオブジェクト)
1 LABEL_ARC XBRLLabel
2 REFERENCE_ARC XBRLReference
3 CALCULATION_ARC XBRLTaxonomyElement
4 DEFINITION_ARC XBRLTaxonomyElement
5 PRESENTATION_ARC XBRLTaxonomyElement
6 FOOTNOTE_ARC XBRLFootnote
7 HAS_HYPERCUBE_ARC XBRLTaxonomyHypercubeItem
8 HYPERCUBE_DIMENSION_ARC XBRLTaxonomyDimensionItem
9 DIMENSION_DOMAIN_ARC XBRLTaxonomyItem
10 DOMAIN_MEMBER_ARC XBRLTaxonomyItem
11 DIMENSION_DEFAULT_ARC XBRLTaxonomyItem

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


戻り値:
この関係のto側のリソースを表すオブジェクトを返します。

(7) getPriority

public java.math.BigInteger getPriority()

XBRLのバージョン:
2.1

説明:
関係を定義したアークのpriority属性の値を取得します。

戻り値:
この関係を定義したアークのpriority属性の値を返します。priority属性がない場合は0(デフォルト値)を返します。

(8) isOrderAttributeSpecified

public boolean isOrderAttributeSpecified()

XBRLのバージョン:
2.1

説明:
関係を定義したアークのorder属性が定義されているかを判定します。

戻り値:
この関係を定義したアークのorder属性が定義されている場合はtrue,order属性が定義されていない場合はfalseを返します。XBRLInstanceElementのaddFootnote()で生成されるXBRLRelationshipオブジェクトは常にtrueを返します。