6.6.13 XBRLInstanceItemインターフェース

public interface XBRLInstanceItem
extends XBRLInstanceElement

XBRLのバージョン:
2.0および2.1
説明:
アイテムを表します。
XBRLInstanceItemオブジェクトは,XBRLInstanceDocumentオブジェクトまたはXBRLInstanceTupleオブジェクトの子となることができます。
非アクティブなXBRLInstanceItemオブジェクトを,XBRLInstanceDocumentオブジェクトまたはアクティブなXBRLInstanceTupleオブジェクトの子として設定すると,子として設定されたXBRLInstanceItemオブジェクトは非アクティブな状態からアクティブな状態へと変化します。
また,XBRLInstanceItemオブジェクトが非アクティブなXBRLInstanceTupleオブジェクトの子である場合はそのXBRLInstanceItemオブジェクトも非アクティブです。しかし,親である非アクティブなXBRLInstanceTupleオブジェクトまたはその祖先に当たるXBRLInstanceTupleオブジェクトが,XBRLInstanceDocumentオブジェクトまたはアクティブなXBRLInstanceTupleオブジェクトの子として設定され,アクティブになった場合,その子または子孫であるXBRLInstanceItemオブジェクトも同時にアクティブな状態へと変化します。
このようにしてXBRLInstanceItemオブジェクトが非アクティブな状態からアクティブな状態へ変化する際に,XBRLInstanceItemオブジェクトが参照するXBRLContextオブジェクトが非アクティブである場合,そのXBRLContextオブジェクトはXBRLInstanceDocumentのaddContext(XBRLContext)によってインスタンス文書へ自動的に追加されます。このとき,インスタンス文書へ自動的に追加されるXBRLContextオブジェクトの識別子と同じ識別子を持つ別のXBRLContextオブジェクトがすでにインスタンス文書に存在する場合は,XBRLDOMRuntimeException例外がスローされます。
XBRL2.1の場合:XBRLInstanceItemオブジェクトが非アクティブな状態からアクティブな状態へ変化する際に,XBRLInstanceItemオブジェクトが参照するXBRLUnit2オブジェクトが非アクティブである場合,そのXBRLUnit2オブジェクトはXBRLInstanceDocument.addUnit(XBRLUnit2)によってインスタンス文書へ自動的に追加されます。このとき,インスタンス文書へ自動的に追加されるXBRLUnit2オブジェクトの識別子と同じ識別子を持つ別の要素がすでに存在する場合は,XBRLDOMRuntimeException例外がスローされます。
フィールドの概要:
XBRLInstanceItemインターフェースのフィールドの概要を次の表に示します。

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

項番説明
1static intMONETARY_ITEM
  このアイテムのデータ型はxbrli:monetaryです。
2static intSHARES_ITEM
  このアイテムのデータ型はxbrli:sharesです。
3static intPURE_ITEM
  このアイテムのデータ型はxbrli:pureです。
4static intFRACTION_ITEM
  このアイテムのデータ型は分数です。
5static intDECIMAL_ITEM
  このアイテムのデータ型はxsd:decimalです。
6static intFLOAT_ITEM
  このアイテムのデータ型はxsd:floatです。
7static intDOUBLE_ITEM
  このアイテムのデータ型はxsd:doubleです。
8static intINTEGER_ITEM
  このアイテムのデータ型はxsd:integerです。
9static intNONPOSITIVEINTEGER_ITEM
  このアイテムのデータ型はxsd:nonPositiveIntegerです。
10static intNEGATIVEINTEGER_ITEM
  このアイテムのデータ型はxsd:negativeIntegerです。
11static intLONG_ITEM
  このアイテムのデータ型はxsd:longです。
12static intINT_ITEM
  このアイテムのデータ型はxsd:intです。
13static intSHORT_ITEM
  このアイテムのデータ型はxsd:shortです。
14static intBYTE_ITEM
  このアイテムのデータ型はxsd:byteです。
15static intNONNEGATIVEINTEGER_ITEM
  このアイテムのデータ型はxsd:nonNegativeIntegerです。
16static intUNSIGNEDLONG_ITEM
  このアイテムのデータ型はxsd:unsignedLongです。
17static intUNSIGNEDINT_ITEM
  このアイテムのデータ型はxsd:unsignedIntです。
18static intUNSIGNEDSHORT_ITEM
  このアイテムのデータ型はxsd:unsignedShortです。
19static intUNSIGNEDBYTE_ITEM
  このアイテムのデータ型はxsd:unsignedByteです。
20static intPOSITIVEINTEGER_ITEM
  このアイテムのデータ型はxsd:positiveIntegerです。
21static intSTRING_ITEM
  このアイテムのデータ型はxsd:stringです。
22static intBOOLEAN_ITEM
  このアイテムのデータ型はxsd:booleanです。
23static intHEXBINARY_ITEM
  このアイテムのデータ型はxsd:hexBinaryです。
