6.10.10 XBRLEqualUtilクラス

public final class XBRLEqualUtil
extends java.lang.Object

XBRLのバージョン:
2.1
説明:
項目とタプルの重複検出に関連する同等判定を可能にする機能を提供します。
コンストラクタの概要:
XBRLEqualUtilクラスのコンストラクタの概要を次の表に示します。

表6-174 XBRLEqualUtilクラスのコンストラクタの概要

項番説明XBRLのバージョン
1XBRLEqualUtil()
  XBRLEqualUtilオブジェクトを構築します。
2.1
2XBRLEqualUtil(boolean ignoringZeroPrecision)
  XBRLEqualUtilオブジェクトを構築します。
2.1
メソッドの概要:
XBRLEqualUtilクラスのメソッドの概要を次の表に示します。

表6-175 XBRLEqualUtilクラスのメソッドの概要

項番説明XBRLのバージョンXBRL Dimensionsのバージョン
1booleans_equalContext(XBRLContext2 context1, XBRLContext2 context2)
  コンテキストがs-equalかどうかを判定します。
2.1該当しない
2booleans_equalItem(XBRLInstanceItem item1, XBRLInstanceItem item2)
  アイテムがs-equalかどうかを判定します。
2.1該当しない
3booleans_equalTuple(XBRLInstanceTuple tuple1, XBRLInstanceTuple tuple2)
  タプルがs-equalかどうかを判定します。
2.1該当しない
4booleans_equalUnit(XBRLUnit2 unit1, XBRLUnit2 unit2)
  単位がs-equalかどうかを判定します。
2.1該当しない
5booleanduplicateItem(XBRLInstanceItem item1, XBRLInstanceItem item2)
  アイテムがduplicateかどうかを判定します。
2.1該当しない
6booleanduplicateTuple(XBRLInstanceTuple tuple1, XBRLInstanceTuple tuple2)
  タプルがduplicateかどうかを判定します。
2.1該当しない
7booleansetIgnoringZeroPrecision(boolean ignoringZeroPrecision)
  XBRLEqualUtilオブジェクトに設定されている精度0のアイテムの扱いを設定します。
2.1該当しない
8booleanisIgnoringZeroPrecision()
  XBRLEqualUtilオブジェクトに設定されている精度0のアイテムの扱いを取得します。
2.1該当しない
9booleand_equalItem(XBRLInstanceItem item1, XBRLInstanceItem item2, XBRLDimensionMember member)
  引数に指定したアイテム同士がs-equalで,かつ,引数に指定したディメンジョンのメンバが両方のアイテムのコンテキストに存在するかどうかを判定します。
2.11.0
<この項の構成>
(1) XBRLEqualUtil
(2) XBRLEqualUtil
(3) s_equalContext
(4) s_equalItem
(5) s_equalTuple
(6) s_equalUnit
(7) duplicateItem
(8) duplicateTuple
(9) setIgnoringZeroPrecision
(10) isIgnoringZeroPrecision
(11) d_equalItem

(1) XBRLEqualUtil

public XBRLEqualUtil()

XBRLのバージョン:
2.1
説明:
XBRLEqualUtilオブジェクトを構築します。このコンストラクタで生成した場合,精度0のアイテムの扱いはfalseとなります。精度0のアイテムの扱いについては「6.10.10(2) XBRLEqualUtil」または「6.10.10(9) setIgnoringZeroPrecision」を参照してください。

(2) XBRLEqualUtil

public XBRLEqualUtil(boolean ignoringZeroPrecision)

XBRLのバージョン:
2.1
説明:
XBRLEqualUtilオブジェクトを構築します。
引数:
ignoringZeroPrecision - 精度0のアイテムの扱いを指定します。各アイテムの値の判定では,この設定値(デフォルトはfalse)がfalse の場合,(精度を考慮し)精度が"0"のアイテムの値は無効な値(NaNと同じ扱い)として,どちらかが精度"0"の場合は常に不正とします。true の場合は,(精度を考慮せず)値の丸めは行わず記述されている数値の比較とします。

(3) s_equalContext

public boolean s_equalContext(XBRLContext2 context1,
                             XBRLContext2 context2)

XBRLのバージョン:
2.1
説明:
引数に指定したコンテキスト同士が s-equal かどうかを判定します。s-equalの場合,trueを返します。s-equalでない場合は,falseを返します。また,引数に指定したコンテキスト同士のインスタンス文書が異なる場合でも,s-equalの判定には影響しません。引数に指定したコンテキスト同士が同一のオブジェクトの場合は,必ずtrueを返します。
引数:
context1- コンテキストを指定します。
context2- コンテキストを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数context1またはcontext2にnullを指定した場合にスローされます。[エラーコード:20002]

(4) s_equalItem

public boolean s_equalItem(XBRLInstanceItem item1,
                          XBRLInstanceItem item2)

XBRLのバージョン:
2.1
説明:
引数に指定したアイテム同士が s-equal かどうかを判定します。s-equalの場合,trueを返します。s-equalでない場合は,falseを返します。また,引数に指定したアイテム同士のインスタンス文書が異なる場合でも,s-equalの判定には影響しません。引数に指定したアイテム同士が同一のオブジェクトの場合は,必ずtrueを返します。
引数:
item1- アイテムを指定します。
item2- アイテムを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数item1またはitem2にnullを指定した場合にスローされます。[エラーコード:20002]

