Trait

eu.cdevreeze.tqa.base.queryapi

TaxonomySchemaApi

Related Doc: package queryapi

Permalink

trait TaxonomySchemaApi extends SchemaApi

Purely abstract trait offering a dimensionally-aware XBRL taxonomy schema API.

See super-type SchemaApi for more information.

Primary item declarations are concept declarations that are neither hypercubes nor dimensions, regardless of whether they are used as primary items or domain members!

Linear Supertypes
SchemaApi, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TaxonomySchemaApi
  2. SchemaApi
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def filterConceptDeclarations(p: (ConceptDeclaration) ⇒ Boolean): IndexedSeq[ConceptDeclaration]

    Permalink
  2. abstract def filterDimensionDeclarations(p: (DimensionDeclaration) ⇒ Boolean): IndexedSeq[DimensionDeclaration]

    Permalink
  3. abstract def filterExplicitDimensionDeclarations(p: (ExplicitDimensionDeclaration) ⇒ Boolean): IndexedSeq[ExplicitDimensionDeclaration]

    Permalink
  4. abstract def filterGlobalAttributeDeclarations(p: (GlobalAttributeDeclaration) ⇒ Boolean): IndexedSeq[GlobalAttributeDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  5. abstract def filterGlobalElementDeclarations(p: (GlobalElementDeclaration) ⇒ Boolean): IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  6. abstract def filterGlobalElementDeclarationsOnOwnOrInheritedSubstitutionGroup(sg: EName): IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  7. abstract def filterGlobalElementDeclarationsOnOwnSubstitutionGroup(p: (EName) ⇒ Boolean): IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  8. abstract def filterHypercubeDeclarations(p: (HypercubeDeclaration) ⇒ Boolean): IndexedSeq[HypercubeDeclaration]

    Permalink
  9. abstract def filterItemDeclarations(p: (ItemDeclaration) ⇒ Boolean): IndexedSeq[ItemDeclaration]

    Permalink
  10. abstract def filterNamedComplexTypeDefinitions(p: (NamedComplexTypeDefinition) ⇒ Boolean): IndexedSeq[NamedComplexTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  11. abstract def filterNamedSimpleTypeDefinitions(p: (NamedSimpleTypeDefinition) ⇒ Boolean): IndexedSeq[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  12. abstract def filterNamedTypeDefinitions(p: (NamedTypeDefinition) ⇒ Boolean): IndexedSeq[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  13. abstract def filterPrimaryItemDeclarations(p: (PrimaryItemDeclaration) ⇒ Boolean): IndexedSeq[PrimaryItemDeclaration]

    Permalink
  14. abstract def filterTupleDeclarations(p: (TupleDeclaration) ⇒ Boolean): IndexedSeq[TupleDeclaration]

    Permalink
  15. abstract def filterTypedDimensionDeclarations(p: (TypedDimensionDeclaration) ⇒ Boolean): IndexedSeq[TypedDimensionDeclaration]

    Permalink
  16. abstract def filterXsdSchemas(p: (XsdSchema) ⇒ Boolean): IndexedSeq[XsdSchema]

    Permalink

    Returns schema root elements obeying some predicate.

    Returns schema root elements obeying some predicate. To find certain taxonomy schema elements, the following pattern can be used:

    filterXsdSchemas(p).flatMap(_.filterElemsOrSelfOfType(classTag[E])(pred))
    Definition Classes
    SchemaApi
  17. abstract def findAllConceptDeclarations: IndexedSeq[ConceptDeclaration]

    Permalink
  18. abstract def findAllDimensionDeclarations: IndexedSeq[DimensionDeclaration]

    Permalink
  19. abstract def findAllExplicitDimensionDeclarations: IndexedSeq[ExplicitDimensionDeclaration]

    Permalink
  20. abstract def findAllGlobalAttributeDeclarations: IndexedSeq[GlobalAttributeDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  21. abstract def findAllGlobalElementDeclarations: IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  22. abstract def findAllHypercubeDeclarations: IndexedSeq[HypercubeDeclaration]

    Permalink
  23. abstract def findAllItemDeclarations: IndexedSeq[ItemDeclaration]

    Permalink
  24. abstract def findAllNamedComplexTypeDefinitions: IndexedSeq[NamedComplexTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  25. abstract def findAllNamedSimpleTypeDefinitions: IndexedSeq[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  26. abstract def findAllNamedTypeDefinitions: IndexedSeq[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  27. abstract def findAllPrimaryItemDeclarations: IndexedSeq[PrimaryItemDeclaration]

    Permalink
  28. abstract def findAllTupleDeclarations: IndexedSeq[TupleDeclaration]

    Permalink
  29. abstract def findAllTypedDimensionDeclarations: IndexedSeq[TypedDimensionDeclaration]

    Permalink
  30. abstract def findAllXsdSchemas: IndexedSeq[XsdSchema]

    Permalink

    Returns the schema root elements.

    Returns the schema root elements. To find certain taxonomy schema elements, the following pattern can be used:

    findAllXsdSchemas.flatMap(_.filterElemsOrSelfOfType(classTag[E])(pred))
    Definition Classes
    SchemaApi
  31. abstract def findBaseTypeOrSelfUntil(typeEName: EName, p: (EName) ⇒ Boolean): Option[EName]

    Permalink

    If the given type obeys the type predicate, returns it, wrapped in an Option.

    If the given type obeys the type predicate, returns it, wrapped in an Option. Otherwise, returns the optional base type if that type obeys the type predicate, and so on, until either the predicate holds or no further base type can be found in the taxonomy.

    Definition Classes
    SchemaApi
  32. abstract def findConceptDeclaration(ename: EName): Option[ConceptDeclaration]

    Permalink
  33. abstract def findConceptDeclaration(p: (ConceptDeclaration) ⇒ Boolean): Option[ConceptDeclaration]

    Permalink
  34. abstract def findDimensionDeclaration(ename: EName): Option[DimensionDeclaration]

    Permalink
  35. abstract def findDimensionDeclaration(p: (DimensionDeclaration) ⇒ Boolean): Option[DimensionDeclaration]

    Permalink
  36. abstract def findExplicitDimensionDeclaration(ename: EName): Option[ExplicitDimensionDeclaration]

    Permalink
  37. abstract def findExplicitDimensionDeclaration(p: (ExplicitDimensionDeclaration) ⇒ Boolean): Option[ExplicitDimensionDeclaration]

    Permalink
  38. abstract def findGlobalAttributeDeclaration(ename: EName): Option[GlobalAttributeDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  39. abstract def findGlobalAttributeDeclaration(p: (GlobalAttributeDeclaration) ⇒ Boolean): Option[GlobalAttributeDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  40. abstract def findGlobalElementDeclaration(ename: EName): Option[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  41. abstract def findGlobalElementDeclaration(p: (GlobalElementDeclaration) ⇒ Boolean): Option[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  42. abstract def findGlobalElementDeclarationByUri(uri: URI): Option[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi
  43. abstract def findHypercubeDeclaration(ename: EName): Option[HypercubeDeclaration]

    Permalink
  44. abstract def findHypercubeDeclaration(p: (HypercubeDeclaration) ⇒ Boolean): Option[HypercubeDeclaration]

    Permalink
  45. abstract def findItemDeclaration(ename: EName): Option[ItemDeclaration]

    Permalink
  46. abstract def findItemDeclaration(p: (ItemDeclaration) ⇒ Boolean): Option[ItemDeclaration]

    Permalink
  47. abstract def findMemberDeclarationOfTypedDimension(typedDimension: EName): Option[GlobalElementDeclaration]

    Permalink
  48. abstract def findNamedComplexTypeDefinition(ename: EName): Option[NamedComplexTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  49. abstract def findNamedComplexTypeDefinition(p: (NamedComplexTypeDefinition) ⇒ Boolean): Option[NamedComplexTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  50. abstract def findNamedSimpleTypeDefinition(ename: EName): Option[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  51. abstract def findNamedSimpleTypeDefinition(p: (NamedSimpleTypeDefinition) ⇒ Boolean): Option[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  52. abstract def findNamedTypeDefinition(ename: EName): Option[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  53. abstract def findNamedTypeDefinition(p: (NamedTypeDefinition) ⇒ Boolean): Option[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi
  54. abstract def findPrimaryItemDeclaration(ename: EName): Option[PrimaryItemDeclaration]

    Permalink
  55. abstract def findPrimaryItemDeclaration(p: (PrimaryItemDeclaration) ⇒ Boolean): Option[PrimaryItemDeclaration]

    Permalink
  56. abstract def findTupleDeclaration(ename: EName): Option[TupleDeclaration]

    Permalink
  57. abstract def findTupleDeclaration(p: (TupleDeclaration) ⇒ Boolean): Option[TupleDeclaration]

    Permalink
  58. abstract def findTypedDimensionDeclaration(ename: EName): Option[TypedDimensionDeclaration]

    Permalink
  59. abstract def findTypedDimensionDeclaration(p: (TypedDimensionDeclaration) ⇒ Boolean): Option[TypedDimensionDeclaration]

    Permalink
  60. abstract def findXsdSchema(p: (XsdSchema) ⇒ Boolean): Option[XsdSchema]

    Permalink

    Finds an optional schema root element obeying some predicate.

    Finds an optional schema root element obeying some predicate. To find certain taxonomy schema elements, the following pattern can be used:

    findXsdSchema(p).toIndexedSeq.flatMap(_.filterElemsOrSelfOfType(classTag[E])(pred))
    Definition Classes
    SchemaApi
  61. abstract def getConceptDeclaration(ename: EName): ConceptDeclaration

    Permalink
  62. abstract def getDimensionDeclaration(ename: EName): DimensionDeclaration

    Permalink
  63. abstract def getExplicitDimensionDeclaration(ename: EName): ExplicitDimensionDeclaration

    Permalink
  64. abstract def getGlobalAttributeDeclaration(ename: EName): GlobalAttributeDeclaration

    Permalink
    Definition Classes
    SchemaApi
  65. abstract def getGlobalElementDeclaration(ename: EName): GlobalElementDeclaration

    Permalink
    Definition Classes
    SchemaApi
  66. abstract def getGlobalElementDeclarationByUri(uri: URI): GlobalElementDeclaration

    Permalink
    Definition Classes
    SchemaApi
  67. abstract def getHypercubeDeclaration(ename: EName): HypercubeDeclaration

    Permalink
  68. abstract def getItemDeclaration(ename: EName): ItemDeclaration

    Permalink
  69. abstract def getMemberDeclarationOfTypedDimension(typedDimension: EName): GlobalElementDeclaration

    Permalink
  70. abstract def getNamedComplexTypeDefinition(ename: EName): NamedComplexTypeDefinition

    Permalink
    Definition Classes
    SchemaApi
  71. abstract def getNamedSimpleTypeDefinition(ename: EName): NamedSimpleTypeDefinition

    Permalink
    Definition Classes
    SchemaApi
  72. abstract def getNamedTypeDefinition(ename: EName): NamedTypeDefinition

    Permalink
    Definition Classes
    SchemaApi
  73. abstract def getPrimaryItemDeclaration(ename: EName): PrimaryItemDeclaration

    Permalink
  74. abstract def getTupleDeclaration(ename: EName): TupleDeclaration

    Permalink
  75. abstract def getTypedDimensionDeclaration(ename: EName): TypedDimensionDeclaration

    Permalink
  76. abstract def substitutionGroupMap: SubstitutionGroupMap

    Permalink

    Returns the known substitution groups as SubstitutionGroupMap.

    Returns the known substitution groups as SubstitutionGroupMap. If the taxonomy is closed under DTS discovery, these substitution groups are found within the taxonomy. Otherwise they may partly be external.

    Implementations should store this as a field, in order to make substitution group lookups as fast as possible.

    Definition Classes
    SchemaApi

Concrete 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 asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

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

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

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

Inherited from SchemaApi

Inherited from AnyRef

Inherited from Any

Ungrouped