24static intBASE64BINARY_ITEM
  このアイテムのデータ型はxsd:base64Binaryです。
25static intANYURI_ITEM
  このアイテムのデータ型はxsd:anyURIです。
26static intQNAME_ITEM
  このアイテムのデータ型はxsd:QNameです。
27static intNOTATION_ITEM
  このアイテムのデータ型はxsd:NOTATIONです。
28static intDURATION_ITEM
  このアイテムのデータ型はxsd:durationです。
29static intDATETIME_ITEM
  このアイテムのデータ型はxbrli:dateUnionです。
30static intTIME_ITEM
  このアイテムのデータ型はxsd:timeです。
31static intDATE_ITEM
  このアイテムのデータ型はxsd:dateです。
32static intGYEARMONTH_ITEM
  このアイテムのデータ型はxsd:gYearMonthです。
33static intGYEAR_ITEM
  このアイテムのデータ型はxsd:gYearです。
34static intGMONTHDAY_ITEM
  このアイテムのデータ型はxsd:gMonthDayです。
35static intGDAY_ITEM
  このアイテムのデータ型はxsd:gDayです。
36static intGMONTH_ITEM
  このアイテムのデータ型はxsd:gMonthです。
37static intNORMALIZEDSTRING_ITEM
  このアイテムのデータ型はxsd:normalizedStringです。
38static intTOKEN_ITEM
  このアイテムのデータ型はxsd:tokenです。
39static intLANGUAGE_ITEM
  このアイテムのデータ型はxsd:languageです。
40static intNAME_ITEM
  このアイテムのデータ型はxsd:Nameです。
41static intNCNAME_ITEM
  このアイテムのデータ型はxsd:NCNameです。
42static intOTHER_ITEM
  このアイテムのデータ型は不明です。
メソッドの概要:
XBRLInstanceItemインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョンXBRL Dimensionsのバージョン
1XBRLTaxonomyItemgetTaxonomyItem()
  アイテムの要素宣言を取得します。
2.0および2.1該当しない
2intgetItemType()
  アイテムのデータ型を表すコードを取得します。
2.0および2.1該当しない
3intgetBaseItemType()
  アイテムのベースデータ型を表すコードを取得します。
2.1該当しない
4booleanisNumeric()
  アイテムが数値または非数値のどちらであるかを調べます。
2.0および2.1該当しない
5XBRLContextgetContext()
  アイテムが参照するコンテキスト要素を取得します。
2.0および2.1該当しない
6voidsetContext(XBRLContext context)
  アイテムが参照するコンテキスト要素を設定します。
2.0および2.1該当しない
7XBRLUnit2getUnit()
  アイテムが参照する単位要素を取得します。
2.1該当しない
8voidsetUnit(XBRLUnit2 unit)
  アイテムが参照する単位要素を設定します。
2.1該当しない
9XBRLPrecisiongetPrecision()
  アイテムのprecision属性値を取得します。
2.1該当しない
10voidsetPrecision(XBRLPrecision precision)
  アイテムのprecision属性値を設定します。
2.1該当しない
11XBRLDecimalsgetDecimals()
  アイテムのdecimals属性値を取得します。
2.1該当しない
12voidsetDecimals(XBRLDecimals decimals)
  アイテムのdecimals属性値を設定します。
2.1該当しない
13booleanhasValue()
  アイテムに値が設定されているかどうかを調べます。
2.0および2.1該当しない
14java.lang.ObjectgetValue()
  アイテムの値を取得します。
2.0および2.1該当しない
15voidsetValue(java.lang.Object value)
  アイテムの値を設定します。
2.0および2.1該当しない
16java.lang.StringgetString()
  アイテムの値の文字列表現を取得します。
2.0および2.1該当しない
17voidsetString(java.lang.String value)
  アイテムの値の文字列表現を設定します。
2.0および2.1該当しない
18XBRLDimensionalRelationshipSetgetDimensionalRelationshipSet()
  アイテムの要素宣言に関連づいているDRSを取得します。
2.11.0
19booleanvalidateDimensions()
  DRSに含まれているすべてのロールで,アイテムに対してXBRL Dimensionsの妥当性検証を実行します。
2.11.0
20booleanvalidateDimensions(java.lang.String role)
  DRSに含まれているロールのうち,引数roleに指定されたロールで,アイテムに対してXBRL Dimensionsの妥当性検証を実行します。
2.11.0
<この項の構成>
(1) getTaxonomyItem
(2) getItemType
(3) getBaseItemType
(4) isNumeric
(5) getContext
(6) setContext
(7) getUnit
(8) setUnit
(9) getPrecision
(10) setPrecision
(11) getDecimals
(12) setDecimals
(13) hasValue
(14) getValue
(15) setValue
(16) getString
(17) setString
(18) getDimensionalRelationshipSet
(19) validateDimensions
(20) validateDimensions

(1) getTaxonomyItem

