xbrl.Concept
¶
A Concept class represents an XBRL concept in the DTS.
-
class
xbrl.
Concept
(DTS dts, ElementDeclaration decl)¶
Attributes¶
-
xbrl.Concept.
balance
¶ Returns DEBIT or CREDIT if the concept’s schema element declaration contains an xbrli:balance attribute. Otherwise this attribute is None.
-
xbrl.Concept.
concept_type
¶ Returns one of ITEM, TUPLE, HYPERCUBE, DIMENSION_EXPLICIT, or DIMENSION_TYPED depending on the substitution group affiliation of the concept’s schema element declaration.
-
xbrl.Concept.
element
¶ Returns an
xml.Element
object which represents the XML element information item of the concept’s schema element declaration.
-
xbrl.Concept.
element_declaration
¶ Returns an
xsd.ElementDeclaration
object which represents the concept’s schema element declaration.
-
xbrl.Concept.
id
¶ Returns the id attribute value as a string, or “None” if the XML element doesn’t have an id attribute.
-
xbrl.Concept.
item_type
¶ Returns the built-in XBRL type from which the concepts type definition is derived from. Examples are, for example, STRING_ITEM_TYPE, MONETARY_ITEM_TYPE, SHARES_ITEM_TYPE.
-
xbrl.Concept.
label_elements
¶ Returns a generator object of
xml.Element
objects representing all label resources that are associated with this concept.
-
xbrl.Concept.
labels
¶ Returns a generator object of
xbrl.LabelResource
objects for each label that has a concept-label (http://www.xbrl.org/2003/arcrole/concept-label) relationship to this concept.
-
xbrl.Concept.
period_type
¶ Returns INSTANT or DURATION if the concept’s schema element declaration contains an xbrli:periodType attribute. Otherwise this attribute is None.
-
xbrl.Concept.
qname
¶ Returns an
xml.QName
object which represents the XML qualified name of the concept.
-
xbrl.Concept.
reference_elements
¶ Returns a generator object of
xml.Element
objects representing all reference resources that are associated with this concept.
-
xbrl.Concept.
references
¶ Returns a generator object of
xbrl.ReferenceResource
objects for each label that has a concept-reference (http://www.xbrl.org/2003/arcrole/concept-reference) relationship to this concept.
Methods¶
-
xbrl.Concept.
calculation_children
(linkrole)¶
-
xbrl.Concept.
calculation_parents
(linkrole)¶
-
xbrl.Concept.
is_abstract
()¶ Returns True if the concept’s schema element declaration has the abstract component property set to True.
-
xbrl.Concept.
is_fraction
()¶ Returns True if the concept’s type definition is derived from xbrli:fractionItemType.
-
xbrl.Concept.
is_nillable
()¶ Returns True if the concept’s schema element declaration has the nillable component property set to True.
-
xbrl.Concept.
is_non_numeric
()¶ Returns True if the concept’s type definition is derived from one of the built-in XBRL non-numeric types.
-
xbrl.Concept.
is_numeric
()¶ Returns True if the concept’s type definition is derived from one of the built-in XBRL numeric types.
-
xbrl.Concept.
presentation_children
(linkrole)¶
-
xbrl.Concept.
presentation_parents
(linkrole)¶
-
xbrl.Concept.
select_labels
(label_role=None, link_role=None, lang=None)¶ Returns a generator object of
xbrl.LabelResource
objects for each label that has a concept-label relationship (http://www.xbrl.org/2003/arcrole/concept-label) to this concept and also matches the given parameters.
-
xbrl.Concept.
select_references
(reference_role=None, link_role=None)¶ Returns a generator object of
xbrl.ReferenceResource
objects for each reference that has a concept-reference relationship (http://www.xbrl.org/2003/arcrole/concept-reference) to this concept and also matches the given parameters.
Special methods¶
__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__