6.7.7 XBRLRelationshipインターフェース

public interface XBRLRelationship

XBRLのバージョン:
2.1
説明:
アークで定義された関係を表します。
フィールドの概要:
XBRLRelationshipインターフェースのフィールドの概要を次の表に示します。

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

項番説明
1static intLABEL_ARC
  関係が<link:labelArc>要素によって定義されたことを示します。
2static intREFERENCE_ARC
  関係が<link:referenceArc>要素によって定義されたことを示します。
3static intCALCULATION_ARC
  関係が<link:calculationArc>要素によって定義されたことを示します。
4static intDEFINITION_ARC
  関係が<link:definitionArc>要素によって定義されたことを示します。
5static intPRESENTATION_ARC
  関係が<link:presentationArc>要素によって定義されたことを示します。
6static intFOOTNOTE_ARC
  関係が<link:footnoteArc>要素によって定義されたことを示します。
7static intHAS_HYPERCUBE_ARC
  関係が<link:definitionArc>要素によって定義されたhas-hypercube関係であることを示します。
8static intHYPERCUBE_DIMENSION_ARC
  関係が<link:definitionArc>要素によって定義されたhypercube-dimension関係であることを示します。
9static intDIMENSION_DOMAIN_ARC
  関係が<link:definitionArc>要素によって定義されたdimension-domain関係であることを示します。
10static intDOMAIN_MEMBER_ARC
  関係が<link:definitionArc>要素によって定義されたdomain-member関係であることを示します。
11static intDIMENSION_DEFAULT_ARC
  関係が<link:definitionArc>要素によって定義されたdimension-default関係であることを示します。
メソッドの概要:
XBRLRelationshipインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1intgetArcType()
  関係を定義したアークの種類を調べます。
2.1
2java.lang.StringgetExtendedLinkRole()
  関係を定義したアークを含む拡張リンクのロールを取得します。
2.1
3java.lang.StringgetArcrole()
  関係を定義したアークのアークロールを取得します。
2.1
4java.math.BigDecimalgetOrder()
  関係を定義したアークのorder属性の値を取得します。
2.1
5java.lang.ObjectgetFrom()
  関係のfrom側のリソースを取得します。
2.1
6java.lang.ObjectgetTo()
  関係のto側のリソースを取得します。
2.1
7java.math.BigIntegergetPriority()
  関係を定義したアークのpriority属性の値を取得します。
2.1
8booleanisOrderAttributeSpecified()
  関係を定義したアークの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()メソッドが返すコード)
対応するインターフェース
1LABEL_ARCXBRLLabelRelationship
2REFERENCE_ARCXBRLReferenceRelationship
3CALCULATION_ARCXBRLCalculationRelationship
4DEFINITION_ARCXBRLDefinitionRelationship
5PRESENTATION_ARCXBRLPresentationRelationship
6FOOTNOTE_ARCXBRLFootnoteRelationship
7HAS_HYPERCUBE_ARCXBRLHasHypercubeRelationship
8HYPERCUBE_DIMENSION_ARCXBRLHypercubeDimensionRelationship
9DIMENSION_DOMAIN_ARCXBRLDimensionDomainRelationship
10DOMAIN_MEMBER_ARCXBRLDomainMemberRelationship
11DIMENSION_DEFAULT_ARCXBRLDimensionDefaultRelationship

注※ 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()メソッドが返すオブジェクト)
1LABEL_ARCXBRLTaxonomyElement
2REFERENCE_ARCXBRLTaxonomyElement
3CALCULATION_ARCXBRLTaxonomyElement
4DEFINITION_ARCXBRLTaxonomyElement
5PRESENTATION_ARCXBRLTaxonomyElement
6FOOTNOTE_ARCXBRLInstanceElement
7HAS_HYPERCUBE_ARCXBRLTaxonomyItem
8HYPERCUBE_DIMENSION_ARCXBRLTaxonomyHypercubeItem
9DIMENSION_DOMAIN_ARCXBRLTaxonomyDimensionItem
10DOMAIN_MEMBER_ARCXBRLTaxonomyItem
11DIMENSION_DEFAULT_ARCXBRLTaxonomyDimensionItem

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


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

(6) getTo

public java.lang.Object getTo()

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

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

項番関係を定義したアークの種類
(getArcType()メソッドが返すコード)
to側のリソース
(getTo()メソッドが返すオブジェクト)
1LABEL_ARCXBRLLabel
2REFERENCE_ARCXBRLReference
3CALCULATION_ARCXBRLTaxonomyElement
4DEFINITION_ARCXBRLTaxonomyElement
5PRESENTATION_ARCXBRLTaxonomyElement
6FOOTNOTE_ARCXBRLFootnote
7HAS_HYPERCUBE_ARCXBRLTaxonomyHypercubeItem
8HYPERCUBE_DIMENSION_ARCXBRLTaxonomyDimensionItem
9DIMENSION_DOMAIN_ARCXBRLTaxonomyItem
10DOMAIN_MEMBER_ARCXBRLTaxonomyItem
11DIMENSION_DEFAULT_ARCXBRLTaxonomyItem

注※ 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を返します。