public XBRLTaxonomyItem getTaxonomyItem()

XBRLのバージョン:
2.0および2.1
説明:
アイテムの要素宣言を取得します。
戻り値:
このアイテムの要素宣言を表すXBRLTaxonomyItemオブジェクトを返します。

(2) getItemType

public int getItemType()

XBRLのバージョン:
2.0および2.1
説明:
アイテムのデータ型を表すコードを取得します。
このメソッドが返す値は,XBRLのバージョンによって異なります。利用できるデータ型の詳細については,XBRLTaxonomyItemインターフェースの「6.8.17(1) getItemType」を参照してください。
戻り値:
このアイテムの型を表すコードを返します。

(3) getBaseItemType

public int getBaseItemType()

XBRLのバージョン:
2.1
説明:
アイテムのベースデータ型を表すコードを取得します。
ベースデータ型は,ユーザーデータ型の派生元となっているデータ型のことです。アイテムがユーザーデータ型である場合(getItemType()メソッドがOTHER_ITEMを返す場合)は,getBaseItemType()メソッドを呼び出すことによって,派生元となっているデータ型を調べることができます。派生元のデータ型が不明な場合は,getBaseItemType()メソッドはOTHER_ITEMを返します。
このアイテムがユーザーデータ型でない場合(getItemType()メソッドがOTHER_ITEM以外を返す場合)は,このメソッドはgetItemType()メソッドが返す値と同じ値を返します。
戻り値:
このアイテムのベースデータ型を表すコードを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(4) isNumeric

public boolean isNumeric()

XBRLのバージョン:
2.0および2.1
説明:
アイテムが数値または非数値のどちらであるかを調べます。
このアイテムが数値か非数値のどちらかは,このアイテムのデータ型によって異なります。アイテムのデータ型とisNumeric()メソッドの戻り値との対応関係については,XBRLTaxonomyItemインターフェースの「6.8.17(3) isNumeric」を参照してください。
戻り値:
このアイテムが数値である場合はtrue,非数値である場合はfalseを返します。

(5) getContext

public XBRLContext getContext()

XBRLのバージョン:
2.0および2.1
説明:
アイテムが参照するコンテキスト要素を取得します。
戻り値:
コンテキスト要素を表すXBRLContextオブジェクトを返します。
  • XBRL2.0の場合:このメソッドが返したオブジェクトは,XBRLNumericContextまたはXBRLNonNumericContextのどちらか一方にキャストできます。XBRLNumericContextとXBRLNonNumericContextのどちらにキャストできるかは,isNumeric()を呼び出すことで判定できます。
  • XBRL2.1の場合:このメソッドが返したオブジェクトは,XBRLContext2にキャストできます。

(6) setContext

public void setContext(XBRLContext context)

XBRLのバージョン:
2.0および2.1
説明:
アイテムが参照するコンテキスト要素を設定します。
このアイテムがアクティブで,かつ引数contextで指定したコンテキスト要素がインスタンス文書にない場合は,コンテキスト要素はインスタンス文書に自動的に追加されます。このとき,インスタンス文書へ自動的に追加されるコンテキスト要素のid属性と同じ値のid属性を持つ別のコンテキスト要素が,すでにインスタンス文書に存在する場合は,XBRLDOMRuntimeExceptionがスローされます。
引数:
context - このアイテムが参照するコンテキスト要素を指定します。
  • XBRL2.0の場合:この引数に指定するオブジェクトは,XBRLNumericContextかXBRLNonNumericContextのどちらかでなければなりません。XBRLNumericContextとXBRLNonNumericContextのどちらを指定する必要があるかは,このアイテムのデータ型に依存します。
  • XBRL2.1の場合:この引数に指定するオブジェクトは,XBRLContext2である必要があります。
例外:
XBRLDOMRuntimeException -
  • 引数contextにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数contextに指定したXBRLContextオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceItemオブジェクトを所有しているXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
  • XBRL2.0の場合:引数contextが表すコンテキスト要素が,このアイテムのデータ型に適合しない場合にスローされます。[エラーコード:20032]
  • XBRL2.1の場合:引数contextに指定したコンテキスト要素の時期要素の内容が,このアイテムの要素宣言でのxbrli:periodType属性の指定と矛盾している場合にスローされます。xbrli:periodType属性の値が"instant"の場合は,時期要素の内容はXBRLPeriod.INSTANTである必要があります。また,xbrli:periodType属性の値が"duration"の場合は,時期要素の内容はXBRLPeriod.FOREVERかXBRLPeriod.STARTDATE_ENDDATEである必要があります。[エラーコード:20140]

(7) getUnit

public XBRLUnit2 getUnit()

