uCosminexus Business Reporting Processor 開発者ガイド

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

6.7.18 XBRLDimensionIllegalCycleExceptionクラス

public class XBRLDimensionIllegalCycleException
extends XBRLDimensionException

XBRLのバージョン:
2.1

XBRL Dimensionsのバージョン:
1.0

説明:
DRSの関係ネットワークに対するサイクル検証で検出されたエラーを通知するために,uCosminexus Business Reporting Processorによって生成されます。

メソッドの概要:
XBRLDimensionIllegalCycleExceptionクラスのメソッドの概要を次の表に示します。

表6-86 XBRLDimensionIllegalCycleExceptionクラスのメソッドの概要

項番 説明 XBRLのバージョン XBRL Dimensionsのバージョン
1 java.lang.String getLinkName()
  エラーが検出されたDRSの関係ネットワークを定義している拡張リンクの種類を取得します。
2.1 1.0
2 java.lang.String getExtendedLinkRole()
  エラーが検出されたDRSの関係ネットワークを定義している拡張リンクのロールを取得します。
2.1 1.0
3 java.lang.String getArcrole()
  エラーが検出されたDRSの関係ネットワークを定義しているアークのアークロールを取得します。
2.1 1.0
4 java.lang.String getCyclesAllowed()
  エラーが検出されたDRSの関係ネットワークで許可されるサイクルの種類を取得します。
2.1 1.0
5 XBRLRelationship[] getErrorRoutes()
  誤っていた経路を取得します。
2.1 1.0
<この項の構成>
(1) getLinkName
(2) getExtendedLinkRole
(3) getArcrole
(4) getCyclesAllowed
(5) getErrorRoutes

(1) getLinkName

public java.lang.String getLinkName()

XBRLのバージョン:
2.1

XBRL Dimensionsのバージョン:
1.0

説明:
エラーが検出されたDRSの関係ネットワークを定義している拡張リンクの種類を取得します。
このメソッドが返す文字列は,拡張リンクを記述しているextended型要素のローカル名です。

戻り値:
エラーが検出されたDRSの関係ネットワークを定義している拡張リンクの種類を返します。

(2) getExtendedLinkRole

public java.lang.String getExtendedLinkRole()

XBRLのバージョン:
2.1

XBRL Dimensionsのバージョン:
1.0

説明:
エラーが検出されたDRSの関係ネットワークを定義している拡張リンクのロールを取得します。

戻り値:
エラーが検出されたDRSの関係ネットワークを定義している拡張リンクのロールを返します。

(3) getArcrole

public java.lang.String getArcrole()

XBRLのバージョン:
2.1

XBRL Dimensionsのバージョン:
1.0

説明:
エラーが検出されたDRSの関係ネットワークを定義しているアークのアークロールを取得します。

戻り値:
エラーが検出されたDRSの関係ネットワークを定義しているアークのアークロールを返します。

(4) getCyclesAllowed

public java.lang.String getCyclesAllowed()

XBRLのバージョン:
2.1

XBRL Dimensionsのバージョン:
1.0

説明:
エラーが検出されたDRSの関係ネットワークで許可されるサイクルの種類を取得します。
このメソッドが返す文字列は次のどちらかです。
  • undirected
  • none
サイクルの種類については,「2.3.2(6) 関係ネットワーク上のサイクルの検証【完全な妥当性検証の場合だけ有効】」を参照してください。

戻り値:
エラーが検出されたDRSの関係ネットワークで許可されるサイクルの種類を返します。

(5) getErrorRoutes

public XBRLRelationship[] getErrorRoutes()

XBRLのバージョン:
2.1

XBRL Dimensionsのバージョン:
1.0

説明:
誤っていた経路を取得します。
このメソッドは,誤っていた経路を構成している関係をXBRLRelationshipオブジェクトの配列として返します。この配列に格納されているXBRLRelationshipオブジェクトは,経路の始点から終点へ向かう順番で並んでいます。例を次の図に示します。

図6-16 XBRLDimensionIllegalCycleException.getErrorRoutes()メソッドが返す配列の例

[図データ]

戻り値:
誤っていた経路を示すXBRLRelationshipオブジェクトの配列を返します。