xbrl.xdt.DomainMemberNetworkNode

An xbrl.xdt.DomainMemberNetworkNode class represents a domain member node in the dimensional relationship set. The interface can be used to traverse consecutive domain-member relationships in the dimensional relationship set. Each xbrl.xdt.DomainMemberNetworkNode object stores an additional reference to the relationship that was traversed to arrive at this node and can be queried for relevant attributes, e.g. the usable flag.

class xbrl.xdt.DomainMemberNetworkNode

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

Attributes

xbrl.xdt.DomainMemberNetworkNode.children

Returns an iterator of xbrl.xdt.DomainMemberNetworkNode objects which represent all domain member child nodes in the dimensional relationship set. The returned list of nodes corresponds to the child axis.

xbrl.xdt.DomainMemberNetworkNode.depth

Returns the depth of the current node relative to the initial starting node returned by xbrl.xdt.DRS.domain_member_network_node().

xbrl.xdt.DomainMemberNetworkNode.domain_member

Returns a xbrl.Item object which represents the current domain member node in the dimensional relationship set.

xbrl.xdt.DomainMemberNetworkNode.label

Returns an xbrl.taxonomy.Label object which represents a label in the standard linkrole with either the standard or if specified the preferred label role, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

Returns a string with the link role of the domain-member relationship (represented by an XLink arc) leading to this node.

xbrl.xdt.DomainMemberNetworkNode.preferred_label_role

Returns a string with the preferred label role if the domain-member relationship (represented by an XLink arc) leading to this node has a ‘gpl:preferredLabel’ attribute, otherwise None.

xbrl.xdt.DomainMemberNetworkNode.relationship

Returns a xbrl.taxonomy.DomainMemberRelationship object which represents the domain-member relationship that was traversed to arrive at this node.

xbrl.xdt.DomainMemberNetworkNode.usable

Returns False if the domain-member relationship (represented by an XLink arc) leading to this node has a ‘xdt:usable’ attribute set to false, otherwise True.

Methods

xbrl.xdt.DomainMemberNetworkNode.labels(label_role=None, link_role=None, lang=None)

Returns an iterator of xbrl.taxonomy.Label objects. If called without any arguments, all assigned labels will be returned. Use label_role, link_role and lang arguments to constrain the returned labels. The label_role argument is ignored and overwritten by the preferred label role if present.

xbrl.xdt.DomainMemberNetworkNode.walk(*, include_self=True, generations=None)

Returns an iterator of xbrl.xdt.DomainMemberNetworkNode objects which represent all descendent nodes in depth first order. If include_self is True, this node is also included in the generated list. If generations is specified with a value greater than zero, the iterator will stop after the specified number of transitions.

Special methods

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