XBRLのバージョン:
2.1
説明:
アイテムが参照する単位要素を取得します。
単位要素を参照するのは数値アイテムだけであり,非数値アイテムは単位要素を参照しません。よって,数値アイテムに対してだけ,このメソッドを呼び出せます。非数値アイテムに対してこのメソッドを呼び出した場合は,XBRLDOMRuntimeExceptionがスローされます。アイテムが数値か非数値かについては,XBRLInstanceItem.isNumeric()メソッドで調べることができます。
戻り値:
単位要素を表すXBRLUnit2オブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • このアイテムが非数値の場合にスローされます。[エラーコード:20137]

(8) setUnit

public void setUnit(XBRLUnit2 unit)

XBRLのバージョン:
2.1
説明:
アイテムが参照する単位要素を設定します。
このアイテムがアクティブで,かつ,引数unitで指定された単位要素がインスタンス文書に存在しない場合は,単位要素はインスタンス文書に自動的に追加されます。このとき,インスタンス文書へ自動的に追加される単位要素のid属性と同じ値のid属性を持つ別の要素がすでにインスタンス文書に存在する場合は,XBRLDOMRuntimeException例外がスローされます。
単位要素を設定できるのは,数値アイテムに対してだけです。非数値アイテムに対してこのメソッドを呼び出した場合は,XBRLDOMRuntimeExceptionがスローされます。アイテムが数値か非数値かについては,XBRLInstanceItem.isNumeric()メソッドで調べることができます。
アイテムが参照する単位要素には,アイテムのベースデータ型によって次に示す制約があります。これらの制約に違反する単位要素を設定しようとした場合は,XBRLDOMRuntimeExceptionがスローされます。

表6-34 アイテムのベースデータ型による単位要素の制約

項番アイテムのベースデータ型単位要素の制約
1MONETARY_ITEM次の制約をすべて満たす必要があります。
  • 単位要素の内容は,一つの基本単位によって構成されなければなりません。つまり,XBRLUnit2.getUnitType()メソッドの戻り値がXBRLUnit2.MULTIPLYで,かつ,XBRLUnit2.getMeasures()メソッドが返すリストのサイズは1である必要があります。
  • 基本単位を表すXBRLQNameオブジェクトの名前空間URIは "http://www.xbrl.org/2003/iso4217"である必要があります。
  • 基本単位を表すXBRLQNameオブジェクトのローカルパートは,ISO 4217通貨コードである必要があります。なお,XBRL DOMでは,この項目はチェックしません。
2SHARES_ITEM次の制約をすべて満たす必要があります。
  • 単位要素の内容は,一つの基本単位によって構成されなければなりません。つまり,XBRLUnit2.getUnitType()メソッドの戻り値がXBRLUnit2.MULTIPLYで,かつ,XBRLUnit2.getMeasures()メソッドが返すリストのサイズは1である必要があります。
  • 基本単位を表すXBRLQNameオブジェクトの名前空間URIは "http://www.xbrl.org/2003/instance" である必要があります。
  • 基本単位を表すXBRLQNameオブジェクトのローカルパートは"shares"である必要があります。
3PURE_ITEM次の制約をすべて満たす必要があります。
  • 単位要素の内容は,一つの基本単位によって構成されなければなりません。つまり,XBRLUnit2.getUnitType()メソッドの戻り値がXBRLUnit2.MULTIPLYで,かつ,XBRLUnit2.getMeasures()メソッドが返すリストのサイズは1である必要があります。
  • 基本単位を表すXBRLQNameオブジェクトの名前空間URIは "http://www.xbrl.org/2003/instance" である必要があります。
  • 基本単位を表すXBRLQNameオブジェクトのローカルパートは"pure"である必要があります。
このアイテムのベースデータ型が上記の表に記載されているもの以外である場合は,このアイテムに設定する単位要素についての制約はありません。
引数:
unit - このアイテムが参照する単位要素を指定します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • このアイテムが非数値の場合にスローされます。[エラーコード:20137]
  • 引数unitにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数unitに指定されたXBRLUnit2オブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLInstanceItemオブジェクトを所有しているXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
  • 引数unitに指定されたXBRLUnit2オブジェクトが,上記の表の制約に違反している場合にスローされます。[エラーコード:20127]

(9) getPrecision

public XBRLPrecision getPrecision()

XBRLのバージョン:
2.1
説明:
アイテムのprecision属性値を取得します。
このメソッドは,アイテムが数値で,かつ,アイテムのベースデータ型がFRACTION_ITEM以外である場合に呼び出せます。このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にこのメソッドを呼び出すと,XBRLDOMRuntimeExceptionがスローされます。
戻り値:
このアイテムのprecision属性の値を返します。precision属性がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にスローされます。[エラーコード:20136]

(10) setPrecision

public void setPrecision(XBRLPrecision precision)

