xbrl.xdt.Dimension

An xbrl.xdt.Dimension class represents an XDT dimension declaration in the DTS.

Base class: xbrl.taxonomy.Item -> xbrl.taxonomy.Concept -> xsd.ElementDeclaration -> xsd.Component

class xbrl.xdt.Dimension

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

Attributes

xsd.ElementDeclaration.abstract

Returns True if this xsd.ElementDeclaration is abstract. Such xsd.ElementDeclaration objects can appear in content models only when substitution is allowed; such declarations must not themselves ever be used to validate element content.

xsd.ElementDeclaration.annotations

Returns an iterator of xsd.Annotation components.

xbrl.taxonomy.Item.balance

Returns the ‘xbrli:balance’ attribute value as an xbrl.taxonomy.Balance enumeration, or None if the ‘xbrli:balance’ attribute is absent.

xbrl.xdt.Dimension.default_member

Returns an xbrl.taxonomy.Item object representing the default domain member of this dimension, or None if the dimension is not the source of a dimension-default relationship. Raises an AttributeError if the dimension is not an explicit dimension.

xsd.ElementDeclaration.disallowed_substitutions

Returns a subset of {xsd.BlockValue.EXTENSION, xsd.BlockValue.RESTRICTION, xsd.BlockValue.SUBSTITUTION}. The supplied values for disallowed_substitutions determine whether an xsd.ElementDeclaration appearing in a content model will be prevented from additionally validating elements (a) with an xsi:type that identifies an extension or restriction of the type of the declared element, and/or (b) from validating elements which are in the substitution group headed by the declared element. If disallowed_substitutions is empty, then all derived types and substitution group members are allowed.

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.xdt.Dimension.domain_head_network_nodes

Returns an iterator of xbrl.xdt.DomainMemberNetworkNode objects which represent all heads of the domain network for this dimension. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.xdt.Dimension.effective_members

Returns an iterator of xbrl.taxonomy.Item objects which represent all usable domain members in the domain of this dimension. Raises an AttributeError if the dimension is not an explicit dimension.

xsd.Component.element

Returns the xml.ElementInformationItem representing this schema component.

xbrl.xdt.Dimension.equality_definition

Returns an xbrl.formula.EqualityDefinition object representing the assigned equality definition for this dimension, or None if the dimension’s domain definition is not the source of an equality-definition relationship. Raises an AttributeError if the dimension is not a typed dimension.

xsd.Component.id

Returns the value of the ‘id’ attribute as a string, or None if the schema component’s XML element doesn’t have an ‘id’ attribute.

xsd.ElementDeclaration.identity_constraint_definitions

Returns an iterator of xsd.IdentityConstraintDefinition objects, which express constraints establishing uniquenesses and reference relationships among the values of related elements and attributes.

xbrl.taxonomy.Item.item_type

Returns the concept’s built-in XBRL item base data type as an xbrl.taxonomy.ItemType enumeration.

xbrl.taxonomy.Item.item_type_definition

Returns the concept’s built-in XBRL item base data type as an xsd.TypeDefinition object.

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.

xsd.ElementDeclaration.name

Returns the name of the xsd.ElementDeclaration. This property must match the local part of the names of elements being validated.

xsd.ElementDeclaration.nillable

If nillable is True, then an element with no text or element content can be valid despite a type definition which would otherwise require content, if it carries the attribute xsi:nil with the value true.

xbrl.taxonomy.Item.period_type

Returns the ‘xbrli:periodType’ attribute value as an xbrl.taxonomy.PeriodType enumeration.

xsd.ElementDeclaration.qname

Returns a xml.QName object representing the name and target_namespace pair of the component.

xsd.ElementDeclaration.scope

Returns the xsd.Scope property record of this xsd.ElementDeclaration. If scope.variety == xsd.ScopeVariety.GLOBAL, then this xsd.ElementDeclaration is available for use throughout the xsd.Schema. If scope.variety == xsd.ScopeVariety.LOCAL, then this declaration is available for use only within scope.parent (which is a xsd.ComplexTypeDefinition or a xsd.ModelGroupDefinition).

xsd.ElementDeclaration.substitution_group_affiliations

Returns an iterator of xsd.ElementDeclaration objects indicating the substitution groups this xsd.ElementDeclaration can potentially be a member of. Potential membership is transitive but not symmetric; an xsd.ElementDeclaration is a potential member of any group named in its substitution_group_affiliations, and also of any group of which any entry in its substitution_group_affiliations is a potential member. Actual membership may be blocked by the effects of substitution_group_exclusions or disallowed_substitutions.

xsd.ElementDeclaration.substitution_group_exclusions

Returns a subset of {xsd.FinalValue.EXTENSION, xsd.FinalValue.RESTRICTION}. An empty substitution_group_exclusions allows a declaration to be named in the substitution_group_affiliations of other xsd.ElementDeclaration objects having the same declared type definition or some type derived therefrom. The explicit values of substitution_group_exclusions, xsd.FinalValue.EXTENSION or xsd.FinalValue.RESTRICTION, rule out xsd.ElementDeclaration objects having types whose derivation from type_definition involves any extension steps, or restriction steps, respectively.

