6.8.2 XBRLLabelインターフェース
public interface XBRLLabel
extends XBRLTaxonomyNode
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 要素のラベルを表します。
- XBRL2.0の場合:
ラベルがラベルリンク外で定義されている場合は,そのURIだけを取得できます。一方,ラベルがラベルリンク内の<link:label>要素で定義されている場合は,xml:lang属性,xlink:role属性,xlink:title属性の各属性の値およびラベルの内容を参照できます。ラベルがラベルリンク外で定義されているかどうかは,isRemote()メソッドを呼び出して調べることができます。詳細については,XBRLLabelインターフェースの「6.8.2(1) isRemote」を参照してください。
- XBRL2.1の場合:
ラベルリンクの外で定義されているラベルの内容を参照できます。このため,ラベルがラベルリンクの外で定義されているかどうかに関係なく,isRemote()メソッドは常にfalseを返します。
- フィールドの概要:
- XBRLLabelインターフェースのフィールドの概要を次の表に示します。
表6-89 XBRLLabelインターフェースのフィールドの概要
項番 | 説明 |
---|
1 | static java.lang.String | STANDARD このラベルの役割はhttp://www.xbrl.org/linkprops/label/standardです。XBRL2.0の場合だけ使用できます。 |
2 | static java.lang.String | TOTAL このラベルの役割はhttp://www.xbrl.org/linkprops/label/totalです。XBRL2.0の場合だけ使用できます。 |
- メソッドの概要:
- XBRLLabelインターフェースのメソッドの概要を次の表に示します。
表6-90 XBRLLabelインターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | boolean | isRemote() ラベルがラベルリンクの外で定義されているかどうかを調べます。 | 2.0および2.1 |
2 | java.lang.String | getHref() ラベルがラベルリンクの外で定義されている場合に,そのラベルのURIを取得します。 | 2.0 |
3 | java.lang.String | getLang() ラベルの言語を取得します。 | 2.0および2.1 |
4 | java.lang.String | getRole() ラベルのロールを取得します。 | 2.0および2.1 |
5 | java.lang.String | getTitle() ラベルのタイトルを取得します。 | 2.0および2.1 |
6 | java.lang.String | getValue() ラベルの内容を表す文字列を取得します。 | 2.0および2.1 |
7 | org.w3c.dom.Node | getContainerNode() ラベルの内容を保持するノードを取得します。 | 2.0および2.1 |
- <この項の構成>
- (1) isRemote
- (2) getHref
- (3) getLang
- (4) getRole
- (5) getTitle
- (6) getValue
- (7) getContainerNode
(1) isRemote
public boolean isRemote()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- ラベルがラベルリンクの外で定義されているかどうかを調べます。
- XBRL2.0の場合:
ラベルがラベルリンク外で定義されている場合は,このメソッドはtrueを返します。この場合は,getHref()を呼び出して,ラベルリンク外で定義されるラベルのURIを取得できます。なお,このメソッドがtrueを返す場合は,getLang(),getRole(),getTitle(),getValue(),getContainerNode()の各メソッドを呼び出してはいけません。
ラベルがラベルリンク内の<link:label>要素で定義されている場合は,このメソッドはfalseを返します。この場合は,getLang(),getRole(),getTitle(),getValue(),getContainerNode()の各メソッドを呼び出して,ラベルの各種情報を取得できます。なお,このメソッドがfalseを返す場合は,getHref()を呼び出してはいけません。
- XBRL2.1の場合:
このメソッドは,ラベルがラベルリンクの外で定義されているかどうかに関係なく,常にfalseを返します。
- 戻り値:
- このラベルがラベルリンク外で定義されている場合はtrue,このラベルがラベルリンク内の<link:label>要素で定義されている場合はfalseを返します。
(2) getHref
public java.lang.String getHref()
- XBRLのバージョン:
- 2.0
- 説明:
- ラベルがラベルリンクの外で定義されている場合に,そのラベルのURIを取得します。
- このメソッドが返すURIは,ラベルリンクの外で定義されているラベルを指す,<link:loc>要素のxlink:href属性の値です。
- 戻り値:
- ラベルリンク外で定義されているラベルのURIを表すxlink:href属性の値を返します。
- 例外:
- XBRLDOMRuntimeException -
- このラベルがラベルリンク内の<link:label>要素で定義されている場合にスローされます。[エラーコード:20009]
(3) getLang
public java.lang.String getLang()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- ラベルの言語を取得します。
- XBRL2.0の場合は,ラベルがラベルリンク内で定義されている場合に,ラベルの言語を取得します。
- 戻り値:
- このラベルの言語を表すxml:lang属性の値を返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:このラベルがラベルリンク外で定義されている場合にスローされます。[エラーコード:20008]
(4) getRole
public java.lang.String getRole()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- ラベルのロールを取得します。
- XBRL2.0の場合は,ラベルがラベルリンク内で定義されている場合に,ラベルのロールを取得します。
- 戻り値:
- このラベルのロールを表すxlink:role属性の値を返します。このラベルがxlink:role属性の値を持たない場合はnullを返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:このラベルがラベルリンク外で定義されている場合にスローされます。[エラーコード:20008]
(5) getTitle
public java.lang.String getTitle()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- ラベルのタイトルを取得します。ラベルのタイトルは,label要素のxlink:title属性の値です。
- XBRL2.0の場合は,ラベルがラベルリンク内で定義されている場合に,ラベルのタイトルを取得します。
- 戻り値:
- このラベルのタイトルを表すxlink:title属性の値を返します。xlink:title属性の値がない場合はnullを返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:このラベルがラベルリンク外で定義されている場合にスローされます。[エラーコード:20008]
(6) getValue
public java.lang.String getValue()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- ラベルの内容を表す文字列を取得します。
- XBRL2.0の場合は,ラベルがラベルリンク内で定義されている場合に,ラベルの内容を表す文字列を取得します。
- ラベルの内容にXHTMLのタグが含まれている場合は,このメソッドはnullを返します。ラベルの内容に含まれるXHTMLのタグを参照したい場合は,getContainerNode()を使用します。
- 戻り値:
- このラベルの内容を表す文字列を返します。ラベルの内容にXHTMLのタグが含まれている場合はnullを返します。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:このラベルがラベルリンク外で定義されている場合にスローされます。[エラーコード:20008]
(7) getContainerNode
public org.w3c.dom.Node getContainerNode()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- ラベルの内容を保持するノードを取得します。
- XBRL2.0の場合は,ラベルがラベルリンク内で定義されている場合に,ラベルの内容を保持するノードを取得します。
- ラベルの内容にXHTMLのタグが含まれている場合は,それらをDOMツリー中のノードとして参照できます。
- このメソッドが返すノードに対して,更新を伴う操作を行ってはいけません。
- 例外:
- XBRLDOMRuntimeException -
- XBRL2.0の場合:このラベルがラベルリンク外で定義されている場合にスローされます。[エラーコード:20008]