XBRLのバージョン:
2.1
説明:
アイテムのprecision属性値を設定します。
precision属性とdecimals属性はどちらか一方だけを設定できます。decimals属性が設定されているアイテムに対してこのメソッドを呼び出した場合は,decimals属性は自動的に削除されます。
このメソッドは,アイテムが数値で,かつ,アイテムのベースデータ型がFRACTION_ITEM以外である場合に呼び出せます。このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にこのメソッドを呼び出すと,XBRLDOMRuntimeExceptionがスローされます。
このアイテムのxsi:nil属性に "true" が指定されている場合は,precision属性を設定できません。xsi:nil属性に "true" が指定されている場合にこのメソッドを呼び出すと,XBRLDOMRuntimeExceptionがスローされます。
引数:
precision - このアイテムのprecision属性に設定する値を指定します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にスローされます。[エラーコード:20136]
  • このアイテムのxsi:nil属性に "true" が指定されている場合にスローされます。[エラーコード:20130]
  • 引数precisionにnullを指定した場合にスローされます。[エラーコード:20002]

(11) getDecimals

public XBRLDecimals getDecimals()

XBRLのバージョン:
2.1
説明:
アイテムのdecimals属性値を取得します。
このメソッドは,アイテムが数値で,かつ,アイテムのベースデータ型がFRACTION_ITEM以外である場合に呼び出せます。このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にこのメソッドを呼び出すと,XBRLDOMRuntimeExceptionがスローされます。
戻り値:
このアイテムのdecimals属性の値を返します。decimals属性がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にスローされます。[エラーコード:20136]

(12) setDecimals

public void setDecimals(XBRLDecimals decimals)

XBRLのバージョン:
2.1
説明:
アイテムのdecimals属性値を設定します。
precision属性とdecimals属性はどちらか一方だけを設定できます。precision属性が設定されているアイテムに対してこのメソッドを呼び出した場合は,precision属性は自動的に削除されます。
このメソッドは,アイテムが数値で,かつ,アイテムのベースデータ型がFRACTION_ITEM以外である場合に呼び出せます。このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にこのメソッドを呼び出すと,XBRLDOMRuntimeExceptionがスローされます。
このアイテムのxsi:nil属性に"true"が指定されている場合は,decimals属性を設定できません。xsi:nil属性に"true"が指定されている場合にこのメソッドを呼び出すと,XBRLDOMRuntimeExceptionがスローされます。
引数:
decimals - このアイテムのdecimals属性に設定する値を指定します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • このアイテムが非数値か,または,ベースデータ型がFRACTION_ITEMである場合にスローされます。[エラーコード:20136]
  • このアイテムのxsi:nil属性に "true" が指定されている場合にスローされます。[エラーコード:20130]
  • 引数decimalsにnullを指定した場合にスローされます。[エラーコード:20002]

(13) hasValue

public boolean hasValue()

XBRLのバージョン:
2.0および2.1
説明:
アイテムに値が設定されているかどうかを調べます。
XBRLInstanceDocumentのcreateItem()で生成された直後のXBRLInstanceItemオブジェクトには値は設定されていません。つまり,hasValue()はfalseを返します。
戻り値:
このアイテムに値が設定されている場合はtrue,設定されていない場合はfalseを返します。

(14) getValue

public java.lang.Object getValue()

XBRLのバージョン:
2.0および2.1
説明:
アイテムの値を取得します。
このメソッドが返すオブジェクトは,アイテムのデータ型によって異なります。このアイテムに値が設定されていない場合,このメソッドはXBRLDOMRuntimeExceptionをスローします。
getValue()メソッドが返すオブジェクトを次の表に示します。

表6-35 getValue()メソッドが返すオブジェクト

