6.11.2 SimpleEdgeインターフェース

public interface SimpleEdge
extends SimpleNode

XBRLのバージョン:
2.1
説明:
単純なタクソノミー文書を構成する関係ネットワークの一辺(一つの関係)を表します。
フィールドの概要:
SimpleEdgeインターフェースのフィールドの概要を次の表に示します。

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

項番説明
1static intLABEL_EDGE
  単純なタクソノミー文書のラベルリンクの一辺を示します。
2static java.lang.StringUSE_OPTIONAL
  アーク型要素のuse属性の候補値である文字列optionalを示します。
3static java.lang.StringUSE_PROHIBITED
  アーク型要素のuse属性の候補値である文字列prohibitedを示します。
メソッドの概要:
SimpleEdgeインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1java.lang.StringgetRole()
  一つの関係が属する拡張リンク型要素のxlink:role属性値を取得します。
2.1
2java.lang.StringgetArcrole()
  一つの関係を構成するアーク型要素のxlink:arcrole属性値を取得します。
2.1
3java.lang.StringgetUse()
  一つの関係を構成するアーク型要素のuse属性値を取得します。
2.1
4java.lang.ObjectgetFrom()
  一つの関係を構成するアーク型要素のxlink:from属性値で参照されるオブジェクトを取得します。
2.1
5java.lang.ObjectgetTo()
  一つの関係を構成するアーク型要素のxlink:to属性値で参照されるオブジェクトを取得します。
2.1
6java.math.BigDecimalgetOrder()
  一つの関係を構成するアーク型要素のorder属性値を取得します。
2.1
7voidsetOrder(java.math.BigDecimal order)
  一つの関係を構成するアーク型要素のorder属性値を設定します。
2.1
<この項の構成>
(1) getRole
(2) getArcrole
(3) getUse
(4) getFrom
(5) getTo
(6) getOrder
(7) setOrder

(1) getRole

public java.lang.String getRole()

XBRLのバージョン:
2.1
説明:
一つの関係が属する拡張リンク型要素のxlink:role属性値を取得します。
戻り値:
一つの関係が属する拡張リンク型要素のxlink:role属性値を返します。

(2) getArcrole

public java.lang.String getArcrole()

XBRLのバージョン:
2.1
説明:
一つの関係を構成するアーク型要素のxlink:arcrole属性値を取得します。
戻り値:
一つの関係を構成するアーク型要素のxlink:arcrole属性値を返します。

(3) getUse

public java.lang.String getUse()

XBRLのバージョン:
2.1
説明:
一つの関係を構成するアーク型要素のuse属性値を取得します。
戻り値:
一つの関係を構成するアーク型要素のuse属性値を返します。

(4) getFrom

public java.lang.Object getFrom()

XBRLのバージョン:
2.1
説明:
一つの関係を構成するアーク型要素のxlink:from属性値で参照されるオブジェクトを取得します。
戻り値:
一つの関係を構成するアーク型要素のxlink:from属性値で参照されるオブジェクトを返します。

(5) getTo

public java.lang.Object getTo()

XBRLのバージョン:
2.1
説明:
一つの関係を構成するアーク型要素のxlink:to属性値で参照されるオブジェクトを取得します。
戻り値:
一つの関係を構成するアーク型要素のxlink:to属性値で参照されるオブジェクトを返します。

(6) getOrder

public java.math.BigDecimal getOrder()

XBRLのバージョン:
2.1
説明:
一つの関係を構成するアーク型要素のorder属性値を取得します。
注 このSimpleEdgeオブジェクトが既存の関係を否定するオブジェクトでない場合,order属性値はオブジェクト生成時に「1」が設定されます。
また,このSimpleEdgeオブジェクトが既存の関係を否定するオブジェクトの場合,既存の関係と同じ値が設定されます。
戻り値:
一つの関係を構成するアーク型要素のorder属性値を返します。

(7) setOrder

public void setOrder(java.math.BigDecimal order)

XBRLのバージョン:
2.1
説明:
一つの関係を構成するアーク型要素のorder属性値を設定します。このSimpleEdgeオブジェクトが既存の関係を否定するオブジェクトの場合は,このメソッドを利用できません。
引数:
order - 一つの関係を構成するアーク型要素のorder属性値を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数orderにnullを指定した場合にスローされます。[エラーコード:20002]
  • このSimpleEdgeオブジェクトが既存の関係を否定するオブジェクトであった場合にスローされます。[エラーコード:22004]