LocalElementDeclaration
Local element declaration. Like a global element declaration, it is an xs:element XML element with a name attribute. Unlike a global element declaration, it is not a child element of the xs:schema root element, but it is nested inside a type definition, for example. Unlike a global element declaration, it cannot have any substitution group, and therefore cannot be a concept declaration.
Local element declaration. Like a global element declaration, it is an xs:element XML element with a name attribute. Unlike a global element declaration, it is not a child element of the xs:schema root element, but it is nested inside a type definition, for example. Unlike a global element declaration, it cannot have any substitution group, and therefore cannot be a concept declaration.
In an XBRL taxonomy, local element declarations are rare, if they occur at all. After all, most element declarations are global element declarations declaring item or tuple concepts, and tuple concept content models refer to other (item or tuple) concept declarations.
Type members
Inherited types
Value members
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 backingElem.key
, or its equivalent.
Returns backingElem.key
, or its equivalent.
- Inherited from
- TaxonomyElem
The maxOccurs attribute as optional integer, defaulting to 1, but returning None if unbounded. This may fail with an exception if the taxonomy is not schema-valid.
The maxOccurs attribute as optional integer, defaulting to 1, but returning None if unbounded. This may fail with an exception if the taxonomy is not schema-valid.
- Inherited from
- Particle
The minOccurs attribute as integer, defaulting to 1. This may fail with an exception if the taxonomy is not schema-valid.
The minOccurs attribute as integer, defaulting to 1. This may fail with an exception if the taxonomy is not schema-valid.
- Inherited from
- Particle
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