6.6.28 XBRLUnit2インターフェース
public interface XBRLUnit2
extends XBRLInstanceNode
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素を表します。
- 単位要素のid属性の値は,単位要素を生成する際に自動的に採番されます。id属性の値は,単位要素を生成する際に自動的に採番されますが,setId(java.lang.String) を使用して任意の値を設定することもできます。自動採番の詳細については,「3.3 ID管理と採番」を参照してください。
- フィールドの概要:
- XBRLUnit2インターフェースのフィールドの概要を次の表に示します。
表6-61 XBRLUnit2インターフェースのフィールドの概要
項番 | 説明 |
---|
1 | static int | MULTIPLY 単位要素の内容は,一つ以上の基本単位によって構成されることを示します。 |
2 | static int | DIVIDE 単位要素の内容は,分数であることを示します。分数の分子と分母は,一つ以上の基本単位によって構成されます。 |
- メソッドの概要:
- XBRLUnit2インターフェースのメソッドの概要を次の表に示します。
表6-62 XBRLUnit2インターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | java.lang.String | getId() 単位要素のid属性の値を取得します。 | 2.1 |
2 | void | setId(java.lang.String id) 単位要素のid属性の値を設定します。 | 2.1 |
3 | int | getUnitType() 単位要素の内容を表すコードを取得します。 | 2.1 |
4 | java.util.List<XBRLQName> | getMeasures() 単位要素を構成する基本単位のリストを取得します。 | 2.1 |
5 | java.util.List<XBRLQName> | getNumerator() 単位要素の分子を構成する基本単位のリストを取得します。 | 2.1 |
6 | java.util.List<XBRLQName> | getDenominator() 単位要素の分母を構成する基本単位のリストを取得します。 | 2.1 |
7 | java.util.List<XBRLInstanceItem> | getItems() 単位要素を参照しているアイテムのリストを取得します。 | 2.1 |
8 | java.util.List<XBRLInstanceItem> | getItems(java.lang.String namespaceURI, java.lang.String name) 単位要素を参照している,指定した名前のアイテムのリストを取得します。 | 2.1 |
- <この項の構成>
- (1) getId
- (2) setId
- (3) getUnitType
- (4) getMeasures
- (5) getNumerator
- (6) getDenominator
- (7) getItems
- (8) getItems
(1) getId
public java.lang.String getId()
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素のid属性の値を取得します。
- 戻り値:
- この単位要素のid属性の値を返します。
(2) setId
public void setId(java.lang.String id)
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素のid属性の値を設定します。
- 引数:
- id - id属性の値を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数idにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数idに指定した値がxsd:NCName型でない場合にスローされます。[エラーコード:20108]
- この単位要素がインスタンス文書中に存在していて,かつ,引数idで指定されたのと同じ値を持つxsd:ID型属性がインスタンス文書中にすでに存在する場合にスローされます。[エラーコード:20028]
(3) getUnitType
public int getUnitType()
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素の内容を表すコードを取得します。
- 戻り値:
- この単位要素の内容を表すコードを返します。戻り値のコードは,XBRLUnit2インターフェースのフィールド値のどちらかです。
(4) getMeasures
public java.util.List<XBRLQName> getMeasures()
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素を構成する基本単位のリストを取得します。
- このメソッドは,この単位要素の内容がXBRLUnit2.MULTIPLYの場合に呼び出せます。それ以外の場合に呼び出した場合は,XBRLDOMRuntimeException例外がスローされます。この単位要素の内容は,getUnitType()メソッドを呼び出して調べることができます。
- このメソッドが返すリスト中でのXBRLQNameオブジェクトの順序は,基本単位を表す<xbrli:measure>要素のインスタンス文書中での出現順と同じです。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- この単位要素を構成する基本単位を表すXBRLQNameオブジェクトのリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- この単位要素の内容の意味がXBRLUnit2.MULTIPLYでない場合にスローされます。[エラーコード:20128]
(5) getNumerator
public java.util.List<XBRLQName> getNumerator()
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素の分子を構成する基本単位のリストを取得します。
- このメソッドは,この単位要素の内容がXBRLUnit2.DIVIDEの場合に呼び出せます。それ以外の場合に呼び出した場合は,XBRLDOMRuntimeException例外がスローされます。この単位要素の内容は,getUnitType()メソッドを呼び出して調べることができます。
- このメソッドが返すリスト中でのXBRLQNameオブジェクトの順序は,分子を構成する基本単位を表す<xbrli:measure>要素のインスタンス文書中での出現順と同じです。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- この単位要素の分子を構成する基本単位を表すXBRLQNameオブジェクトのリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- この単位要素の内容の意味がXBRLUnit2.DIVIDEでない場合にスローされます。[エラーコード:20128]
(6) getDenominator
public java.util.List<XBRLQName> getDenominator()
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素の分母を構成する基本単位のリストを取得します。
- このメソッドは,この単位要素の内容がXBRLUnit2.DIVIDEの場合に呼び出せます。それ以外の場合に呼び出した場合は,XBRLDOMRuntimeException例外がスローされます。この単位要素の内容は,getUnitType()メソッドを呼び出して調べることができます。
- このメソッドが返すリスト中でのXBRLQNameオブジェクトの順序は,分母を構成する基本単位を表す<xbrli:measure>要素のインスタンス文書中での出現順と同じです。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- この単位要素の分母を構成する基本単位を表すXBRLQNameオブジェクトのリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- この単位要素の内容の意味がXBRLUnit2.DIVIDEでない場合にスローされます。[エラーコード:20128]
(7) getItems
public java.util.List<XBRLInstanceItem> getItems()
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素を参照しているアイテムのリストを取得します。
- この単位要素を参照しているアイテムには,インスタンス文書に存在しないもの(XBRLInstanceNode.isActive()がfalseを返すノード)も含まれます。
- このメソッドが返すアイテムのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるアイテムに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- この単位要素を参照しているアイテムをすべて含むXBRLInstanceItemオブジェクトのリストを返します。この単位要素を参照しているアイテムが存在しない場合は,要素数が0のリストを返します。
(8) getItems
public java.util.List<XBRLInstanceItem> getItems(java.lang.String namespaceURI,
java.lang.String name)
- XBRLのバージョン:
- 2.1
- 説明:
- 単位要素を参照している,指定した名前のアイテムのリストを取得します。
- この単位要素を参照しているアイテムには,インスタンス文書に存在しないもの(XBRLInstanceNode.isActive()がfalseを返すノード)も含まれます。
- このメソッドが返すアイテムのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるアイテムに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 引数:
- namespaceURI - アイテムの名前空間URIを指定します。
- name - アイテムの名前を指定します。
- 戻り値:
- 引数namespaceURIで指定された名前空間URIに属し,引数nameで指定された名前を持つアイテムを表すXBRLInstanceItemオブジェクトのリストを返します。指定されたアイテムが存在しない場合は,要素数が0のリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]