項番アイテムのデータ型getValue()メソッドが返すオブジェクト
1MONETARY_ITEMjava.math.BigDecimal
2SHARES_ITEMjava.math.BigDecimal
3PURE_ITEMjava.math.BigDecimal
4FRACTION_ITEMXBRLFraction
5DECIMAL_ITEMjava.math.BigDecimal
6FLOAT_ITEMjava.lang.Float
7DOUBLE_ITEMjava.lang.Double
8INTEGER_ITEMjava.math.BigInteger
9NONPOSITIVEINTEGER_ITEMjava.math.BigInteger
10NEGATIVEINTEGER_ITEMjava.math.BigInteger
11LONG_ITEMjava.lang.Long
12INT_ITEMjava.lang.Integer
13SHORT_ITEMjava.lang.Short
14BYTE_ITEMjava.lang.Byte
15NONNEGATIVEINTEGER_ITEMjava.math.BigInteger
16UNSIGNEDLONG_ITEMjava.math.BigInteger
17UNSIGNEDINT_ITEMjava.math.BigInteger
18UNSIGNEDSHORT_ITEMjava.math.BigInteger
19UNSIGNEDBYTE_ITEMjava.math.BigInteger
20POSITIVEINTEGER_ITEMjava.math.BigInteger
21STRING_ITEMjava.lang.String
22BOOLEAN_ITEMjava.lang.Boolean
23HEXBINARY_ITEMXBRLHexBinary
24BASE64BINARY_ITEMXBRLBase64Binary
25ANYURI_ITEMjava.lang.String
26QNAME_ITEMXBRLQName
27NOTATION_ITEMXBRLQName
28DURATION_ITEMXBRLDuration
29DATETIME_ITEMXBRLDateUnion
30TIME_ITEMXBRLTime
31DATE_ITEMXBRLDate
32GYEARMONTH_ITEMXBRLGYearMonth
33GYEAR_ITEMXBRLGYear
34GMONTHDAY_ITEMXBRLGMonthDay
35GDAY_ITEMXBRLGDay
36GMONTH_ITEMXBRLGMonth
37NORMALIZEDSTRING_ITEMjava.lang.String
38TOKEN_ITEMjava.lang.String
39LANGUAGE_ITEMjava.lang.String
40NAME_ITEMjava.lang.String
41NCNAME_ITEMjava.lang.String
42OTHER_ITEMjava.lang.String
XBRL2.1の場合:このアイテムがユーザーデータ型(OTHER_ITEM)で,かつ,ベースデータ型がFRACTION_ITEMである場合,このメソッドは,XBRLFraction.toString()メソッドが返す文字列と同じ形式の文字列を表すjava.lang.Stringオブジェクトを返します。ユーザーデータ型で,かつ,ベースデータ型がFRACTION_ITEMであるアイテムの値を表すXBRLFractionオブジェクトを使用したい場合は,このメソッドが返した文字列をそのままXBRLFractionクラスのコンストラクタに渡します。
戻り値:
アイテムの値を返します。
例外:
XBRLDOMRuntimeException -
  • このアイテムに値が設定されていない場合にスローされます。[エラーコード:20026]

(15) setValue

public void setValue(java.lang.Object value)

XBRLのバージョン:
2.0および2.1
説明:
アイテムの値を設定します。
このメソッドの引数に指定できるオブジェクトは,アイテムのデータ型によって異なります。setValue()メソッドの引数に指定できるオブジェクトを次の表に示します。

表6-36 setValue()メソッドの引数に指定できるオブジェクト

