6.11.7 SimpleNodeインターフェース
public interface SimpleNode
- XBRLのバージョン:
- 2.1
- 説明:
- 単純なタクソノミー文書を構成するノードを表します。
- com.hitachi.xbrl.simple.taxonomyパッケージのすべてのインターフェースの基底となるインターフェースです。
- フィールドの概要:
- SimpleNodeインターフェースのフィールドの概要を次の表に示します。
表6-184 SimpleNodeインターフェースのフィールドの概要
項番 | 説明 |
---|
1 | static int | SIMPLE_TAXONOMY_NODE ノードがSimpleTaxonomyであることを示します。 |
2 | static int | SIMPLE_ITEM_DEFINITION_NODE ノードがSimpleItemDefinitionであることを示します。 |
3 | static int | SIMPLE_LABEL_NODE ノードがSimpleLabelであることを示します。 |
4 | static int | SIMPLE_LABEL_EDGE_NODE ノードがSimpleLabelEdgeであることを示します。 |
- メソッドの概要:
- SimpleNodeインターフェースのメソッドの概要を次の表に示します。
表6-185 SimpleNodeインターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | boolean | isActive() ノードがアクティブであるかどうかを調べます。 | 2.1 |
2 | int | getNodeType() ノードの型を表すフィールド値を返します。 | 2.1 |
3 | SimpleTaxonomy | getOwnerTaxonomy() ノードを所有するSimpleTaxonomyオブジェクトを取得します。ノードがSimpleTaxonomyオブジェクトの場合には,常にnullを返します。 | 2.1 |
4 | SimpleNode | getParentNode() ノードが関連づけられている親ノードを取得します。 | 2.1 |
- <この項の構成>
- (1) isActive
- (2) getNodeType
- (3) getOwnerTaxonomy
- (4) getParentNode
(1) isActive
public boolean isActive()
- XBRLのバージョン:
- 2.1
- 説明:
- ノードがアクティブであるかどうかを調べます。ノードがSimpleTaxonomyオブジェクトの子孫ノードの場合にはtrueを返し,子孫ノードでない場合にはfalseを返します。
- 戻り値:
- ノードがアクティブな場合はtrue,そうでない場合はfalseを返します。このノードがSimpleTaxonomyオブジェクトの場合は,常にtrueを返します。
(2) getNodeType
public int getNodeType()
- XBRLのバージョン:
- 2.1
- 説明:
- ノードの型を表す値を取得します。
- 戻り値:
- ノードの型を表す,SimpleNodeインターフェースに定義されているフィールド値が返されます。フィールド値と各オブジェクトの対応は,この項の冒頭に示す表「SimpleNodeインターフェースのフィールドの概要」を参照してください。
(3) getOwnerTaxonomy
public SimpleTaxonomy getOwnerTaxonomy()
- XBRLのバージョン:
- 2.1
- 説明:
- ノードを所有するSimpleTaxonomyオブジェクトを取得します。ノードの状態がアクティブ/非アクティブに関係なく,このノードを生成したSimpleTaxonomyオブジェクトを返します。
- 戻り値:
- ノードを所有するSimpleTaxonomyオブジェクトを返します。このノードがSimpleTaxonomyの場合は,常にnullを返します。
(4) getParentNode
public SimpleNode getParentNode()
- XBRLのバージョン:
- 2.1
- 説明:
- ノードが関連づけられている親ノードを取得します。
- 戻り値:
- このノードの親ノードを返します。返される親ノードの型は,ノードの型によって次のように異なります。
項番 | ノードの型 | 親ノードの型 |
---|
1 | SIMPLE_TAXONOMY_NODE | 常にnullを返します。 |
2 | SIMPLE_ITEM_DEFINITION_NODE | SIMPLE_TAXONOMY_NODE |
3 | SIMPLE_LABEL_NODE | SIMPLE_LABEL_EDGE_NODE |
4 | SIMPLE_LABEL_EDGE_NODE | SIMPLE_TAXONOMY_NODE |
- このノードがSimpleTaxonomyの場合は常にnullを返します。また,このノードがほかのノードの子ノードとして接続されていない場合も,nullを返します。