GlobalElementDeclaration
Global element declaration. This element in isolation does not know if the element declaration is a concept declaration, because it does not know from which substitution groups its own substitution group, if any, derives.
Global element declaration. This element in isolation does not know if the element declaration is a concept declaration, because it does not know from which substitution groups its own substitution group, if any, derives.
Example, assuming an xs:schema parent (and document root) element:
<xs:element
id="businessSegments"
name="BusinessSegments"
type="xbrli:monetaryItemType"
substitutionGroup="xbrli:item"
xbrli:periodType="duration" />
In this case, we see immediately that the global element declaration is an item concept declaration, but as said above, in general we cannot determine this without looking at the context of all other taxonomy documents in the same "taxonomy".
Once we have a SubstitutionGroupMap
as context, we can turn the global element declaration into a ConceptDeclaration
,
if the global element declaration is indeed an item or tuple declaration according to the SubstitutionGroupMap
.
Type members
Inherited types
Value members
Concrete methods
Returns all own or transitively inherited substitution groups. The given mappings are used as the necessary context.
Returns all own or transitively inherited substitution groups. The given mappings are used as the necessary context.
This method may fail with an exception if the taxonomy is not schema-valid.
Returns true if this global element declaration has the given substitution group, either directly or indirectly. The given mappings are used as the necessary context, but are not needed if the element declaration directly has the substitution group itself.
Returns true if this global element declaration has the given substitution group, either directly or indirectly. The given mappings are used as the necessary context, but are not needed if the element declaration directly has the substitution group itself.
This method may fail with an exception if the taxonomy is not schema-valid.
Returns the optional xbrli:periodType attribute, as PeriodType
.
Returns the optional xbrli:periodType attribute, as PeriodType
.
This method may fail with an exception if the taxonomy is not schema-valid.
Returns the optional substitution group (as EName). This may fail with an exception if the taxonomy is not schema-valid.
Returns the optional substitution group (as EName). This may fail with an exception if the taxonomy is not schema-valid.
Returns the "target EName". That is, returns the EName composed of the optional target namespace and the name attribute as local part. This may fail with an exception if the taxonomy is not schema-valid, although such a failure is very unlikely.
Returns the "target EName". That is, returns the EName composed of the optional target namespace and the name attribute as local part. This may fail with an exception if the taxonomy is not schema-valid, although such a failure is very unlikely.
Inherited methods
Shorthand for attributeOption(expandedName)
.
Shorthand for attributeOption(expandedName)
.
- Inherited from
- ClarkElemLike
Returns all child elements, and returns them extremely fast. This is important for fast querying, at the expense of more expensive recursive creation.
Returns all child elements, and returns them extremely fast. This is important for fast querying, at the expense of more expensive recursive creation.
- Inherited from
- TaxonomyElem
Returns all child elements paired with their path entries.
Returns all child elements paired with their path entries.
This method is final, so more efficient implementations for sub-types are not supported. This implementation is only efficient if finding all child elements as well as computing their resolved names is efficient. That is not the case for DOM wrappers or Scala XML Elem wrappers (due to their expensive Scope computations). On the other hand, those wrapper element implementations are convenient, but not intended for heavy use in production. Hence, this method should typically be fast enough.
- Definition Classes
- ClarkElemLike -> IsNavigable -> IsNavigableApi
- Inherited from
- ClarkElemLike
Finds the child element with the given Path.Entry
(where this element is the root), if any, wrapped in an Option
.
Finds the child element with the given Path.Entry
(where this element is the root), if any, wrapped in an Option
.
This method is final, so more efficient implementations for sub-types are not supported. This implementation is only efficient if finding all child elements as well as computing their resolved names is efficient. That is not the case for DOM wrappers or Scala XML Elem wrappers (due to their expensive Scope computations). On the other hand, those wrapper element implementations are convenient, but not intended for heavy use in production. Hence, this method should typically be fast enough.
- Definition Classes
- ClarkElemLike -> IsNavigable -> IsNavigableApi
- Inherited from
- ClarkElemLike
- Inherited from
- SubtypeAwareElemLike
Returns the boolean "abstract" attribute (defaulting to false). This may fail with an exception if the taxonomy is not schema-valid.
Returns the boolean "abstract" attribute (defaulting to false). This may fail with an exception if the taxonomy is not schema-valid.
- Inherited from
- CanBeAbstract
Returns backingElem.key
, or its equivalent.
Returns backingElem.key
, or its equivalent.
- Inherited from
- TaxonomyElem
Returns the "name" attribute. This may fail with an exception if the taxonomy is not schema-valid.
Returns the "name" attribute. This may fail with an exception if the taxonomy is not schema-valid.
- Inherited from
- NamedDeclOrDef
Returns key.path
, or its equivalent backingElem.path
.
Returns key.path
, or its equivalent backingElem.path
.
- Inherited from
- TaxonomyElem
Returns the optional target namespace of the surrounding schema root element (or self), ignoring the possibility that this is an included chameleon schema.
Returns the optional target namespace of the surrounding schema root element (or self), ignoring the possibility that this is an included chameleon schema.
- Inherited from
- ElemInXsdNamespace
Returns the optional type attribute (as EName). This may fail with an exception if the taxonomy is not schema-valid.
Returns the optional type attribute (as EName). This may fail with an exception if the taxonomy is not schema-valid.
- Inherited from
- ElementDeclaration