6.9.9 XBRLFractionクラス

public final class XBRLFraction
extends java.lang.Object

XBRLのバージョン:
2.1
説明:
データ型が分数であるアイテムの値を表します。
分数のデータ型は分子要素numeratorと分母要素denominatorで構成されます。分子要素は10進数,分母要素は0を除く10進数を含んでいる必要があります。
コンストラクタの概要:
XBRLFractionクラスのコンストラクタの概要を次の表に示します。

表6-138 XBRLFractionクラスのコンストラクタの概要

項番説明XBRLのバージョン
1XBRLFraction(java.math.BigDecimal numerator, java.math.BigDecimal denominator)
  指定した分子要素と分母要素で構成されるXBRLFractionオブジェクトを構築します。
2.1
2XBRLFraction(java.lang.String fraction)
  指定した分数の文字列表現から,XBRLFractionオブジェクトを構築します。
2.1
メソッドの概要:
XBRLFractionクラスのメソッドの概要を次の表に示します。

表6-139 XBRLFractionクラスのメソッドの概要

項番説明XBRLのバージョン
1java.math.BigDecimalgetNumerator()
  XBRLFractionオブジェクトの分子要素を取得します。
2.1
2java.math.BigDecimalgetDenominator()
  XBRLFractionオブジェクトの分母要素を取得します。
2.1
3java.lang.StringtoString()
  XBRLFractionオブジェクトの文字列を取得します。
2.1
4booleanequals(java.lang.Object obj)
  XBRLFractionオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
2.1
5inthashCode()
  XBRLFractionオブジェクトのハッシュコードを取得します。
2.1
<この項の構成>
(1) XBRLFraction
(2) XBRLFraction
(3) getNumerator
(4) getDenominator
(5) toString
(6) equals
(7) hashCode

(1) XBRLFraction

public  XBRLFraction(java.math.BigDecimal numerator,
                    java.math.BigDecimal denominator)

XBRLのバージョン:
2.1
説明:
指定した分子要素と分母要素で構成されるXBRLFractionオブジェクトを構築します。
引数:
numerator - 分数を構成する分子要素を指定します。
denominator - 分数を構成する分母要素を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数numeratorまたはdenominatorにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数denominatorの値が0の場合にスローされます。[エラーコード:25011]

(2) XBRLFraction

public  XBRLFraction(java.lang.String fraction)

XBRLのバージョン:
2.1
説明:
指定した分数の文字列表現からXBRLFractionオブジェクトを構築します。分数の文字列表現は"numerator/denominator"です。
numeratorおよびdenominatorには,共にXML Schemaのデータ型decimalとして妥当な文字列だけを指定できます。ただし,denominatorに0を表す文字列("+0.00"や"-0.0"など)は指定できません。
構築されるオブジェクトは,numeratorおよびdenominatorに指定された文字列をjava.math.BigDecimalに変換した値を保持します。このためオブジェクト構築時に指定された文字列表現と,toString()によって取得した文字列表現が異なることがあります。
引数:
fraction - 分数の文字列表現を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数fractionにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数fractionに指定された分数の文字列表現が不正な場合にスローされます。[エラーコード:25000]

(3) getNumerator

public java.math.BigDecimal getNumerator()

XBRLのバージョン:
2.1
説明:
XBRLFractionオブジェクトの分子要素を取得します。
戻り値:
XBRLFractionオブジェクトの分子要素を返します。

(4) getDenominator

public java.math.BigDecimal getDenominator()

XBRLのバージョン:
2.1
説明:
XBRLFractionオブジェクトの分母要素を取得します。
戻り値:
XBRLFractionオブジェクトの分母要素を返します。

(5) toString

public java.lang.String toString()

XBRLのバージョン:
2.1
説明:
XBRLFractionオブジェクトの文字列表現を取得します。XBRLFractionオブジェクトの文字列表現は"numerator/denominator"です。
オーバーライド:
クラスjava.lang.Object内のtoString()
戻り値:
XBRLFractionオブジェクトの文字列表現を返します。

(6) equals

public boolean equals(java.lang.Object obj)

XBRLのバージョン:
2.1
説明:
XBRLFractionオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
結果がtrueになるのは,このオブジェクトの正規形(約分した形)と等しい正規形を持つXBRLFractionオブジェクトが指定された場合だけです。文字列表現が異なる場合でも,分数として計算した結果が同値となる場合には等しいとみなされます。
オーバーライド:
クラスjava.lang.Object内のequals()
引数:
obj - XBRLFractionオブジェクトと比較するオブジェクトを指定します。
戻り値:
XBRLFractionオブジェクトが,引数objで指定されたオブジェクトと等しい場合はtrue,等しくない場合はfalseを返します。

(7) hashCode

public int hashCode()

XBRLのバージョン:
2.1
説明:
XBRLFractionオブジェクトのハッシュコードを取得します。
オーバーライド:
クラスjava.lang.Object内のhashCode()
戻り値:
XBRLFractionオブジェクトのハッシュコードを返します。