項番アイテムのデータ型setValue()メソッドの引数に指定できるオブジェクト
1MONETARY_ITEMjava.math.BigDecimal
2SHARES_ITEMjava.math.BigDecimal
3PURE_ITEMjava.math.BigDecimal
4FRACTION_ITEMXBRLFraction
5DECIMAL_ITEMjava.math.BigDecimal
6FLOAT_ITEMjava.lang.Float
7DOUBLE_ITEMjava.lang.Double
8INTEGER_ITEMjava.math.BigInteger
9NONPOSITIVEINTEGER_ITEMjava.math.BigInteger
10NEGATIVEINTEGER_ITEMjava.math.BigInteger
11LONG_ITEMjava.lang.Long
12INT_ITEMjava.lang.Integer
13SHORT_ITEMjava.lang.Short
14BYTE_ITEMjava.lang.Byte
15NONNEGATIVEINTEGER_ITEMjava.math.BigInteger
16UNSIGNEDLONG_ITEMjava.math.BigInteger
17UNSIGNEDINT_ITEMjava.math.BigInteger
18UNSIGNEDSHORT_ITEMjava.math.BigInteger
19UNSIGNEDBYTE_ITEMjava.math.BigInteger
20POSITIVEINTEGER_ITEMjava.math.BigInteger
21STRING_ITEMjava.lang.String
22BOOLEAN_ITEMjava.lang.Boolean
23HEXBINARY_ITEMXBRLHexBinary
24BASE64BINARY_ITEMXBRLBase64Binary
25ANYURI_ITEMjava.lang.String
26QNAME_ITEMXBRLQName
27NOTATION_ITEMXBRLQName
28DURATION_ITEMXBRLDuration
29DATETIME_ITEMXBRLDateUnion
30TIME_ITEMXBRLTime
31DATE_ITEMXBRLDate
32GYEARMONTH_ITEMXBRLGYearMonth
33GYEAR_ITEMXBRLGYear
34GMONTHDAY_ITEMXBRLGMonthDay
35GDAY_ITEMXBRLGDay
36GMONTH_ITEMXBRLGMonth
37NORMALIZEDSTRING_ITEMjava.lang.String
38TOKEN_ITEMjava.lang.String
39LANGUAGE_ITEMjava.lang.String
40NAME_ITEMjava.lang.String
41NCNAME_ITEMjava.lang.String
42OTHER_ITEMjava.lang.String
インスタンス文書には,このアイテムの値として,引数valueに指定したオブジェクトのtoString()が返す文字列が設定されます。ただし,このアイテムがxsd:QName型またはxsd:NOTATION型の場合は,toString()が返す文字列「{namespaceURI}localPart」ではなく,「prefix:localPart」という形式の文字列が設定されます。
「prefix」の部分に該当する名前空間接頭辞は,XBRLInstanceDocumentオブジェクトに登録されている名前空間宣言から取得されます。名前空間宣言は,XBRLInstanceDocumentのaddNamespaceDeclaration()を使用してあらかじめ登録しておきます。引数valueに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が登録されていない場合は,例外がスローされます。
このアイテムの値としてインスタンス文書に設定される文字列表現を厳密に指定したい場合は,このメソッドの代わりにsetString()を使用します。
XBRL2.1の場合:このアイテムがユーザーデータ型(OTHER_ITEM)で,かつ,ベースデータ型がFRACTION_ITEMである場合,このメソッドに指定する文字列の形式はXBRLFractionクラスのコンストラクタへ指定する文字列と同じ形式である必要があります。XBRLFractionクラスのコンストラクタへ指定できない文字列をこのメソッドに指定した場合は,XBRLDOMRuntimeExceptionがスローされます。ユーザーデータ型で,かつ,ベースデータ型がFRACTION_ITEMであるアイテムに対して,XBRLFractionオブジェクトから値を設定したい場合は,XBRLFraction.toString()メソッドが返す文字列をそのままsetValue()メソッドの引数に指定します。
XBRL2.1の場合:xsi:nil属性に"true"が指定されている場合は,アイテムの値は設定できないため,このメソッドを呼び出してはいけません。xsi:nil属性に"true"が指定されているアイテムに対してこのメソッドを呼び出した場合は,XBRLDOMRuntimeExceptionがスローされます。
引数:
value - アイテムの値を指定します。
例外:
XBRLDOMRuntimeException -
  • XBRL2.1の場合:このアイテムのxsi:nil属性に"true"が指定されている場合にスローされます。[エラーコード:20130]
  • 引数valueにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数valueの型が,このアイテムのデータ型に合わない場合にスローされます。[エラーコード:20033]
  • このアイテムがxsd:QName型またはxsd:NOTATION型で,かつ,引数valueに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が,XBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
  • このアイテムがxsd:QName型またはxsd:NOTATION型で,かつ引数valueに指定したXBRLQNameオブジェクトが名前空間に属さず,かつXBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]
  • XBRL2.1の場合:このアイテムがユーザーデータ型(OTHER_ITEM)で,かつ,ベースデータ型がFRACTION_ITEMである場合に,XBRLFractionクラスのコンストラクタへ指定できない文字列を引数valueに指定した場合にスローされます。[エラーコード:20138]
  • XBRL2.1の場合:このアイテムのデータ型が次のどれかで,かつ,引数valueに指定された整数値がこのアイテムのデータ型の範囲外である場合にスローされます。[エラーコード:20014]
    ・NONPOSITIVEINTEGER_ITEM
    ・NEGATIVEINTEGER_ITEM
    ・NONNEGATIVEINTEGER_ITEM
    ・UNSIGNEDLONG_ITEM
    ・UNSIGNEDINT_ITEM
    ・UNSIGNEDSHORT_ITEM
    ・UNSIGNEDBYTE_ITEM
    ・POSITIVEINTEGER_ITEM
  • このアイテムのデータ型がANYURI_ITEMで,かつ,引数valueに指定された値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
  • このアイテムのデータ型がQNAME_ITEMまたはNOTATION_ITEMで,かつ,引数valueに指定されたXBRLQNameオブジェクトのローカルパートがxsd:NCName型でない場合にスローされます。[エラーコード:20108]
  • XBRL2.1の場合:このアイテムのデータ型がNAME_ITEMで,かつ,引数valueに指定された値がxsd:Name型でない場合にスローされます。[エラーコード:20108]
  • XBRL2.1の場合:このアイテムのデータ型がNCNAME_ITEMで,かつ,引数valueに指定された値がxsd:NCName型でない場合にスローされます。[エラーコード:20108]

(16) getString

public java.lang.String getString()

XBRLのバージョン:
2.0および2.1
説明:
アイテムの値の文字列表現を取得します。
このメソッドが返す文字列は,インスタンス文書にこのアイテムの値として記述されている文字列です。このメソッドが返す文字列は,getValue().toString()が返す文字列と異なる場合があります。例えば,このアイテムがxsd:QName型またはxsd:NOTATION型である場合,getString()は「prefix:localPart」という形式の文字列を返しますが,getValue().toString() は「{namespaceURI}localPart」という形式の文字列を返します。また,このアイテムが xsd:float型で,かつインスタンス文書にこのアイテムの値として「1.0e2」と記述されていた場合,getString()は「1.0e2」という文字列を返しますが,getValue().toString() は「100.0」という文字列を返します。
このアイテムに値が設定されていない場合,このメソッドはXBRLDOMRuntimeExceptionをスローします。
XBRL2.1の場合:アイテムのベースデータ型がFRACTION_ITEMである場合,インスタンス文書に記述される値は文字列ではないため,このメソッドで文字列表現を取得できません。ベースデータ型がFRACTION_ITEMであるアイテムに対してこのメソッドを呼び出した場合は,XBRLDOMRuntimeExceptionがスローされます。
戻り値:
このアイテムの値の文字列表現を返します。
アイテムの型がxsd:QNameまたはxsd:NOTATIONの場合,名前空間を正規化すると,正規化の前後でQNameの接頭辞が異なります。正規化前は,既存の文書で指定された接頭辞を返します。正規化後は,正規化によって変更された接頭辞を返します。
例外:
XBRLDOMRuntimeException -
  • このアイテムに値が設定されていない場合にスローされます。[エラーコード:20026]
  • XBRL2.1の場合:このアイテムのベースデータ型がFRACTION_ITEMである場合にスローされます。[エラーコード:20139]
  • このアイテムの内容に子要素が含まれている場合にスローされます。[エラーコード:20061]

