6.9.6 XBRLDateUnionクラス

public final class XBRLDateUnion
extends java.lang.Object

XBRLのバージョン:
2.0および2.1
説明:
XBRLのデータ型dateUnionを表します。
XBRLのデータ型dateUnionは,XML Schemaで次のとおり定義されています。

<simpleType name="dateUnion">
       <union memberTypes="date dateTime"/>
</simpleType>

注 このクラスはequals()と一貫性のない,自然順序づけを持ちます。
フィールドの概要:
XBRLDateUnionクラスのフィールドの概要を次の表に示します。

表6-131 XBRLDateUnionクラスのフィールドの概要

項番説明
1static intDATE
  このdateUnion型のメンバは,XML Schemaのdate型です。
2static intDATETIME
  このdateUnion型のメンバは,XML SchemaのdateTime型です。
コンストラクタの概要:
XBRLDateUnionクラスのコンストラクタの概要を次の表に示します。

表6-132 XBRLDateUnionクラスのコンストラクタの概要

項番説明XBRLのバージョン
1XBRLDateUnion(java.lang.String dateunion)
  指定したdateUnion型データの文字列表現から,XBRLDateUnionオブジェクトを構築します。
2.0および2.1
2XBRLDateUnion(XBRLDate date)
  指定したXBRLDateオブジェクトから,XBRLDateUnionオブジェクトを構築します。
2.0および2.1
3XBRLDateUnion(XBRLDateTime datetime)
  指定したXBRLDateTimeオブジェクトから,XBRLDateUnionオブジェクトを構築します。
2.0および2.1
メソッドの概要:
XBRLDateUnionクラスのメソッドの概要を次の表に示します。

表6-133 XBRLDateUnionクラスのメソッドの概要

項番説明XBRLのバージョン
1intgetMemberType()
  dateUnion型データのメンバの型を調べます。
2.0および2.1
2java.lang.ObjectgetMember()
  dateUnion型データのメンバを取得します。
2.0および2.1
3intcompareTo(XBRLDateUnion other)
  XBRLDateUnionオブジェクトとほかのXBRLDateUnionオブジェクトを比較します。
2.0および2.1
4java.lang.StringtoString()
  dateUnion型データの文字列表現を取得します。
2.0および2.1
5booleanequals(java.lang.Object obj)
  XBRLDateUnionオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
2.0および2.1
6inthashCode()
  XBRLDateUnionオブジェクトのハッシュコードを取得します。
2.0および2.1
<この項の構成>
(1) XBRLDateUnion
(2) XBRLDateUnion
(3) XBRLDateUnion
(4) getMemberType
(5) getMember
(6) compareTo
(7) toString
(8) equals
(9) hashCode

(1) XBRLDateUnion

public  XBRLDateUnion(java.lang.String dateunion)

XBRLのバージョン:
2.0および2.1
説明:
指定したdateUnion型データの文字列表現から,XBRLDateUnionオブジェクトを構築します。次の文字列表現だけ指定できます。文字列表現が不正な場合は例外がスローされます。
指定できる文字列表現:BNF表記

datetimeFormat ::= ('-')?(date | date timezone)
date ::= year '-' month '-' day 'T' hour ':' minute ':' second | year '-' month '-' day
timezone ::= 'Z' | ('+'|'-') hour ':' minute
year ::= ([0-9])*[0-9][0-9][0-9][0-9]
month ::= [0][0-9] | [1][0-2]
day ::= [0-2][0-9] | [3][0-1]
hour ::= [0-1][0-9] | [2][0-3]
minute ::= [0-5][0-9]
second ::= [0-5][0-9] | [0-5][0-9]'.'([0-9])+

yearには「0」を指定できません。dayは,BNF表記で表現できない月ごとの最大値もチェックします。うるう年も考慮してチェックします。うるう秒は考慮しません。
秒以下の値は,小数第4桁で四捨五入しミリ秒単位に丸めます。このためオブジェクト構築時に指定した文字列表現と,toString()によって取得した文字列表現が異なることがあります。
引数:
dateunion - dateUnion型データの文字列表現を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数dateunionにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数dateunionに指定したdateUnion型データの文字列表現が不正な場合にスローされます。[エラーコード:25000]