xsd.ElementDeclaration.substitution_group_members

Returns an iterator of the actual members of this xsd.ElementDeclaration’s substitution group.

xsd.ElementDeclaration.target_namespace

Returns the target namespace of the xsd.ElementDeclaration. A non-absent value provides for validation of namespace-qualified xml.ElementInformationItem objects. Absent values of target_namespace validate unqualified items.

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.

xsd.ElementDeclaration.type_definition

Returns the declared type definition of this xsd.ElementDeclaration. This can either be a xsd.ComplexTypeDefinition or a xsd.SimpleTypeDefinition. The type definition against which an element information item is validated (its governing type definition) can be different from the declared type definition. The xsd.ElementDeclaration.type_table property, which governs conditional type assignment, and the xsi:type attribute of an xml.ElementInformationItem can cause the governing type definition and the declared type definition to be different.

xsd.ElementDeclaration.type_table

Returns the xsd.TypeTable property record of this xsd.ElementDeclaration. This property record governs conditional type assignment using xsd.TypeAlternative schema components.

xbrl.xdt.Dimension.typed_domain

Returns an xsd.ElementDeclaration object representing the typed domain definition of this dimension. Raises an AttributeError if the dimension is not a typed dimension.

xsd.ElementDeclaration.value_constraint

Returns the xsd.ValueConstraint property record of this xsd.ElementDeclaration. This property establishes a default or fixed value for an element. If a xsd.ValueConstraint with variety == xsd.ValueConstraintVariety.DEFAULT is present, and if the element being validated is empty, then for purposes of calculating the schema normalized value and other contributions to the post-schema-validation infoset the element is treated as if xsd.ValueConstraint.lexical_form was used as the content of the element. If variety == xsd.ValueConstraintVariety.FIXED, then the element’s content must either be empty, in which case FIXED behaves as DEFAULT, or its value must be equal or identical to xsd.ValueConstraint.value.

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.xdt.Dimension.get_domain_head_network_nodes(linkrole)

Returns an iterator of xbrl.xdt.DomainMemberNetworkNode objects which represent the heads of the domain network in the given linkrole. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.xdt.Dimension.get_effective_members(linkrole)

Returns an iterator of xbrl.taxonomy.Item objects which represent the usable domain members in the domain of in this dimension defined in the given linkrole. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.taxonomy.Concept.has_custom_attribute(qname)

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

xbrl.taxonomy.Item.is_boolean()

Returns True if the concept’s item type is or is derived from xbrli:booleanItemType.

xbrl.taxonomy.Item.is_derived_from(base_type)

Returns True if the concept’s type definition is derived from or equal to the given base type definition. The base type definition can be specified either as an xml.QName or xsd.TypeDefinition object.

xbrl.taxonomy.Item.is_duration()

Returns True if the ‘xbrli:periodType’ attribute value is equal to ‘duration’.

xbrl.taxonomy.Item.is_enum()

Returns True if the concept’s item type is or is derived from enum:enumerationItemType, enum11:enumerationItemType or enum2:enumerationItemType.

xbrl.taxonomy.Item.is_enum_set()

Returns True if the concept’s item type is or is derived from enum11:enumerationsItemType or enum2:enumerationSetItemType.

xbrl.xdt.Dimension.is_explicit()

Returns True if the XDT dimension declaration corresponds to an explicit dimension (has no ‘xbrldt:typedDomainRef’ attribute).

xbrl.taxonomy.Item.is_fraction()

Returns True if the concept’s item type is or is derived from xbrli:fractionItemType.

xbrl.taxonomy.Item.is_instant()

Returns True if the ‘xbrli:periodType’ attribute value is equal to ‘instant’.

xbrl.taxonomy.Item.is_integer()

Returns True if the concept’s item type is or is derived from a xbrli:integerItemType.

xbrl.taxonomy.Item.is_monetary()

Returns True if the concept’s item type is or is derived from xbrli:monetaryItemType.

xbrl.taxonomy.Item.is_non_numeric()

Returns True if the concept’s item type is or is derived from a non-numeric XBRL item data type.

xbrl.taxonomy.Item.is_numeric()

Returns True if the concept’s item type is or is derived from a numeric XBRL item data type.

xbrl.taxonomy.Item.is_qname()

Returns True if the concept’s item type is or is derived from xbrli:QNameItemType.

xbrl.taxonomy.Item.is_string()

Returns True if the concept’s item type is or is derived from xbrli:stringItemType or xbrli:normalizedStringItemType.

xbrl.xdt.Dimension.is_typed()

Returns True if the XDT dimension declaration corresponds to a typed dimension (has an ‘xbrldt:typedDomainRef’ attribute).

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__