(17) setString

public void setString(java.lang.String value)

XBRLのバージョン:
2.0および2.1
説明:
アイテムの値の文字列表現を設定します。
setValue()では,引数に指定したオブジェクトのtoString()の戻り値が,このアイテムの値としてインスタンス文書に書き込まれます。一方,setString()では,引数valueに指定した文字列がそのまま,このアイテムの値としてインスタンス文書に書き込まれます。このアイテムの値としてインスタンス文書に書き込まれる文字列表現を厳密に指定したい場合は,setValue()ではなくsetString()を使用します。
  • XBRL2.1の場合:
    アイテムのベースデータ型がFRACTION_ITEMである場合,インスタンス文書に記述される値は文字列ではないため,このメソッドで文字列表現を設定できません。ベースデータ型がFRACTION_ITEMであるアイテムに対してこのメソッドを呼び出した場合は,XBRLDOMRuntimeExceptionがスローされます。
  • XBRL2.1の場合:
    xsi:nil属性に "true" が指定されている場合は,アイテムの値は設定できないため,このメソッドを呼び出さないでください。xsi:nil属性に "true" が指定されているアイテムに対してこのメソッドを呼び出した場合は,XBRLDOMRuntimeExceptionがスローされます。
引数:
value - このアイテムの値の文字列表現を指定します。
例外:
XBRLDOMRuntimeException -
  • XBRL2.1の場合:このアイテムのベースデータ型がFRACTION_ITEMである場合にスローされます。[エラーコード:20139]
  • XBRL2.1の場合:このアイテムのxsi:nil属性に "true" が指定されている場合にスローされます。[エラーコード:20130]
  • 引数valueにnullを指定した場合にスローされます。[エラーコード:20002]
  • このアイテムがxsd:QName型またはxsd:NOTATION型で,かつ引数valueに指定したQNameの名前空間接頭辞に対応する名前空間宣言が,XBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20022]
  • 引数valueに指定された文字列表現が不正な場合にスローされます。[エラーコード:20029]

(18) getDimensionalRelationshipSet

public XBRLDimensionalRelationshipSet getDimensionalRelationshipSet()

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
アイテムの要素宣言に関連づいているDRSを取得します。
戻り値:
このアイテムの要素宣言に関連づいているDRSを返します。アイテムの要素宣言に関連づいているDRSがない場合は,nullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]

(19) validateDimensions

public boolean validateDimensions()
                           throws XBRLDOMException

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
アイテムに対して,DRSに含まれているすべてのロールでXBRL Dimensionsの妥当性検証を実行します。
戻り値:
このアイテムに対して,DRSに含まれているすべてのロールでXBRL Dimensionsの妥当性検証を実行し,妥当である場合はtrue,妥当でない場合はfalseを返します。また,このアイテムにDRSがない場合はXBRL Dimensionsの妥当性検証を実行しないで,trueを返します。
例外:
XBRLDOMException -
  • XBRL Dimensionsの妥当性検証でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]

(20) validateDimensions

public boolean validateDimensions(java.lang.String role)
 throws XBRLDOMException

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
アイテムに対して,DRSに含まれているロールのうち,引数roleに指定されたロールでXBRL Dimensionsの妥当性検証を実行します。
引数:
role - XBRL Dimensionsの妥当性検証を実行するロールを指定します。
戻り値:
このアイテムに対して,DRSに含まれているロールのうち,引数roleに指定されたロールでXBRL Dimensionsの妥当性検証を実行し,妥当である場合はtrue,妥当でない場合はfalseを返します。また,このアイテムにDRSがない場合はXBRL Dimensionsの妥当性検証を実行しないでtrueを返します。
例外:
XBRLDOMException -
  • XBRL Dimensionsの妥当性検証でエラーが検出された場合にスローされます。[エラーコード:エラー要因によって異なる
    注※ エラー要因については,「7. メッセージ」の各メッセージの中で,このエラーコードをメッセージ番号とするメッセージIDを参照してください。
XBRLDOMRuntimeException -
  • 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
  • 引数roleにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数roleに空のURI参照を指定した場合にスローされます。[エラーコード:20110]
  • 引数roleにDRSに存在しないロールを指定した場合にスローされます。[エラーコード:22102]