Class

eu.cdevreeze.tqa.dom

GlobalElementDeclaration

Related Doc: package dom

Permalink

final class GlobalElementDeclaration extends TaxonomyElem with ElementDeclaration with CanBeAbstract

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.

Linear Supertypes
CanBeAbstract, ElementDeclaration, NamedDeclOrDef, ElementDeclarationOrReference, XsdElem, TaxonomyElem, SubtypeAwareElemLike, SubtypeAwareElemApi, ScopedElemLike, ClarkElemLike, HasText, HasEName, IsNavigable, ElemLike, ScopedElemApi, HasScopeApi, HasQNameApi, ClarkElemApi, HasTextApi, HasENameApi, IsNavigableApi, ElemApi, AnyElemApi, Elem, CanBeDocumentChild, Node, AnyTaxonomyElem, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GlobalElementDeclaration
  2. CanBeAbstract
  3. ElementDeclaration
  4. NamedDeclOrDef
  5. ElementDeclarationOrReference
  6. XsdElem
  7. TaxonomyElem
  8. SubtypeAwareElemLike
  9. SubtypeAwareElemApi
  10. ScopedElemLike
  11. ClarkElemLike
  12. HasText
  13. HasEName
  14. IsNavigable
  15. ElemLike
  16. ScopedElemApi
  17. HasScopeApi
  18. HasQNameApi
  19. ClarkElemApi
  20. HasTextApi
  21. HasENameApi
  22. IsNavigableApi
  23. ElemApi
  24. AnyElemApi
  25. Elem
  26. CanBeDocumentChild
  27. Node
  28. AnyTaxonomyElem
  29. AnyRef
  30. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type ThisElem = TaxonomyElem

    Permalink
    Definition Classes
    TaxonomyElem → SubtypeAwareElemLike → SubtypeAwareElemApi → ScopedElemLike → ClarkElemLike → IsNavigable → ElemLike → ScopedElemApi → ClarkElemApi → IsNavigableApi → ElemApi → AnyElemApi

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def \(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  5. final def \@(expandedName: EName): Option[String]

    Permalink
    Definition Classes
    HasEName → HasENameApi
  6. final def \\(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  7. final def \\!(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. final def attribute(expandedName: EName): String

    Permalink
    Definition Classes
    HasEName → HasENameApi
  10. final def attributeAsQName(expandedName: EName): QName

    Permalink
    Definition Classes
    ScopedElemLike → ScopedElemApi
  11. final def attributeAsQNameOption(expandedName: EName): Option[QName]

    Permalink
    Definition Classes
    ScopedElemLike → ScopedElemApi
  12. final def attributeAsResolvedQName(expandedName: EName): EName

    Permalink
    Definition Classes
    ScopedElemLike → ScopedElemApi
  13. final def attributeAsResolvedQNameOption(expandedName: EName): Option[EName]

    Permalink
    Definition Classes
    ScopedElemLike → ScopedElemApi
  14. final def attributeOption(expandedName: EName): Option[String]

    Permalink
    Definition Classes
    HasEName → HasENameApi
  15. final def attributes: IndexedSeq[(QName, String)]

    Permalink
    Definition Classes
    TaxonomyElem → HasQNameApi
  16. val backingElem: BackingElemApi

    Permalink
    Definition Classes
    TaxonomyElem
  17. final def baseUri: URI

    Permalink
    Definition Classes
    TaxonomyElem
  18. final def baseUriOption: Option[URI]

    Permalink
    Definition Classes
    TaxonomyElem
  19. val childElems: IndexedSeq[TaxonomyElem]

    Permalink
    Definition Classes
    TaxonomyElem
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def docUri: URI

    Permalink
    Definition Classes
    TaxonomyElem
  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    TaxonomyElem → AnyRef → Any
  24. final def filterChildElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  25. final def filterChildElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  26. final def filterElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  27. final def filterElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  28. final def filterElemsOrSelf(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  29. final def filterElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  30. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def findAllChildElems: IndexedSeq[TaxonomyElem]

    Permalink

    Returns all child elements, and returns them extremely fast.

    Returns all child elements, and returns them extremely fast. This is important for fast querying, at the expense of more expensive recursive creation.

    Definition Classes
    TaxonomyElem → ElemLike → ElemApi
  32. final def findAllChildElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  33. final def findAllChildElemsWithPathEntries: IndexedSeq[(ThisElem, Entry)]

    Permalink
    Definition Classes
    ClarkElemLike → IsNavigable → IsNavigableApi
  34. final def findAllElems: IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  35. final def findAllElemsOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  36. final def findAllElemsOrSelf: IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  37. final def findAllElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B]): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  38. final def findAttributeByLocalName(localName: String): Option[String]

    Permalink
    Definition Classes
    HasEName → HasENameApi
  39. final def findChildElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  40. final def findChildElemByPathEntry(entry: Entry): Option[ThisElem]

    Permalink
    Definition Classes
    ClarkElemLike → IsNavigable → IsNavigableApi
  41. final def findChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  42. final def findElem(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  43. final def findElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  44. final def findElemOrSelf(p: (ThisElem) ⇒ Boolean): Option[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  45. final def findElemOrSelfByPath(path: Path): Option[ThisElem]

    Permalink
    Definition Classes
    IsNavigable → IsNavigableApi
  46. final def findElemOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): Option[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  47. final def findReverseAncestryOrSelfByPath(path: Path): Option[IndexedSeq[ThisElem]]

    Permalink
    Definition Classes
    IsNavigable → IsNavigableApi
  48. final def findTopmostElems(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  49. final def findTopmostElemsOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  50. final def findTopmostElemsOrSelf(p: (ThisElem) ⇒ Boolean): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    ElemLike → ElemApi
  51. final def findTopmostElemsOrSelfOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): IndexedSeq[B]

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  52. final def getChildElem(p: (ThisElem) ⇒ Boolean): ThisElem

    Permalink
    Definition Classes
    ElemLike → ElemApi
  53. final def getChildElemByPathEntry(entry: Entry): ThisElem

    Permalink
    Definition Classes
    IsNavigable → IsNavigableApi
  54. final def getChildElemOfType[B <: ThisElem](subType: ClassTag[B])(p: (B) ⇒ Boolean): B

    Permalink
    Definition Classes
    SubtypeAwareElemLike → SubtypeAwareElemApi
  55. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  56. final def getElemOrSelfByPath(path: Path): ThisElem

    Permalink
    Definition Classes
    IsNavigable → IsNavigableApi
  57. final def getReverseAncestryOrSelfByPath(path: Path): IndexedSeq[ThisElem]

    Permalink
    Definition Classes
    IsNavigable → IsNavigableApi
  58. def hasSubstitutionGroup(substGroup: EName, substitutionGroupMap: SubstitutionGroupMap): Boolean

    Permalink

    Returns true if this global element declaration has the given substitution group, either directly or indirectly.

    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.

  59. final def hashCode(): Int

    Permalink
    Definition Classes
    TaxonomyElem → AnyRef → Any
  60. final def idOption: Option[String]

    Permalink
    Definition Classes
    TaxonomyElem
  61. final def isAbstract: Boolean

    Permalink

    Returns the boolean "abstract" attribute (defaulting to false).

    Returns the boolean "abstract" attribute (defaulting to false). This may fail with an exception if the taxonomy is not schema-valid.

    Definition Classes
    CanBeAbstract
  62. final def isConcrete: Boolean

    Permalink
    Definition Classes
    CanBeAbstract
  63. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  64. final def key: XmlFragmentKey

    Permalink
    Definition Classes
    TaxonomyElemAnyTaxonomyElem
  65. final def localName: String

    Permalink
    Definition Classes
    HasEName → HasENameApi
  66. final def msg(s: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    TaxonomyElem
  67. final def nameAttributeValue: String

    Permalink

    Returns the "name" attribute.

    Returns the "name" attribute. This may fail with an exception if the taxonomy is not schema-valid.

    Definition Classes
    NamedDeclOrDef
  68. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  69. final def normalizedText: String

    Permalink
    Definition Classes
    HasText → HasTextApi
  70. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  71. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  72. def periodTypeOption: Option[PeriodType]

    Permalink

    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.

  73. final def qname: QName

    Permalink
    Definition Classes
    TaxonomyElem → HasQNameApi
  74. final def resolvedAttributes: IndexedSeq[(EName, String)]

    Permalink
    Definition Classes
    TaxonomyElem → HasENameApi
  75. final def resolvedName: EName

    Permalink
    Definition Classes
    TaxonomyElem → HasENameApi
  76. final def schemaTargetNamespaceOption: Option[String]

    Permalink

    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.

    Definition Classes
    XsdElem
  77. final def scope: Scope

    Permalink
    Definition Classes
    TaxonomyElem → HasScopeApi
  78. def substitutionGroupOption: Option[EName]

    Permalink

    Returns the optional substitution group (as EName).

    Returns the optional substitution group (as EName). This may fail with an exception if the taxonomy is not schema-valid.

  79. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  80. def targetEName: EName

    Permalink

    Returns the "target EName".

    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.

  81. final def text: String

    Permalink
    Definition Classes
    TaxonomyElem → HasTextApi
  82. final def textAsQName: QName

    Permalink
    Definition Classes
    ScopedElemLike → ScopedElemApi
  83. final def textAsResolvedQName: EName

    Permalink
    Definition Classes
    ScopedElemLike → ScopedElemApi
  84. final def thisElem: ThisElem

    Permalink
    Definition Classes
    TaxonomyElem → AnyElemApi
  85. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  86. final def trimmedText: String

    Permalink
    Definition Classes
    HasText → HasTextApi
  87. def typeOption: Option[EName]

    Permalink

    Returns the optional type attribute (as EName).

    Returns the optional type attribute (as EName). This may fail with an exception if the taxonomy is not schema-valid.

    Definition Classes
    ElementDeclaration
  88. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CanBeAbstract

Inherited from ElementDeclaration

Inherited from NamedDeclOrDef

Inherited from XsdElem

Inherited from TaxonomyElem

Inherited from SubtypeAwareElemLike

Inherited from SubtypeAwareElemApi

Inherited from ScopedElemLike

Inherited from ClarkElemLike

Inherited from HasText

Inherited from HasEName

Inherited from IsNavigable

Inherited from ElemLike

Inherited from ScopedElemApi

Inherited from HasScopeApi

Inherited from HasQNameApi

Inherited from ClarkElemApi

Inherited from HasTextApi

Inherited from HasENameApi

Inherited from IsNavigableApi

Inherited from ElemApi

Inherited from AnyElemApi

Inherited from Elem

Inherited from CanBeDocumentChild

Inherited from Node

Inherited from AnyTaxonomyElem

Inherited from AnyRef

Inherited from Any

Ungrouped