6.8.6 XBRLReferenceインターフェース
public interface XBRLReference
extends XBRLTaxonomyNode
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 文献への参照を表します。
- XBRL2.0の場合:
文献への参照がリファレンスリンクの外で定義されている場合は,そのURIだけを取得できます。一方,文献への参照がリファレンスリンク内の<link:reference>要素で定義されている場合は,xlink:role属性,xlink:title属性の各属性の値および文献への参照に含まれるパートを参照できます。文献への参照がリファレンスリンクの外で定義されているかどうかは,isRemote()メソッドを呼び出して調べることができます。詳細については,XBRLReferenceインターフェースの「6.8.6(1) isRemote」を参照してください。
- XBRL2.1の場合:
リファレンスリンクの外で定義されている文献への参照の内容を参照できます。このため,文献への参照がリファレンスリンクの外で定義されているかどうかに関係なく,isRemote()メソッドは常にfalseを返します。
- メソッドの概要:
- XBRLReferenceインターフェースのメソッドの概要を次の表に示します。
表6-95 XBRLReferenceインターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | boolean | isRemote() 文献への参照がリファレンスリンクの外で定義されているかどうかを調べます。 | 2.0および2.1 |
2 | java.lang.String | getHref() 文献への参照がリファレンスリンクの外で定義されている場合に,その文献への参照のURIを取得します。 | 2.0 |
3 | java.lang.String | getRole() 文献への参照のロールを取得します。 | 2.0および2.1 |
4 | java.lang.String | getTitle() 文献への参照のタイトルを取得します。 | 2.0および2.1 |
5 | java.util.List<XBRLPart> | getParts() 文献への参照に含まれるパートのリストを取得します。 | 2.0および2.1 |
6 | java.util.List<XBRLPart> | getParts(java.lang.String namespaceURI, java.lang.String name) 文献への参照に含まれるパートのうち,指定した名前を持つパートのリストを取得します。 | 2.0および2.1 |
- <この項の構成>
- (1) isRemote
- (2) getHref
- (3) getRole
- (4) getTitle
- (5) getParts
- (6) getParts
(1) isRemote
public boolean isRemote()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 文献への参照がリファレンスリンクの外で定義されているかどうかを調べます。
- XBRL2.0の場合:
文献への参照がリファレンスリンクの外で定義されている場合は,このメソッドはtrueを返します。この場合は,getHref()を呼び出して,リファレンスリンクの外で定義される文献への参照のURIを取得できます。なお,このメソッドがtrueを返す場合は,getRole(),getTitle(),getParts(),getParts(java.lang.String, java.lang.String)の各メソッドを呼び出してはいけません。
文献への参照がリファレンスリンク内の<link:reference>要素で定義されている場合は,このメソッドはfalseを返します。この場合は,getRole(),getTitle(),getParts(),getParts(java.lang.String, java.lang.String)の各メソッドを呼び出して,文献への参照の各種情報を取得できます。なお,このメソッドがfalseを返す場合は,getHref()を呼び出してはいけません。
- XBRL2.1の場合:
このメソッドは,文献への参照がリファレンスリンクの外で定義されているかどうかに関係なく,常にfalseを返します。
- 戻り値:
- この文献への参照がリファレンスリンクの外で定義されている場合はtrue,この文献への参照がリファレンスリンク内の<link:reference>要素で定義されている場合はfalseを返します。
(2) getHref
public java.lang.String getHref()
- XBRLのバージョン:
- 2.0
- 説明:
- 文献への参照がリファレンスリンクの外で定義されている場合に,その文献への参照のURIを取得します。
- このメソッドが返すURIは,リファレンスリンクの外で定義されている文献への参照を指す,<link:loc>要素のxlink:href属性の値です。
- 戻り値:
- リファレンスリンクの外で定義されている文献への参照のURIを示すxlink:href属性の値を返します。
- 例外:
- XBRLDOMRuntimeException -
- この文献への参照がリファレンスリンク内の<link:reference>要素で定義されている場合にスローされます。[エラーコード:20011]
(3) getRole
public java.lang.String getRole()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 文献への参照のロールを取得します。
- XBRL2.0の場合は,文献への参照がリファレンスリンク内で定義されている場合に,文献への参照のロールを取得します。
- 戻り値:
- この文献への参照のロールを表すxlink:role属性の値を返します。この文献への参照がxlink:role属性の値を持たない場合はnullを返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:この文献への参照がリファレンスリンクの外で定義されている場合にスローされます。[エラーコード:20010]
(4) getTitle
public java.lang.String getTitle()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 文献への参照のタイトルを取得します。文献への参照のタイトルは,<link:reference>要素のxlink:title属性の値です。
- XBRL2.0の場合は,文献への参照がリファレンスリンク内で定義されている場合に,文献への参照のタイトルを取得します。
- 戻り値:
- この文献への参照のタイトルを表すxlink:title属性の値を返します。xlink:title属性の値がない場合はnullを返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:この文献への参照がリファレンスリンクの外で定義されている場合にスローされます。[エラーコード:20010]
(5) getParts
public java.util.List<XBRLPart> getParts()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 文献への参照に含まれるパートのリストを取得します。
- XBRL2.0の場合は,文献への参照がリファレンスリンク内で定義されている場合に,文献への参照に含まれるパートのリストを取得します。
- パートの順序は,タクソノミー文書での出現順と同じです。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- パートを表すXBRLPartオブジェクトのリストを返します。この文献への参照に含まれるパートがない場合は,要素数が0のリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:この文献への参照がリファレンスリンクの外で定義されている場合にスローされます。[エラーコード:20010]
(6) getParts
public java.util.List<XBRLPart> getParts(java.lang.String namespaceURI,
java.lang.String name)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 文献への参照に含まれるパートのうち,指定した名前を持つパートのリストを取得します。
- XBRL2.0の場合は,文献への参照がリファレンスリンク内で定義されている場合に,文献への参照に含まれるパートのうち,指定した名前を持つパートのリストを取得します。
- 同じ名前のパートが二つ以上存在することがあります。このため,このメソッドは,指定した名前のパートを,XBRLPartオブジェクトのリストとして返します。リストでのXBRLPartオブジェクトの順序は,タクソノミー文書での出現順と同じです。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
- 引数:
- namespaceURI - パートの名前空間URIを指定します。
- name - パートの名前を指定します。
- 戻り値:
- 引数namespaceURIで指定した名前空間URIに属し,引数nameで指定した名前を持つパートを表す,XBRLPartオブジェクトのリストを返します。指定したパートがない場合は,要素数が0のリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:この文献への参照がリファレンスリンクの外で定義されている場合にスローされます。[エラーコード:20010]
- 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]