6.8.18 XBRLTaxonomyNodeインターフェース

public interface XBRLTaxonomyNode

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書を構成するノードを表します。
フィールドの概要:
XBRLTaxonomyNodeインターフェースのフィールドの概要を次の表に示します。

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

項番説明
1static intTAXONOMY_DOCUMENT_NODE
  このノードは,タクソノミー文書を表します。
2static intTAXONOMY_BODY_NODE
  このノードは,タクソノミー本体を表します。
3static intLINKBASE_NODE
  このノードは,リンクベースを表します。
4static intITEM_NODE
  このノードは,アイテムの要素宣言を表します。
5static intTUPLE_NODE
  このノードは,タプルの要素宣言を表します。
6static intOTHER_ELEMENT_NODE
  このノードは,アイテムまたはタプル以外の要素の要素宣言を表します。
7static intROLE_TYPE_NODE
  このノードは,<link:roleType>要素を表します。
8static intARCROLE_TYPE_NODE
  このノードは,<link:arcroleType>要素を表します。
9static intLABEL_NODE
 このノードは,要素のラベルを表します。
10static intREFERENCE_NODE
  このノードは,文献への参照を表します。
11static intPART_NODE
  このノードは,文献への参照に含まれるパートを表します。
12static intLINKBASE_REF_NODE
  このノードは,<link:linkbaseRef>要素を表します。
13static intROLE_REF_NODE
  このノードは,<link:roleRef>要素を表します。
14static intTAXONOMY_ATTRIBUTE_DECLARATION_NODE
  このノードは,型定義の属性宣言を表します。
15static intTAXONOMY_COMPLEX_TYPE_DEFINITION_NODE
  このノードは,complexTypeの型定義を表します。
16static intTAXONOMY_SIMPLE_TYPE_DEFINITION_NODE
  このノードは,simpleTypeの型定義を表します。
17static intHYPERCUBE_ITEM_NODE
  このノードは,ハイパーキューブの要素宣言を表します。
18static intDIMENSION_ITEM_NODE
  このノードは,ディメンジョンの要素宣言を表します。
メソッドの概要:
XBRLTaxonomyNodeインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1intgetNodeType()
  ノードの型を表すコードを取得します。
2.0および2.1
2XBRLTaxonomyDocumentgetOwnerTaxonomyDocument()
  ノードを所有するXBRLTaxonomyDocumentオブジェクトを取得します。
2.0および2.1
3XBRLTaxonomyNodegetParentNode()
  ノードが関連づけられている親ノードを取得します。
2.0および2.1
4org.w3c.dom.NodegetW3CDOMNode()
  ノードに対応するorg.w3c.dom.Nodeオブジェクトを取得します。
2.0および2.1
<この項の構成>
(1) getNodeType
(2) getOwnerTaxonomyDocument
(3) getParentNode
(4) getW3CDOMNode

(1) getNodeType

public int getNodeType()

XBRLのバージョン:
2.0および2.1
説明:
ノードの型を表すコードを取得します。
このメソッドが返す値は,XBRLのバージョンによって異なります。利用できるノードの型とXBRLのバージョンの関係を次の表に示します。

表6-115 利用できるノードの型とXBRLのバージョンの関係

項番ノードの型XBRL2.0XBRL2.1
1TAXONOMY_DOCUMENT_NODE
2TAXONOMY_BODY_NODE
3LINKBASE_NODE
4ITEM_NODE
5TUPLE_NODE
6OTHER_ELEMENT_NODE
7ROLE_TYPE_NODE×
8ARCROLE_TYPE_NODE×
9LABEL_NODE
10REFERENCE_NODE
11PART_NODE
12LINKBASE_REF_NODE×
13ROLE_REF_NODE×
14TAXONOMY_ATTRIBUTE_DECLARATION_NODE×
15TAXONOMY_COMPLEX_TYPE_DEFINITION_NODE×
16TAXONOMY_SIMPLE_TYPE_DEFINITION_NODE×
17HYPERCUBE_ITEM_NODE×
18DIMENSION_ITEM_NODE×

(凡例)○:利用できます。 ×:利用できません。

注※ XBRL Dimensions1.0の場合だけ存在します。


戻り値:
このノードの型を表すコードを返します。

(2) getOwnerTaxonomyDocument

public XBRLTaxonomyDocument getOwnerTaxonomyDocument()

XBRLのバージョン:
2.0および2.1
説明:
ノードを所有するXBRLTaxonomyDocumentオブジェクトを取得します。
戻り値:
このノードを所有するXBRLTaxonomyDocumentオブジェクトを返します。このノードがXBRLTaxonomyDocumentの場合は,常にnullを返します。

(3) getParentNode

public XBRLTaxonomyNode getParentNode()

XBRLのバージョン:
2.0および2.1
説明:
ノードが関連づけられている親ノードを取得します。このメソッドが返す親ノードの型は,このノードの型によって異なります。getParentNodeメソッドが返す親ノードの型を次の表に示します。

表6-116 getParentNodeメソッドが返す親ノードの型

