Class/Object

eu.cdevreeze.tqa.instance

XbrliElem

Related Docs: object XbrliElem | package instance

Permalink

sealed class XbrliElem extends CanBeXbrliDocumentChild with Elem with ScopedElemLike with SubtypeAwareElemLike

XML element inside XBRL instance (or the entire XBRL instance itself). This API is immutable, provided the backing element is immutable.

The yaidom SubtypeAwareElemApi and ScopedElemApi query API is offered.

Also note that the package-private constructor contains redundant data, in order to speed up (yaidom-based) querying.

These XBRL instance elements are just an XBRL instance view on the underlying "backing element" tree, and therefore do not know about the taxonomy describing the XBRL instance (other than the href to the DTS entry point). It is not even required that the XBRL instance is schema-valid. Construction of an instance is indeed quite lenient.

As a consequence, this model must recognize facts by only looking at the elements and their ancestry, without knowing anything about the substitution groups of the corresponding concept declarations. Fortunately, the XBRL instance schema (xbrl-instance-2003-12-31.xsd) and the specification of allowed XBRL tuple content are (almost) restrictive enough in order to recognize facts.

It is even possible to easily distinguish between item facts and tuple facts, based on the presence or absence of the contextRef attribute. There is one complication, though, and that is nil item and tuple facts. Unfortunately, concept declarations in taxonomy schemas may have the nillable attribute set to true. This led to some clutter in the inheritance hierarchy for numeric item facts.

Hence, regarding nil facts, the user of the API is responsible for keeping in mind that facts can indeed be nil facts (which facts are easy to filter away).

Another limitation is that without the taxonomy, default dimensions are unknown. Finally, the lack of typing information is a limitation.

Note that the backing element implementation can be any implementation of yaidom query API trait BackingElemApi.

This class hierarchy depends on Java 8 or later, due to the use of Java 8 time API.

Linear Supertypes
SubtypeAwareElemLike, SubtypeAwareElemApi, ScopedElemLike, ClarkElemLike, HasText, HasEName, IsNavigable, ElemLike, ScopedElemApi, HasScopeApi, HasQNameApi, ClarkElemApi, HasTextApi, HasENameApi, IsNavigableApi, ElemApi, AnyElemApi, Elem, CanBeXbrliDocumentChild, CanBeDocumentChild, XbrliNode, Node, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XbrliElem
  2. SubtypeAwareElemLike
  3. SubtypeAwareElemApi
  4. ScopedElemLike
  5. ClarkElemLike
  6. HasText
  7. HasEName
  8. IsNavigable
  9. ElemLike
  10. ScopedElemApi
  11. HasScopeApi
  12. HasQNameApi
  13. ClarkElemApi
  14. HasTextApi
  15. HasENameApi
  16. IsNavigableApi
  17. ElemApi
  18. AnyElemApi
  19. Elem
  20. CanBeXbrliDocumentChild
  21. CanBeDocumentChild
  22. XbrliNode
  23. Node
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type ThisElem = XbrliElem

    Permalink
    Definition Classes
    XbrliElem → 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: Iterable[(QName, String)]

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

    Permalink
  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def equals(other: Any): Boolean

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

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

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

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

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

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

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

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

    Permalink

    Very fast implementation of findAllChildElems, for fast querying

    Very fast implementation of findAllChildElems, for fast querying

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    IsNavigable → IsNavigableApi
  54. final def hashCode(): Int

    Permalink
    Definition Classes
    XbrliElem → AnyRef → Any
  55. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  56. final def localName: String

    Permalink
    Definition Classes
    HasEName → HasENameApi
  57. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  58. final def normalizedText: String

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

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

    Permalink
    Definition Classes
    AnyRef
  61. final def qname: QName

    Permalink
    Definition Classes
    XbrliElem → HasQNameApi
  62. final def resolvedAttributes: Iterable[(EName, String)]

    Permalink
    Definition Classes
    XbrliElem → HasENameApi
  63. final def resolvedName: EName

    Permalink
    Definition Classes
    XbrliElem → HasENameApi
  64. final def scope: Scope

    Permalink
    Definition Classes
    XbrliElem → HasScopeApi
  65. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  66. final def text: String

    Permalink
    Definition Classes
    XbrliElem → HasTextApi
  67. final def textAsQName: QName

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

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

    Permalink
    Definition Classes
    XbrliElem → AnyElemApi
  70. def toString(): String

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

    Permalink
    Definition Classes
    HasText → HasTextApi
  72. final def wait(): Unit

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

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

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

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 CanBeXbrliDocumentChild

Inherited from CanBeDocumentChild

Inherited from XbrliNode

Inherited from Node

Inherited from AnyRef

Inherited from Any

Ungrouped