xbrl.taxonomy.Relationship
¶
An xbrl.taxonomy.Relationship
class represents a relationship in the DTS network of relationships.
- class xbrl.taxonomy.Relationship¶
Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a
NotImplementedError
exception.
Attributes¶
- xbrl.taxonomy.Relationship.arc¶
Returns an
xbrl.taxonomy.Arc
object which represents the underlying XLink arc in the DTS.
- xbrl.taxonomy.Relationship.arcrole¶
Returns the arcrole URI for this relationship as str.
- xbrl.taxonomy.Relationship.from_locator¶
Returns an
xbrl.taxonomy.Locator
object which represents the XLink from locator of this relationship.
- xbrl.taxonomy.Relationship.order¶
Returns the order value of the relationship as decimal.Decimal.
- xbrl.taxonomy.Relationship.overridden_relationships¶
Returns an iterator of
xbrl.taxonomy.Relationship
objects representing equivalent relationships that have been overridden by this relationship. Returns an empty list if this relationship is not an effective relationship.
- xbrl.taxonomy.Relationship.overriding_relationship¶
Returns an
xbrl.taxonomy.Relationship
object representing the equivalent relationship with the highest priority, or None if this relationship has not been overridden.
- xbrl.taxonomy.Relationship.preferred_label¶
Returns the value of the ‘preferredLabel’ attribute as a string, or None if the XLink arc element information item doesn’t have a ‘preferredLabel’ attribute. If support for XBRL Generic Preferred Label 1.0 is enabled, the @gpl:preferredLabel attribute will also be consulted.
- xbrl.taxonomy.Relationship.priority¶
Returns priority value of the relationship as int.
- xbrl.taxonomy.Relationship.role¶
Returns the role URI of the containing extended link for this relationship as str.
- xbrl.taxonomy.Relationship.source¶
Returns either an
xbrl.taxonomy.Concept
,xbrl.taxonomy.Resource
or xml.ElementInformationItem object which represents the source of the relationship.
- xbrl.taxonomy.Relationship.source_concept¶
Returns an
xbrl.taxonomy.Concept
object which represents the source concept of the relationship, or None if the relationship source is not an XBRL concept.
- xbrl.taxonomy.Relationship.source_element¶
Returns an xml.ElementInformationItem object which represents the source XML element information item of the relationship.
- xbrl.taxonomy.Relationship.source_fact¶
Returns an xbrl.Fact object which represents the source fact of the relationship, or None if the relationship source is not an XBRL fact.
- xbrl.taxonomy.Relationship.source_resource¶
Returns an
xbrl.taxonomy.Resource
object which represents the source resource of the relationship, or None if the relationship source is not an XBRL resource.
- xbrl.taxonomy.Relationship.target¶
Returns either an
xbrl.taxonomy.Concept
,xbrl.taxonomy.Resource
or xml.ElementInformationItem object which represents the target of the relationship.
- xbrl.taxonomy.Relationship.target_concept¶
Returns an
xbrl.taxonomy.Concept
object which represents the target concept of the relationship, or None if the relationship target is not an XBRL concept.
- xbrl.taxonomy.Relationship.target_element¶
Returns an xml.ElementInformationItem object which represents the target XML element information item of the relationship.
- xbrl.taxonomy.Relationship.target_fact¶
Returns an xbrl.Fact object which represents the target fact of the relationship, or None if the relationship target is not an XBRL fact.
- xbrl.taxonomy.Relationship.target_resource¶
Returns an
xbrl.taxonomy.Resource
object which represents the target resource of the relationship, or None if the relationship target is not an XBRL resource.
- xbrl.taxonomy.Relationship.to_locator¶
Returns an
xbrl.taxonomy.Locator
object which represents the XLink to locator of this relationship.
Methods¶
- xbrl.taxonomy.Relationship.is_effective()¶
Returns True if the relationship was included in the network of relationships.
- xbrl.taxonomy.Relationship.is_prohibited()¶
Returns True if the relationship is a prohibiting relationship.
Special methods¶
__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__