(5) s_equalTuple

public boolean s_equalTuple(XBRLInstanceTuple tuple1,
                           XBRLInstanceTuple tuple2)

XBRLのバージョン:
2.1
説明:
引数に指定したタプル同士が s-equal かどうかを判定します。s-equalの場合,trueを返します。s-equalでない場合は,falseを返します。また,引数に指定したタプル同士のインスタンス文書が異なる場合でも,s-equalの判定には影響しません。引数に指定したタプル同士が同一のオブジェクトの場合は,必ずtrueを返します。
引数:
tuple1- タプルを指定します。
tuple2- タプルを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数tuple1またはtuple2にnullを指定した場合にスローされます。[エラーコード:20002]

(6) s_equalUnit

public boolean s_equalUnit(XBRLUnit2 unit1,
                          XBRLUnit2 unit2)

XBRLのバージョン:
2.1
説明:
引数に指定した単位同士が s-equal かどうかを判定します。s-equalの場合,trueを返します。s-equalでない場合は,falseを返します。また,引数に指定した単位同士のインスタンス文書が異なる場合でも,s-equalの判定には影響しません。引数に指定した単位同士が同一のオブジェクトの場合は,必ずtrueを返します。
引数:
unit1-単位を指定します。
unit2-単位を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数unit1またはunit2にnullを指定した場合にスローされます。[エラーコード:20002]

(7) duplicateItem

public boolean duplicateItem(XBRLInstanceItem item1,
                            XBRLInstanceItem item2)

XBRLのバージョン:
2.1
説明:
引数に指定したアイテム同士が duplicateかどうかを判定します。duplicateの場合,trueを返します。duplicateでない場合は,falseを返します。また,引数に指定したアイテム同士のインスタンス文書が異なる場合,falseを返します。引数に指定したアイテム同士が同一のオブジェクトの場合,falseを返します。
引数:
item1- アイテムを指定します。
item2- アイテムを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数item1またはitem2にnullを指定した場合にスローされます。[エラーコード:20002]

(8) duplicateTuple

public boolean duplicateTuple(XBRLInstanceTuple tuple1,
                             XBRLInstanceTuple tuple2)

XBRLのバージョン:
2.1
説明:
引数に指定したタプル同士が duplicateかどうかを判定します。duplicateの場合,trueを返します。duplicateでない場合は,falseを返します。また,引数に指定したタプル同士のインスタンス文書が異なる場合,falseを返します。引数に指定したタプル同士が同一のオブジェクトの場合,falseを返します。タプルの子要素として,精度0のアイテムが記述されている場合,その値の判定はコンストラクタまたはsetIgnoringZeroPrecisionメソッドで設定した精度0のアイテムの扱いに従います。精度0のアイテムの扱いについては「6.10.10(2) XBRLEqualUtil」または6.10.10(9) setIgnoringZeroPrecision」を参照してください。
引数:
tuple1- タプルを指定します。
tuple2- タプルを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数tuple1またはtuple2にnullを指定した場合にスローされます。[エラーコード:20002]

(9) setIgnoringZeroPrecision

public void setIgnoringZeroPrecision(boolean ignoringZeroPrecision)

XBRLのバージョン:
2.1
説明:
XBRLEqualUtilオブジェクトに設定されている精度 0 のアイテムの扱いを設定します。各アイテムの値の判定では,この設定値(デフォルトはfalse)がfalse の場合,(精度を考慮し)精度が"0"のアイテムの値は無効な値(NaNと同じ扱い)として,どちらかが精度"0"の場合は常に不正とします。true の場合は,(精度を考慮せず)値の丸めは行わず記述されている数値の比較とします。
引数:
ignoringZeroPrecision -オブジェクトに設定する精度 0 のアイテムの扱いを指定します。

(10) isIgnoringZeroPrecision

public boolean isIgnoringZeroPrecision()

XBRLのバージョン:
2.1
説明:
XBRLEqualUtilオブジェクトに設定されている精度0のアイテムの扱いを取得します。

(11) d_equalItem

public boolean d_equalItem ( XBRLInstanceItem item1 ,
  XBRLInstanceItem item2 ,
  XBRLDimensionMember member )

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
引数に指定したアイテム同士がs-equalで,かつ,引数に指定したディメンジョンのメンバが両方のアイテムのコンテキストに存在するかどうかを判定します。
引数:
item1 - アイテムを指定します。
item 2 - アイテムを指定します。
member - ディメンジョンのメンバを指定します。
戻り値:
引数に指定したアイテム同士がs-equalで,かつ,引数に指定したディメンジョンのメンバが両方のアイテムのコンテキストに存在する場合,trueを返します。そうでない場合,falseを返します。
引数に指定したアイテム同士のインスタンス文書が異なる場合であっても,このメソッドの判定には影響しません。
例外:
XBRLDOMRuntimeException -
  • 引数item1またはitem2にnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数memberにnullを指定した場合にスローされます。[エラーコード:20002]