項番このノードの型このメソッドが返す親ノードの型
1TAXONOMY_DOCUMENT_NODEこのメソッドは常にnullを返します。
2TAXONOMY_BODY_NODETAXONOMY_DOCUMENT_NODE
3LINKBASE_NODETAXONOMY_DOCUMENT_NODE
4ITEM_NODETAXONOMY_BODY_NODE
5TUPLE_NODETAXONOMY_BODY_NODE
6OTHER_ELEMENT_NODETAXONOMY_BODY_NODE
7ROLE_TYPE_NODETAXONOMY_BODY_NODE
8ARCROLE_TYPE_NODETAXONOMY_BODY_NODE
9LABEL_NODETAXONOMY_BODY_NODEまたはLINKBASE_NODE
10REFERENCE_NODETAXONOMY_BODY_NODEまたはLINKBASE_NODE
11PART_NODEREFERENCE_NODE
12LINKBASE_REF_NODETAXONOMY_BODY_NODE
13ROLE_REF_NODELINKBASE_NODE
14TAXONOMY_ATTRIBUTE_DECLARATION_NODETAXONOMY_COMPLEX_TYPE_DEFINITION_NODE
15TAXONOMY_COMPLEX_TYPE_DEFINITION_NODETAXONOMY_BODY_NODEまたはITEM_NODEまたはTUPLE_NODEまたはOTHER_ELEMENT_NODE
16TAXONOMY_SIMPLE_TYPE_DEFINITION_NODETAXONOMY_BODY_NODEまたはITEM_NODEまたはTUPLE_NODEまたはOTHER_ELEMENT_NODE
17HYPERCUBE_ITEM_NODETAXONOMY_BODY_NODE
18DIMENSION_ITEM_NODETAXONOMY_BODY_NODE

注※ XBRL Dimensions1.0の場合だけ存在します。


戻り値:
このノードの親ノードを返します。関連づけられた親ノードがない場合はnullを返します。このノードがXBRLTaxonomyDocumentの場合は,常にnullを返します。

(4) getW3CDOMNode

public org.w3c.dom.Node getW3CDOMNode()

XBRLのバージョン:
2.0および2.1
説明:
ノードに対応するorg.w3c.dom.Nodeオブジェクトを取得します。XBRLの仕様で規定されていない属性や要素を参照したい場合は,このメソッドで取得したDOMツリーを使用できます。
このメソッドが返すorg.w3c.dom.Nodeオブジェクトの型は,このノードの型によって異なります。getW3CDOMNode()メソッドが返すorg.w3c.dom.Nodeオブジェクトを,次の表に示します。

表6-117 getW3CDOMNode()メソッドが返すorg.w3c.dom.Nodeオブジェクト

項番XBRLTaxonomyNodeオブジェクトの型org.w3c.dom.Nodeオブジェクトの型説明
1TAXONOMY_DOCUMENT_NODEnull常にnullを返します。
2TAXONOMY_BODY_NODEorg.w3c.dom.Documentタクソノミー本体を表します。
3LINKBASE_NODEorg.w3c.dom.Documentリンクベースを表します。
4ITEM_NODEorg.w3c.dom.Elementアイテムを定義している<xsd:element>要素を表します。
5TUPLE_NODEorg.w3c.dom.Elementタプルを定義している<xsd:element>要素を表します。
6OTHER_ELEMENT_NODEorg.w3c.dom.Elementアイテムまたはタプル以外の要素を定義している<xsd:element>要素を表します。
7ROLE_TYPE_NODEorg.w3c.dom.Element<link:roleType>要素を表します。
8ARCROLE_TYPE_NODEorg.w3c.dom.Element<link:arcroleType>要素を表します。
9LABEL_NODEorg.w3c.dom.ElementXBRLLabel.isRemote()がtrueの場合は<link:loc>要素,falseの場合は<link:label>要素を表します。
10REFERENCE_NODEorg.w3c.dom.ElementXBRLReference.isRemote()がtrueの場合は<link:loc>要素,falseの場合は<link:reference>要素を表します。
11PART_NODEorg.w3c.dom.Element<link:part>要素の代替要素を表します。
12LINKBASE_REF_NODEorg.w3c.dom.Element<link:linkbaseRef>要素を表します。
13ROLE_REF_NODEorg.w3c.dom.Element<link:roleRef>要素を表します。
14TAXONOMY_ATTRIBUTE_DECLARATION_NODEorg.w3c.dom.Element<xsd:attribute>要素を表します。
15TAXONOMY_COMPLEX_TYPE_DEFINITION_NODEorg.w3c.dom.Element<xsd:complexType>要素を表します。
16TAXONOMY_SIMPLE_TYPE_DEFINITION_NODEorg.w3c.dom.Element<xsd:simpleType>要素を表します。
17HYPERCUBE_ITEM_NODEorg.w3c.dom.Elementハイパーキューブを定義している<xsd:element>要素を表します。
18DIMENSION_ITEM_NODEorg.w3c.dom.Elementディメンジョンを定義している<xsd:element>要素を表します。

注※ XBRL Dimensions1.0の場合だけ存在します。


このメソッドが返したorg.w3c.dom.Nodeオブジェクト,およびそのorg.w3c.dom.Nodeオブジェクトが属するDOMツリーに対する更新操作は絶対にしてはいけません。更新操作をした場合には,XBRL DOMが正常に動作しないおそれがあります。
戻り値:
このノードに対応するorg.w3c.dom.Nodeオブジェクトを返します。このノードの型がTAXONOMY_DOCUMENT_NODEの場合はnullを返します。