xbrl.taxonomy.Concept

An xbrl.taxonomy.Concept class represents an XBRL concept in the DTS.

class xbrl.taxonomy.Concept

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

Attributes

xbrl.taxonomy.Concept.document

Returns an xbrl.taxonomy.TaxonomySchema object which represents the XBRL taxonomy schema which contains the element declaration for this concept.

xbrl.taxonomy.Concept.documentation_label

Returns an xbrl.taxonomy.Label object which represents the documentation label assigned in the standard linkrole, 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.

xbrl.taxonomy.Concept.label

Returns an xbrl.taxonomy.Label object which represents the standard label assigned in the standard linkrole, 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.

xbrl.taxonomy.Concept.terse_label

Returns an xbrl.taxonomy.Label object which represents the terse label assigned in the standard linkrole, 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.

xbrl.taxonomy.Concept.verbose_label

Returns an xbrl.taxonomy.Label object which represents the verbose label assigned in the standard linkrole, 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.

Methods

xbrl.taxonomy.Concept.custom_attribute_value(qname)

Returns a subclass of xsd.AnySimpleType that corresponds to the schema actual value of the custom attribute with the given QName or None if such attribute does not exist.

xbrl.taxonomy.Concept.has_custom_attribute(qname)

Returns True if the concept’s element declaration has an attribute with the given QName.

xbrl.taxonomy.Concept.label_relationships(arc_role=None, link_role=None)

Returns an iterator of xbrl.taxonomy.LabelRelationship objects. If called without any arguments, all <labelArc> relationships starting from this concept will be returned. Use arc_role and link_role arguments to constrain the returned relationships.

xbrl.taxonomy.Concept.labels(label_role=None, link_role=None, lang=None, **kargs)

Returns an iterator of xbrl.taxonomy.Label objects. If called without any arguments, all assigned concept-label labels will be returned. Use label_role, arc_role, link_role and lang arguments to constrain the returned labels. If arc_role is not specified, only labels connected by concept-label <labelArc> arcs are considered.

xbrl.taxonomy.Concept.reference_relationships(arc_role=None, link_role=None)

Returns an iterator of xbrl.taxonomy.ReferenceRelationship objects. If called without any arguments, all <referenceArc> relationships starting from this concept will be returned. Use arc_role and link_role arguments to constrain the returned relationships.

xbrl.taxonomy.Concept.references(reference_role=None, link_role=None, **kargs)

Returns an iterator of xbrl.taxonomy.Reference objects. If called without any arguments, all assigned concept-reference references will be returned. Use reference_role, arc_role and link_role arguments to constrain the returned references. If arc_role is not specified, only references connected by concept-reference <referenceArc> arcs are considered.

xbrl.taxonomy.Concept.xpointer(bForceElementScheme=False)

Returns an URI with XPointer fragment that points to this XSD element declaration as a string. If the XSD element declaration has an id attribute, a shorthand pointer with the id attribute value will be generated, otherwise the XPointer element scheme will be used. Set force_element_scheme to True to prevent generation of shorthand pointers.

Special methods

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