(2) XBRLDateUnion

public  XBRLDateUnion(XBRLDate date)

XBRLのバージョン:
2.0および2.1
説明:
指定したXBRLDateオブジェクトから,XBRLDateUnionオブジェクトを構築します。
引数:
date - date型データを表すXBRLDateオブジェクトを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数dateにnullを指定した場合にスローされます。[エラーコード:20002]

(3) XBRLDateUnion

public  XBRLDateUnion(XBRLDateTime datetime)

XBRLのバージョン:
2.0および2.1
説明:
指定したXBRLDateTimeオブジェクトから,XBRLDateUnionオブジェクトを構築します。
引数:
datetime - dateTime型データを表すXBRLDateTimeオブジェクトを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数datetimeにnullを指定した場合にスローされます。[エラーコード:20002]

(4) getMemberType

public int getMemberType()

XBRLのバージョン:
2.0および2.1
説明:
dateUnion型データのメンバの型を調べます。
戻り値:
dateUnion型データのメンバの型を表すコードを返します。

(5) getMember

public java.lang.Object getMember()

XBRLのバージョン:
2.0および2.1
説明:
dateUnion型データのメンバを取得します。
戻り値:
このdateUnion型データのメンバを返します。このメソッドの戻り値は,XBRLDateまたはXBRLDateTimeのどちらかにキャストできます。どちらにキャストできるかは,getMemberType()で調べることができます。

(6) compareTo

public int compareTo(XBRLDateUnion other)

XBRLのバージョン:
2.0および2.1
説明:
XBRLDateUnionオブジェクトとほかのXBRLDateUnionオブジェクトを比較します。
タイムゾーンオフセットを反映した結果で比較します。タイムゾーン指定のないものについてはUTC(協定世界時)と仮定し,比較します。また,date型データの場合は,時間を「00:00:00.000」と仮定し比較します。
注 このメソッドの実行結果とequals()とは一貫性がありません。
引数:
other - 比較対象のXBRLDateUnionオブジェクトを指定します。
戻り値:
このXBRLDateUnionオブジェクトが,引数otherで指定したXBRLDateUnionオブジェクトと等しい場合は0を返します。引数otherで指定したXBRLDateUnionオブジェクトよりも小さい場合は0より小さい値,大きい場合は0より大きい値を返します。

(7) toString

public java.lang.String toString()

XBRLのバージョン:
2.0および2.1
説明:
dateUnion型データの文字列表現を取得します。
このオブジェクトで保持する値がdateTime型データの場合,秒以下の値は必ず小数第3桁で表現します。このためオブジェクト構築時に指定した文字列表現と,toStringによって取得した文字列表現が異なることがあります。
オーバーライド:
クラスjava.lang.Object内のtoString()
戻り値:
dateUnion型データの文字列表現を返します。

(8) equals

public boolean equals(java.lang.Object obj)

XBRLのバージョン:
2.0および2.1
説明:
XBRLDateUnionオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
タイムゾーンを含み同じ文字列表現となる場合だけ,等しいものとみなします。dateTime型データとdate型データが同じ値となる場合でも,オブジェクト構築時に指定した文字列表現またはオブジェクト型が異なる場合には,等しいものとみなしません。タイムゾーンオフセットを反映した結果が同じ値となる場合でも,タイムゾーンの表現方法が別表現の場合は異なるものとみなします。
注 このメソッドの実行結果とcompareTo()とは一貫性がありません。
オーバーライド:
クラスjava.lang.Object内のequals()
引数:
obj - XBRLDateUnionオブジェクトと比較するオブジェクトを指定します。
戻り値:
XBRLDateUnionオブジェクトが,引数objで指定したオブジェクトと等しい場合はtrue,等しくない場合はfalseを返します。

(9) hashCode

public int hashCode()

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