xbrl.xdt.DRS

An xbrl.xdt.DRS class represents the dimensional relationship sets in the DTS.

class xbrl.xdt.DRS

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

Methods

xbrl.xdt.DRS.consecutive_relationships(Relationship rel)

Returns an iterator of xbrl.taxonomy.Relationship objects which represent the ‘following’ relationships given the ‘inital’ relationship. See http://www.xbrl.org/specification/dimensions/rec-2012-01-25/dimensions-rec-2006-09-18+corrected-errata-2012-01-25-clean.html#sec-consecutive-relationships for more information.

xbrl.xdt.DRS.dimension_domain_relationships(Dimension dim, linkrole)

Returns an iterator of xbrl.xdt.DimensionDomainRelationship objects which represent the dimension-domain relationships in the given linkrole that have the given dimension as source.

xbrl.xdt.DRS.domain_member_network_node(Item domain_head, linkrole, head_usable=False)

Returns a xbrl.xdt.DomainMemberNetworkNode object which represents the given domain member node for in the dimensional relationship set. Traversal is continued in the specified linkrole. The head_usable parameter is used to initialize the usable property of the returned xbrl.xdt.DomainMemberNetworkNode object. The depth is initialized to zero.

xbrl.xdt.DRS.domain_member_relationships(Item item, linkrole)

Returns an iterator of xbrl.xdt.DomainMemberRelationship objects which represent the domain-member relationships in the given linkrole that have the given item as source.

xbrl.xdt.DRS.domain_members(Dimension dimension, linkrole=None, usable_only=False)

Returns an iterator of xbrl.taxonomy.Item objects which represent all domain members in the dimensional relationships set starting from the given dimension in the given linkrole.

xbrl.xdt.DRS.domain_of_enumeration_values(Item domain_head, linkrole, head_usable=False)

Returns an iterator of xbrl.taxonomy.Item objects which represent all domain members in the domain of usable enumeration values starting from the given domain head in the given linkrole.

xbrl.xdt.DRS.filter_member_drs_selection(Item primary_item, Dimension dimension, Item domain_member, axis, linkrole=None)

Returns an iterator of xbrl.taxonomy.Item objects which represent the filtered domain members according to xfi:filter-member-DRS-selection. See here for more details.

xbrl.xdt.DRS.filter_member_network_selection(Dimension dimension, Item domain_member, linkrole_uri, arcrole_uri, axis)

Returns an iterator of xbrl.taxonomy.Item objects which represent the filtered domain members according to xfi:filter-member-network-selection. See here for more details.

xbrl.xdt.DRS.hashypercube_relationships(Item item, linkrole, include_inherited=False)

Returns an iterator of xbrl.xdt.HasHypercubeRelationship objects which represent the all and not-all relationships in the given linkrole that have the given item as source. If include_inherited is set to True, also any inherited all and not-all relationships will be returned.

xbrl.xdt.DRS.hypercube_dimension_relationships(Hypercube hc, linkrole)

Returns an iterator of xbrl.xdt.HypercubeDimensionRelationship objects which represent the hypercube-dimension relationships in the given linkrole that have the given hypercube as source.

xbrl.xdt.DRS.is_dimensionally_valid(Item item, ConstraintSet constraintSet)

Returns a set of link role URIs for each baset set that contains the starting point of the dimensional relationship set with the given root concept. If no root was specified, all link roles that contain dimensional relationships are returned.

xbrl.xdt.DRS.primary_items(linkrole=None, include_inherited=False)

Returns an iterator of xbrl.taxonomy.Item objects which represent all primary items that are roots of dimensional relationships sets in the given linkrole. If include_inherited is set to True, also primary items with inherited all and not-all relationships will be returned.

xbrl.xdt.DRS.roots(linkrole, include_inherited=False)

[DEPRECATED] Returns an iterator of xbrl.taxonomy.Item objects which represent all primary items that are roots of dimensional relationships sets in the given linkrole. If include_inherited is set to True, also primary items with inherited all and not-all relationships will be returned.

Special methods

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