xbrl.table.structural.Node

An xbrl.table.structural.Node class represents a structural node.

class xbrl.table.structural.Node

Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Attributes

xbrl.table.structural.Node.children

Returns an iterator of xbrl.table.structural.Node objects representing the child structural nodes.

xbrl.table.structural.Node.constraint_sets

Returns a dictionary of tags to xbrl.ConstraintSet objects representing the constraint sets on this structural node. The untagged constraint set is represented by the key None.

xbrl.table.structural.Node.definition_node

Returns an xbrl.table.DefinitionNode object which represents the corresponding definition node in the definition model.

xbrl.table.structural.Node.non_rollup_ancestor

Returns an xbrl.table.structural.Node representing the first ancestor structural node that is not a roll-up node, or None if this node is the root node.

xbrl.table.structural.Node.non_rollup_ancestor_or_self

Returns an xbrl.table.structural.Node representing itself or the first ancestor structural node that is not a roll-up node.

xbrl.table.structural.Node.parent

Returns an xbrl.table.structural.Node representing the parent structural node, or None if this node is the root node.

xbrl.table.structural.Node.preferred_label

Returns the preferred label role from the presentation arc if this structural node was generated from a concept relationship node, otherwise None.

xbrl.table.structural.Node.rollup_child

Returns an xbrl.table.structural.Node representing the roll-up structural node child or None if this node does not have a roll-up child.

xbrl.table.structural.Node.tag_selectors

Returns a list of tag selectors for this structural node.

Methods

xbrl.table.structural.Node.is_closed()

Returns True if this structural node is a closed structural node.

xbrl.table.structural.Node.is_open()

Returns True if this structural node is an open structural node.

xbrl.table.structural.Node.is_rollup()

Returns True if this structural node is a roll-up node.

Special methods

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__