com.ihr.xbrl.om.table.structural

Interface StructuralNodeInterface

All Known Implementing Classes:

XBRLClosedRelationshipStructuralNode, XBRLClosedStructuralNode, XBRLConceptClosedRelationshipStructuralNode, XBRLDimensionClosedRelationshipStructuralNode, XBRLOpenStructuralNode, XBRLStructuralBreakdown, XBRLStructuralNode

public interface StructuralNodeInterface

Interface used to indicate tree node functionality of nodes and tree navigation.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLStructuralNode	getNodeAt(int index) Access a specific TableStructuralNode by index.
int	getNodeCount() Number of children nodes.
java.util.Iterator<XBRLStructuralNode>	getNodes() Allows to iterate all nodes in the right representation order.
XBRLStructuralNode	getParent() Access to the parent node of this StructuralNodeInterface.
boolean	isLeaf() last node in a tree is leaf node.

Method Detail

getNodes

java.util.Iterator<XBRLStructuralNode> getNodes()

Allows to iterate all nodes in the right representation order.

Returns:

an iterator over all TableStructuralNode at this level

getNodeAt

XBRLStructuralNode getNodeAt(int index)

Access a specific TableStructuralNode by index.

Parameters:

index - integer

Returns:

TableStructuralNode

isLeaf

boolean isLeaf()

last node in a tree is leaf node.

Returns:

true if this is the leaf node

getNodeCount

int getNodeCount()

Number of children nodes.

Returns:

integer

getParent

XBRLStructuralNode getParent()

Access to the parent node of this StructuralNodeInterface. If this node is the root the parent is null

Returns:

TableStructuralNode parent node or null

clear

void clear()

Clear.