Trait

eu.cdevreeze.tqa.base.queryapi

TaxonomyApi

Related Doc: package queryapi

Permalink

trait TaxonomyApi extends TaxonomySchemaApi with StandardRelationshipContainerApi with NonStandardRelationshipContainerApi with InterConceptRelationshipContainerApi with PresentationRelationshipContainerApi with ConceptLabelRelationshipContainerApi with ConceptReferenceRelationshipContainerApi with ElementLabelRelationshipContainerApi with ElementReferenceRelationshipContainerApi with DimensionalRelationshipContainerApi

Purely abstract trait offering a taxonomy query API. It combines several other purely abstract query API traits. The query API concerns the taxonomy as taxonomy schema, and as container of relationships, standard relationships, inter-concept relationships and dimensional relationships.

Linear Supertypes
DimensionalRelationshipContainerApi, ElementReferenceRelationshipContainerApi, ElementLabelRelationshipContainerApi, ConceptReferenceRelationshipContainerApi, ConceptLabelRelationshipContainerApi, PresentationRelationshipContainerApi, InterConceptRelationshipContainerApi, NonStandardRelationshipContainerApi, StandardRelationshipContainerApi, TaxonomySchemaApi, SchemaApi, AnyRef, Any
Known Subclasses
BasicTaxonomy, TaxonomyLike
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TaxonomyApi
  2. DimensionalRelationshipContainerApi
  3. ElementReferenceRelationshipContainerApi
  4. ElementLabelRelationshipContainerApi
  5. ConceptReferenceRelationshipContainerApi
  6. ConceptLabelRelationshipContainerApi
  7. PresentationRelationshipContainerApi
  8. InterConceptRelationshipContainerApi
  9. NonStandardRelationshipContainerApi
  10. StandardRelationshipContainerApi
  11. TaxonomySchemaApi
  12. SchemaApi
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def computeFilteredHasHypercubeInheritance(p: (HasHypercubeRelationship) ⇒ Boolean): Map[EName, IndexedSeq[HasHypercubeRelationship]]

    Permalink

    Finds all inherited has-hypercubes per concept that pass the predicate.

    Finds all inherited has-hypercubes per concept that pass the predicate. See section 2.6.1 of the XBRL Dimensions specification.

    This is potentially an expensive bulk version of method findAllInheritedHasHypercubes, and should typically be called as few times as possible.

    Definition Classes
    DimensionalRelationshipContainerApi

  2. abstract def computeFilteredHasHypercubeInheritanceOrSelf(p: (HasHypercubeRelationship) ⇒ Boolean): Map[EName, IndexedSeq[HasHypercubeRelationship]]

    Permalink

    Finds all own or inherited has-hypercubes per concept that pass the predicate.

    Finds all own or inherited has-hypercubes per concept that pass the predicate. See section 2.6.1 of the XBRL Dimensions specification.

    This is potentially an expensive bulk version of method findAllOwnOrInheritedHasHypercubes, and should typically be called as few times as possible.

    Definition Classes
    DimensionalRelationshipContainerApi

  3. abstract def computeHasHypercubeInheritance: Map[EName, IndexedSeq[HasHypercubeRelationship]]

    Permalink

    Finds all inherited has-hypercubes per concept.

    Finds all inherited has-hypercubes per concept. See section 2.6.1 of the XBRL Dimensions specification.

    This is an expensive bulk version of method findAllInheritedHasHypercubes, and should be called as few times as possible.

    This function is equivalent to:

    computeFilteredHasHypercubeInheritance(_ => true)
    Definition Classes
    DimensionalRelationshipContainerApi

  4. abstract def computeHasHypercubeInheritanceForElr(elr: String): Map[EName, IndexedSeq[HasHypercubeRelationship]]

    Permalink

    Finds all inherited has-hypercubes per concept for the given ELR.

    Finds all inherited has-hypercubes per concept for the given ELR. See section 2.6.1 of the XBRL Dimensions specification.

    This is a rather expensive bulk version of method findAllInheritedHasHypercubes, and should be called as few times as possible.

    This function is equivalent to:

    computeFilteredHasHypercubeInheritance(_.elr == elr)
    Definition Classes
    DimensionalRelationshipContainerApi

  5. abstract def computeHasHypercubeInheritanceForElrReturningPrimaries(elr: String): Map[EName, Set[EName]]

    Permalink

    Finds all inherited has-hypercubes per concept, for the given ELR, returning Sets of all primaries that are source concepts of the has-hypercube relationships with that ELR.

    Finds all inherited has-hypercubes per concept, for the given ELR, returning Sets of all primaries that are source concepts of the has-hypercube relationships with that ELR. See section 2.6.1 of the XBRL Dimensions specification.

    This is a rather expensive bulk version of method findAllInheritedHasHypercubesAsElrToPrimariesMap, and should be called as few times as possible.

    Definition Classes
    DimensionalRelationshipContainerApi

  6. abstract def computeHasHypercubeInheritanceOrSelf: Map[EName, IndexedSeq[HasHypercubeRelationship]]

    Permalink

    Finds all own or inherited has-hypercubes per concept.

    Finds all own or inherited has-hypercubes per concept. See section 2.6.1 of the XBRL Dimensions specification.

    This is an expensive bulk version of method findAllOwnOrInheritedHasHypercubes, and should be called as few times as possible.

    This function is equivalent to:

    computeFilteredHasHypercubeInheritanceOrSelf(_ => true)
    Definition Classes
    DimensionalRelationshipContainerApi

  7. abstract def computeHasHypercubeInheritanceOrSelfForElr(elr: String): Map[EName, IndexedSeq[HasHypercubeRelationship]]

    Permalink

    Finds all own or inherited has-hypercubes per concept for the given ELR.

    Finds all own or inherited has-hypercubes per concept for the given ELR. See section 2.6.1 of the XBRL Dimensions specification.

    This is a rather expensive bulk version of method findAllOwnOrInheritedHasHypercubes, and should be called as few times as possible.

    This function is equivalent to:

    computeFilteredHasHypercubeInheritanceOrSelf(_.elr == elr)
    Definition Classes
    DimensionalRelationshipContainerApi

  8. abstract def computeHasHypercubeInheritanceOrSelfForElrReturningPrimaries(elr: String): Map[EName, Set[EName]]

    Permalink

    Finds all own or inherited has-hypercubes per concept, for the given ELR, returning Sets of all primaries that are source concepts of the has-hypercube relationships with that ELR.

    Finds all own or inherited has-hypercubes per concept, for the given ELR, returning Sets of all primaries that are source concepts of the has-hypercube relationships with that ELR. See section 2.6.1 of the XBRL Dimensions specification.

    This is a rather expensive bulk version of method findAllOwnOrInheritedHasHypercubesAsElrToPrimariesMap, and should be called as few times as possible.

    Definition Classes
    DimensionalRelationshipContainerApi

  9. abstract def computeHasHypercubeInheritanceOrSelfReturningElrToPrimariesMaps: Map[EName, Map[String, Set[EName]]]

    Permalink

    Finds all own or inherited has-hypercubes per concept returning Maps from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR.

    Finds all own or inherited has-hypercubes per concept returning Maps from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR. See section 2.6.1 of the XBRL Dimensions specification.

    This is an expensive bulk version of method findAllOwnOrInheritedHasHypercubesAsElrToPrimariesMap, and should be called as few times as possible.

    Definition Classes
    DimensionalRelationshipContainerApi

  10. abstract def computeHasHypercubeInheritanceReturningElrToPrimariesMaps: Map[EName, Map[String, Set[EName]]]

    Permalink

    Finds all inherited has-hypercubes per concept returning Maps from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR.

    Finds all inherited has-hypercubes per concept returning Maps from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR. See section 2.6.1 of the XBRL Dimensions specification.

    This is an expensive bulk version of method findAllInheritedHasHypercubesAsElrToPrimariesMap, and should be called as few times as possible.

    Definition Classes
    DimensionalRelationshipContainerApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

  12. abstract def filterConceptLabelRelationships(p: (ConceptLabelRelationship) ⇒ Boolean): IndexedSeq[ConceptLabelRelationship]

    Permalink
    Definition Classes
    ConceptLabelRelationshipContainerApi

  13. abstract def filterConceptReferenceRelationships(p: (ConceptReferenceRelationship) ⇒ Boolean): IndexedSeq[ConceptReferenceRelationship]

    Permalink
    Definition Classes
    ConceptReferenceRelationshipContainerApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

  15. abstract def filterDimensionDefaultRelationships(p: (DimensionDefaultRelationship) ⇒ Boolean): IndexedSeq[DimensionDefaultRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  16. abstract def filterDimensionDomainRelationships(p: (DimensionDomainRelationship) ⇒ Boolean): IndexedSeq[DimensionDomainRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  17. abstract def filterDimensionalRelationships(p: (DimensionalRelationship) ⇒ Boolean): IndexedSeq[DimensionalRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  18. abstract def filterDimensionalRelationshipsOfType[A <: DimensionalRelationship](relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  19. abstract def filterDomainMemberRelationships(p: (DomainMemberRelationship) ⇒ Boolean): IndexedSeq[DomainMemberRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  20. abstract def filterElementLabelRelationships(p: (ElementLabelRelationship) ⇒ Boolean): IndexedSeq[ElementLabelRelationship]

    Permalink
    Definition Classes
    ElementLabelRelationshipContainerApi

  21. abstract def filterElementReferenceRelationships(p: (ElementReferenceRelationship) ⇒ Boolean): IndexedSeq[ElementReferenceRelationship]

    Permalink
    Definition Classes
    ElementReferenceRelationshipContainerApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    SchemaApi

  24. abstract def filterGlobalElementDeclarations(p: (GlobalElementDeclaration) ⇒ Boolean): IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  25. abstract def filterGlobalElementDeclarationsOnOwnOrInheritedSubstitutionGroup(sg: EName): IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  26. abstract def filterGlobalElementDeclarationsOnOwnSubstitutionGroup(p: (EName) ⇒ Boolean): IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  27. abstract def filterHasHypercubeRelationships(p: (HasHypercubeRelationship) ⇒ Boolean): IndexedSeq[HasHypercubeRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  28. abstract def filterHypercubeDeclarations(p: (HypercubeDeclaration) ⇒ Boolean): IndexedSeq[HypercubeDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  29. abstract def filterHypercubeDimensionRelationships(p: (HypercubeDimensionRelationship) ⇒ Boolean): IndexedSeq[HypercubeDimensionRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  30. abstract def filterIncomingConsecutiveDomainAwareRelationshipPaths(targetConcept: EName)(p: (DomainAwareRelationshipPath) ⇒ Boolean): IndexedSeq[DomainAwareRelationshipPath]

    Permalink

    Filters the consecutive (!) dimension-domain-or-domain-member relationship paths that are incoming to the given concept.

    Filters the consecutive (!) dimension-domain-or-domain-member relationship paths that are incoming to the given concept. Only relationship paths for which all (non-empty) "tails" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    Definition Classes
    DimensionalRelationshipContainerApi

  31. abstract def filterIncomingConsecutiveDomainMemberRelationshipPaths(targetConcept: EName)(p: (DomainMemberRelationshipPath) ⇒ Boolean): IndexedSeq[DomainMemberRelationshipPath]

    Permalink

    Filters the consecutive (!) domain-member relationship paths that are incoming to the given concept.

    Filters the consecutive (!) domain-member relationship paths that are incoming to the given concept. Only relationship paths for which all (non-empty) "tails" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    Definition Classes
    DimensionalRelationshipContainerApi

  32. abstract def filterIncomingConsecutiveInterConceptRelationshipPaths[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Calls method filterIncomingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Calls method filterIncomingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Typically this method should be preferred over method filterIncomingUnrestrictedInterConceptRelationshipPaths.

    Definition Classes
    InterConceptRelationshipContainerApi

  33. abstract def filterIncomingConsecutiveParentChildRelationshipPaths(targetConcept: EName)(p: (ParentChildRelationshipPath) ⇒ Boolean): IndexedSeq[ParentChildRelationshipPath]

    Permalink

    Filters the consecutive (!) parent-child relationship paths that are incoming to the given concept.

    Filters the consecutive (!) parent-child relationship paths that are incoming to the given concept. Only relationship paths for which all (non-empty) "tails" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    Definition Classes
    PresentationRelationshipContainerApi

  34. abstract def filterIncomingDomainAwareRelationships(targetConcept: EName)(p: (DomainAwareRelationship) ⇒ Boolean): IndexedSeq[DomainAwareRelationship]

    Permalink

    Filters "domain-aware" relationships that are incoming to the given concept.

    Filters "domain-aware" relationships that are incoming to the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  35. abstract def filterIncomingDomainMemberRelationships(targetConcept: EName)(p: (DomainMemberRelationship) ⇒ Boolean): IndexedSeq[DomainMemberRelationship]

    Permalink

    Filters domain-member relationships that are incoming to the given concept.

    Filters domain-member relationships that are incoming to the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  36. abstract def filterIncomingInterConceptRelationships(targetConcept: EName)(p: (InterConceptRelationship) ⇒ Boolean): IndexedSeq[InterConceptRelationship]

    Permalink

    Filters inter-concept relationships that are incoming to the given concept.

    Filters inter-concept relationships that are incoming to the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  37. abstract def filterIncomingInterConceptRelationshipsOfType[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink

    Filters inter-concept relationships of the given type that are incoming to the given concept.

    Filters inter-concept relationships of the given type that are incoming to the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  38. abstract def filterIncomingParentChildRelationships(targetConcept: EName)(p: (ParentChildRelationship) ⇒ Boolean): IndexedSeq[ParentChildRelationship]

    Permalink

    Filters parent-child relationships that are incoming to the given concept.

    Filters parent-child relationships that are incoming to the given concept.

    Definition Classes
    PresentationRelationshipContainerApi

  39. abstract def filterIncomingUnrestrictedInterConceptRelationshipPaths[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Filters the inter-concept relationship paths that are incoming to the given concept and whose relationships are of the given type.

    Filters the inter-concept relationship paths that are incoming to the given concept and whose relationships are of the given type. Only relationship paths for which all (non-empty) "tails" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    This method can be useful for finding relationship paths that are not consecutive and therefore not allowed, when we do not yet know that the taxonomy is XBRL-valid.

    This is a very general method that is used to implement specific methods in more specific relationship query API traits. Typically prefer method filterIncomingConsecutiveInterConceptRelationshipPaths instead.

    Definition Classes
    InterConceptRelationshipContainerApi

  40. abstract def filterInterConceptRelationships(p: (InterConceptRelationship) ⇒ Boolean): IndexedSeq[InterConceptRelationship]

    Permalink
    Definition Classes
    InterConceptRelationshipContainerApi

  41. abstract def filterInterConceptRelationshipsOfType[A <: InterConceptRelationship](relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink
    Definition Classes
    InterConceptRelationshipContainerApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    SchemaApi

  44. abstract def filterNamedSimpleTypeDefinitions(p: (NamedSimpleTypeDefinition) ⇒ Boolean): IndexedSeq[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  45. abstract def filterNamedTypeDefinitions(p: (NamedTypeDefinition) ⇒ Boolean): IndexedSeq[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  46. abstract def filterNonStandardRelationships(p: (NonStandardRelationship) ⇒ Boolean): IndexedSeq[NonStandardRelationship]

    Permalink
    Definition Classes
    NonStandardRelationshipContainerApi

  47. abstract def filterNonStandardRelationshipsOfType[A <: NonStandardRelationship](relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink
    Definition Classes
    NonStandardRelationshipContainerApi

  48. abstract def filterOutgoingConceptLabelRelationships(sourceConcept: EName)(p: (ConceptLabelRelationship) ⇒ Boolean): IndexedSeq[ConceptLabelRelationship]

    Permalink

    Filters concept-label relationships that are outgoing from the given concept.

    Filters concept-label relationships that are outgoing from the given concept.

    Definition Classes
    ConceptLabelRelationshipContainerApi

  49. abstract def filterOutgoingConceptReferenceRelationships(sourceConcept: EName)(p: (ConceptReferenceRelationship) ⇒ Boolean): IndexedSeq[ConceptReferenceRelationship]

    Permalink

    Filters concept-reference relationships that are outgoing from the given concept.

    Filters concept-reference relationships that are outgoing from the given concept.

    Definition Classes
    ConceptReferenceRelationshipContainerApi

  50. abstract def filterOutgoingConsecutiveDomainAwareRelationshipPaths(sourceConcept: EName)(p: (DomainAwareRelationshipPath) ⇒ Boolean): IndexedSeq[DomainAwareRelationshipPath]

    Permalink

    Filters the consecutive (!) dimension-domain-or-domain-member relationship paths that are outgoing from the given concept.

    Filters the consecutive (!) dimension-domain-or-domain-member relationship paths that are outgoing from the given concept. Only relationship paths for which all (non-empty) "inits" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    Definition Classes
    DimensionalRelationshipContainerApi

  51. abstract def filterOutgoingConsecutiveDomainMemberRelationshipPaths(sourceConcept: EName)(p: (DomainMemberRelationshipPath) ⇒ Boolean): IndexedSeq[DomainMemberRelationshipPath]

    Permalink

    Filters the consecutive (!) domain-member relationship paths that are outgoing from the given concept.

    Filters the consecutive (!) domain-member relationship paths that are outgoing from the given concept. Only relationship paths for which all (non-empty) "inits" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    Definition Classes
    DimensionalRelationshipContainerApi

  52. abstract def filterOutgoingConsecutiveInterConceptRelationshipPaths[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Calls method filterOutgoingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Calls method filterOutgoingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Typically this method should be preferred over method filterOutgoingUnrestrictedInterConceptRelationshipPaths.

    Definition Classes
    InterConceptRelationshipContainerApi

  53. abstract def filterOutgoingConsecutiveParentChildRelationshipPaths(sourceConcept: EName)(p: (ParentChildRelationshipPath) ⇒ Boolean): IndexedSeq[ParentChildRelationshipPath]

    Permalink

    Filters the consecutive (!) parent-child relationship paths that are outgoing from the given concept.

    Filters the consecutive (!) parent-child relationship paths that are outgoing from the given concept. Only relationship paths for which all (non-empty) "inits" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    Definition Classes
    PresentationRelationshipContainerApi

  54. abstract def filterOutgoingDimensionDefaultRelationships(sourceConcept: EName)(p: (DimensionDefaultRelationship) ⇒ Boolean): IndexedSeq[DimensionDefaultRelationship]

    Permalink

    Filters dimension-default relationships that are outgoing from the given concept.

    Filters dimension-default relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  55. abstract def filterOutgoingDimensionDefaultRelationshipsOnElr(sourceConcept: EName, elr: String): IndexedSeq[DimensionDefaultRelationship]

    Permalink

    Filters dimension-default relationships that are outgoing from the given concept on the given ELR.

    Filters dimension-default relationships that are outgoing from the given concept on the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  56. abstract def filterOutgoingDimensionDomainRelationships(sourceConcept: EName)(p: (DimensionDomainRelationship) ⇒ Boolean): IndexedSeq[DimensionDomainRelationship]

    Permalink

    Filters dimension-domain relationships that are outgoing from the given concept.

    Filters dimension-domain relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  57. abstract def filterOutgoingDimensionDomainRelationshipsOnElr(sourceConcept: EName, elr: String): IndexedSeq[DimensionDomainRelationship]

    Permalink

    Filters dimension-domain relationships that are outgoing from the given concept on the given ELR.

    Filters dimension-domain relationships that are outgoing from the given concept on the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  58. abstract def filterOutgoingDomainMemberRelationships(sourceConcept: EName)(p: (DomainMemberRelationship) ⇒ Boolean): IndexedSeq[DomainMemberRelationship]

    Permalink

    Filters domain-member relationships that are outgoing from the given concept.

    Filters domain-member relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  59. abstract def filterOutgoingDomainMemberRelationshipsOnElr(sourceConcept: EName, elr: String): IndexedSeq[DomainMemberRelationship]

    Permalink

    Filters domain-member relationships that are outgoing from the given concept on the given ELR.

    Filters domain-member relationships that are outgoing from the given concept on the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  60. abstract def filterOutgoingElementLabelRelationships(sourceKey: XmlFragmentKey)(p: (ElementLabelRelationship) ⇒ Boolean): IndexedSeq[ElementLabelRelationship]

    Permalink

    Filters element-label relationships that are outgoing from the given XML element.

    Filters element-label relationships that are outgoing from the given XML element.

    Definition Classes
    ElementLabelRelationshipContainerApi

  61. abstract def filterOutgoingElementReferenceRelationships(sourceKey: XmlFragmentKey)(p: (ElementReferenceRelationship) ⇒ Boolean): IndexedSeq[ElementReferenceRelationship]

    Permalink

    Filters element-reference relationships that are outgoing from the given XML element.

    Filters element-reference relationships that are outgoing from the given XML element.

    Definition Classes
    ElementReferenceRelationshipContainerApi

  62. abstract def filterOutgoingHasHypercubeRelationships(sourceConcept: EName)(p: (HasHypercubeRelationship) ⇒ Boolean): IndexedSeq[HasHypercubeRelationship]

    Permalink

    Filters has-hypercube relationships that are outgoing from the given concept.

    Filters has-hypercube relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  63. abstract def filterOutgoingHasHypercubeRelationshipsOnElr(sourceConcept: EName, elr: String): IndexedSeq[HasHypercubeRelationship]

    Permalink

    Filters has-hypercube relationships that are outgoing from the given concept on the given ELR.

    Filters has-hypercube relationships that are outgoing from the given concept on the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  64. abstract def filterOutgoingHypercubeDimensionRelationships(sourceConcept: EName)(p: (HypercubeDimensionRelationship) ⇒ Boolean): IndexedSeq[HypercubeDimensionRelationship]

    Permalink

    Filters hypercube-dimension relationships that are outgoing from the given concept.

    Filters hypercube-dimension relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  65. abstract def filterOutgoingHypercubeDimensionRelationshipsOnElr(sourceConcept: EName, elr: String): IndexedSeq[HypercubeDimensionRelationship]

    Permalink

    Filters hypercube-dimension relationships that are outgoing from the given concept on the given ELR.

    Filters hypercube-dimension relationships that are outgoing from the given concept on the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  66. abstract def filterOutgoingInterConceptRelationships(sourceConcept: EName)(p: (InterConceptRelationship) ⇒ Boolean): IndexedSeq[InterConceptRelationship]

    Permalink

    Filters inter-concept relationships that are outgoing from the given concept.

    Filters inter-concept relationships that are outgoing from the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  67. abstract def filterOutgoingInterConceptRelationshipsOfType[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink

    Filters inter-concept relationships of the given type that are outgoing from the given concept.

    Filters inter-concept relationships of the given type that are outgoing from the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  68. abstract def filterOutgoingNonStandardRelationships(sourceKey: XmlFragmentKey)(p: (NonStandardRelationship) ⇒ Boolean): IndexedSeq[NonStandardRelationship]

    Permalink

    Filters non-standard relationships that are outgoing from the given concept.

    Filters non-standard relationships that are outgoing from the given concept.

    Definition Classes
    NonStandardRelationshipContainerApi

  69. abstract def filterOutgoingNonStandardRelationshipsOfType[A <: NonStandardRelationship](sourceKey: XmlFragmentKey, relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink

    Filters non-standard relationships of the given type that are outgoing from the given XML element.

    Filters non-standard relationships of the given type that are outgoing from the given XML element.

    Definition Classes
    NonStandardRelationshipContainerApi

  70. abstract def filterOutgoingParentChildRelationships(sourceConcept: EName)(p: (ParentChildRelationship) ⇒ Boolean): IndexedSeq[ParentChildRelationship]

    Permalink

    Filters parent-child relationships that are outgoing from the given concept.

    Filters parent-child relationships that are outgoing from the given concept.

    Definition Classes
    PresentationRelationshipContainerApi

  71. abstract def filterOutgoingParentChildRelationshipsOnElr(sourceConcept: EName, elr: String): IndexedSeq[ParentChildRelationship]

    Permalink

    Filters parent-child relationships that are outgoing from the given concept on the given ELR.

    Filters parent-child relationships that are outgoing from the given concept on the given ELR.

    Definition Classes
    PresentationRelationshipContainerApi

  72. abstract def filterOutgoingStandardRelationships(sourceConcept: EName)(p: (StandardRelationship) ⇒ Boolean): IndexedSeq[StandardRelationship]

    Permalink

    Filters standard relationships that are outgoing from the given concept.

    Filters standard relationships that are outgoing from the given concept.

    Definition Classes
    StandardRelationshipContainerApi

  73. abstract def filterOutgoingStandardRelationshipsOfType[A <: StandardRelationship](sourceConcept: EName, relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink

    Filters standard relationships of the given type that are outgoing from the given concept.

    Filters standard relationships of the given type that are outgoing from the given concept.

    Definition Classes
    StandardRelationshipContainerApi

  74. abstract def filterOutgoingUnrestrictedInterConceptRelationshipPaths[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Filters the inter-concept relationship paths that are outgoing from the given concept and whose relationships are of the given type.

    Filters the inter-concept relationship paths that are outgoing from the given concept and whose relationships are of the given type. Only relationship paths for which all (non-empty) "inits" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    This method can be useful for finding relationship paths that are not consecutive and therefore not allowed, when we do not yet know that the taxonomy is XBRL-valid.

    This is a very general method that is used to implement specific methods in more specific relationship query API traits. Typically prefer method filterOutgoingConsecutiveInterConceptRelationshipPaths instead.

    Definition Classes
    InterConceptRelationshipContainerApi

  75. abstract def filterParentChildRelationships(p: (ParentChildRelationship) ⇒ Boolean): IndexedSeq[ParentChildRelationship]

    Permalink
    Definition Classes
    PresentationRelationshipContainerApi

  76. abstract def filterPresentationRelationshipsOfType[A <: PresentationRelationship](relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink
    Definition Classes
    PresentationRelationshipContainerApi

  77. abstract def filterPrimaryItemDeclarations(p: (PrimaryItemDeclaration) ⇒ Boolean): IndexedSeq[PrimaryItemDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  78. abstract def filterStandardRelationships(p: (StandardRelationship) ⇒ Boolean): IndexedSeq[StandardRelationship]

    Permalink
    Definition Classes
    StandardRelationshipContainerApi

  79. abstract def filterStandardRelationshipsOfType[A <: StandardRelationship](relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink
    Definition Classes
    StandardRelationshipContainerApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

  82. 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

  83. abstract def findAllConceptDeclarations: IndexedSeq[ConceptDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  84. abstract def findAllConceptLabelRelationships: IndexedSeq[ConceptLabelRelationship]

    Permalink
    Definition Classes
    ConceptLabelRelationshipContainerApi

  85. abstract def findAllConceptReferenceRelationships: IndexedSeq[ConceptReferenceRelationship]

    Permalink
    Definition Classes
    ConceptReferenceRelationshipContainerApi

  86. abstract def findAllConsecutiveDimensionDomainRelationships(relationship: HypercubeDimensionRelationship): IndexedSeq[DimensionDomainRelationship]

    Permalink

    Finds all consecutive dimension-domain relationships.

    Finds all consecutive dimension-domain relationships.

    This method is shorthand for:

    filterOutgoingDimensionDomainRelationships(relationship.targetConceptEName) { rel =>
  relationship.isFollowedBy(rel)
}
    Definition Classes
    DimensionalRelationshipContainerApi

  87. abstract def findAllConsecutiveDomainMemberRelationships(relationship: DomainAwareRelationship): IndexedSeq[DomainMemberRelationship]

    Permalink

    Finds all consecutive domain-member relationships.

    Finds all consecutive domain-member relationships.

    This method is shorthand for:

    filterOutgoingDomainMemberRelationships(relationship.targetConceptEName) { rel =>
  relationship.isFollowedBy(rel)
}
    Definition Classes
    DimensionalRelationshipContainerApi

  88. abstract def findAllConsecutiveHypercubeDimensionRelationships(relationship: HasHypercubeRelationship): IndexedSeq[HypercubeDimensionRelationship]

    Permalink

    Finds all consecutive hypercube-dimension relationships.

    Finds all consecutive hypercube-dimension relationships.

    This method is shorthand for:

    filterOutgoingHypercubeDimensionRelationships(relationship.targetConceptEName) { rel =>
  relationship.isFollowedBy(rel)
}
    Definition Classes
    DimensionalRelationshipContainerApi

  89. abstract def findAllConsecutiveInterConceptRelationshipsOfType[A <: InterConceptRelationship](relationship: InterConceptRelationship, resultRelationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all "following" ("consecutive") inter-concept relationships of the given result type.

    Finds all "following" ("consecutive") inter-concept relationships of the given result type.

    Two relationships "follow" each other if method InterConceptRelationship.isFollowedBy says so.

    Note that for non-dimensional relationships this implies that the parameter and result relationship types must be the same, or else no relationships are returned.

    This method is shorthand for:

    filterOutgoingInterConceptRelationshipsOfType(relationship.targetConceptEName, resultRelationshipType) { rel =>
  relationship.isFollowedBy(rel)
}
    Definition Classes
    InterConceptRelationshipContainerApi

  90. abstract def findAllConsecutiveParentChildRelationships(relationship: ParentChildRelationship): IndexedSeq[ParentChildRelationship]

    Permalink

    Finds all "following" ("consecutive") parent-child relationships.

    Finds all "following" ("consecutive") parent-child relationships.

    This method is shorthand for:

    filterOutgoingParentChildRelationships(relationship.targetConceptEName) { rel =>
  relationship.isFollowedBy(rel)
}
    Definition Classes
    PresentationRelationshipContainerApi

  91. abstract def findAllDimensionDeclarations: IndexedSeq[DimensionDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  92. abstract def findAllDimensionDefaultRelationships: IndexedSeq[DimensionDefaultRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  93. abstract def findAllDimensionDomainRelationships: IndexedSeq[DimensionDomainRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  94. abstract def findAllDimensionMembers(hasHypercubeRelationship: HasHypercubeRelationship): Map[EName, Set[EName]]

    Permalink

    Finds all (explicit) dimension members for the given has-hypercube relationship.

    Finds all (explicit) dimension members for the given has-hypercube relationship.

    Definition Classes
    DimensionalRelationshipContainerApi

  95. abstract def findAllDimensionalRelationships: IndexedSeq[DimensionalRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  96. abstract def findAllDimensionalRelationshipsOfType[A <: DimensionalRelationship](relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  97. abstract def findAllDomainMemberRelationships: IndexedSeq[DomainMemberRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  98. abstract def findAllElementLabelRelationships: IndexedSeq[ElementLabelRelationship]

    Permalink
    Definition Classes
    ElementLabelRelationshipContainerApi

  99. abstract def findAllElementReferenceRelationships: IndexedSeq[ElementReferenceRelationship]

    Permalink
    Definition Classes
    ElementReferenceRelationshipContainerApi

  100. abstract def findAllExplicitDimensionDeclarations: IndexedSeq[ExplicitDimensionDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  101. abstract def findAllGlobalAttributeDeclarations: IndexedSeq[GlobalAttributeDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  102. abstract def findAllGlobalElementDeclarations: IndexedSeq[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  103. abstract def findAllHasHypercubeRelationships: IndexedSeq[HasHypercubeRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  104. abstract def findAllHypercubeDeclarations: IndexedSeq[HypercubeDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  105. abstract def findAllHypercubeDimensionRelationships: IndexedSeq[HypercubeDimensionRelationship]

    Permalink
    Definition Classes
    DimensionalRelationshipContainerApi

  106. abstract def findAllIncomingConsecutiveDomainAwareRelationshipPaths(targetConcept: EName): IndexedSeq[DomainAwareRelationshipPath]

    Permalink

    Returns filterIncomingConsecutiveDomainAwareRelationshipPaths(targetConcept)(_ => true).

    Returns filterIncomingConsecutiveDomainAwareRelationshipPaths(targetConcept)(_ => true).

    Definition Classes
    DimensionalRelationshipContainerApi

  107. abstract def findAllIncomingConsecutiveDomainMemberRelationshipPaths(targetConcept: EName): IndexedSeq[DomainMemberRelationshipPath]

    Permalink

    Returns filterIncomingConsecutiveDomainMemberRelationshipPaths(targetConcept)(_ => true).

    Returns filterIncomingConsecutiveDomainMemberRelationshipPaths(targetConcept)(_ => true).

    Definition Classes
    DimensionalRelationshipContainerApi

  108. abstract def findAllIncomingConsecutiveParentChildRelationshipPaths(targetConcept: EName): IndexedSeq[ParentChildRelationshipPath]

    Permalink

    Returns filterIncomingConsecutiveParentChildRelationshipPaths(targetConcept)(_ => true).

    Returns filterIncomingConsecutiveParentChildRelationshipPaths(targetConcept)(_ => true).

    Definition Classes
    PresentationRelationshipContainerApi

  109. abstract def findAllIncomingDomainAwareRelationships(targetConcept: EName): IndexedSeq[DomainAwareRelationship]

    Permalink

    Finds all "domain-aware" relationships that are incoming to the given concept.

    Finds all "domain-aware" relationships that are incoming to the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  110. abstract def findAllIncomingDomainMemberRelationships(targetConcept: EName): IndexedSeq[DomainMemberRelationship]

    Permalink

    Finds all domain-member relationships that are incoming to the given concept.

    Finds all domain-member relationships that are incoming to the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  111. abstract def findAllIncomingInterConceptRelationships(targetConcept: EName): IndexedSeq[InterConceptRelationship]

    Permalink

    Finds all inter-concept relationships that are incoming to the given concept.

    Finds all inter-concept relationships that are incoming to the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  112. abstract def findAllIncomingInterConceptRelationshipsOfType[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all inter-concept relationships of the given type that are incoming to the given concept.

    Finds all inter-concept relationships of the given type that are incoming to the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  113. abstract def findAllIncomingParentChildRelationships(targetConcept: EName): IndexedSeq[ParentChildRelationship]

    Permalink

    Finds all parent-child relationships that are incoming to the given concept.

    Finds all parent-child relationships that are incoming to the given concept.

    Definition Classes
    PresentationRelationshipContainerApi

  114. abstract def findAllInheritedHasHypercubes(concept: EName): IndexedSeq[HasHypercubeRelationship]

    Permalink

    Finds all inherited has-hypercubes.

    Finds all inherited has-hypercubes. See section 2.6.1 of the XBRL Dimensions specification.

    Definition Classes
    DimensionalRelationshipContainerApi

  115. abstract def findAllInheritedHasHypercubesAsElrToPrimariesMap(concept: EName): Map[String, Set[EName]]

    Permalink

    Finds all inherited has-hypercubes as a Map from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR.

    Finds all inherited has-hypercubes as a Map from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR. See section 2.6.1 of the XBRL Dimensions specification.

    Definition Classes
    DimensionalRelationshipContainerApi

  116. abstract def findAllInterConceptRelationships: IndexedSeq[InterConceptRelationship]

    Permalink
    Definition Classes
    InterConceptRelationshipContainerApi

  117. abstract def findAllInterConceptRelationshipsOfType[A <: InterConceptRelationship](relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink
    Definition Classes
    InterConceptRelationshipContainerApi

  118. abstract def findAllItemDeclarations: IndexedSeq[ItemDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  119. abstract def findAllMembers(dimension: EName, domainElrPairs: Set[(EName, String)]): Set[EName]

    Permalink

    Finds all members in the given effective domain of the given dimension.

    Finds all members in the given effective domain of the given dimension.

    Definition Classes
    DimensionalRelationshipContainerApi

  120. abstract def findAllMembers(dimension: EName, domain: EName, dimensionDomainElr: String): Set[EName]

    Permalink

    Finds all members in the given dimension-domain.

    Finds all members in the given dimension-domain. There should be at most one dimension-domain relationship from the given dimension to the given domain, having the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  121. abstract def findAllNamedComplexTypeDefinitions: IndexedSeq[NamedComplexTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  122. abstract def findAllNamedSimpleTypeDefinitions: IndexedSeq[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  123. abstract def findAllNamedTypeDefinitions: IndexedSeq[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  124. abstract def findAllNonStandardRelationships: IndexedSeq[NonStandardRelationship]

    Permalink
    Definition Classes
    NonStandardRelationshipContainerApi

  125. abstract def findAllNonStandardRelationshipsOfType[A <: NonStandardRelationship](relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink
    Definition Classes
    NonStandardRelationshipContainerApi

  126. abstract def findAllNonUsableDimensionMembers(hasHypercubeRelationship: HasHypercubeRelationship): Map[EName, Set[EName]]

    Permalink

    Finds all non-usable (explicit) dimension members for the given has-hypercube relationship.

    Finds all non-usable (explicit) dimension members for the given has-hypercube relationship.

    Definition Classes
    DimensionalRelationshipContainerApi

  127. abstract def findAllNonUsableMembers(dimension: EName, domainElrPairs: Set[(EName, String)]): Set[EName]

    Permalink

    Finds all non-usable members in the given effective domain of the given dimension.

    Finds all non-usable members in the given effective domain of the given dimension. If a member is usable in one dimension-domain but not usable in another one, it is considered not usable.

    Definition Classes
    DimensionalRelationshipContainerApi

  128. abstract def findAllNonUsableMembers(dimension: EName, domain: EName, dimensionDomainElr: String): Set[EName]

    Permalink

    Finds all non-usable members in the given dimension-domain.

    Finds all non-usable members in the given dimension-domain. There should be at most one dimension-domain relationship from the given dimension to the given domain, having the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  129. abstract def findAllOutgoingConceptLabelRelationships(sourceConcept: EName): IndexedSeq[ConceptLabelRelationship]

    Permalink

    Finds all concept-label relationships that are outgoing from the given concept.

    Finds all concept-label relationships that are outgoing from the given concept.

    Definition Classes
    ConceptLabelRelationshipContainerApi

  130. abstract def findAllOutgoingConceptReferenceRelationships(sourceConcept: EName): IndexedSeq[ConceptReferenceRelationship]

    Permalink

    Finds all concept-reference relationships that are outgoing from the given concept.

    Finds all concept-reference relationships that are outgoing from the given concept.

    Definition Classes
    ConceptReferenceRelationshipContainerApi

  131. abstract def findAllOutgoingConsecutiveDomainAwareRelationshipPaths(sourceConcept: EName): IndexedSeq[DomainAwareRelationshipPath]

    Permalink

    Returns filterOutgoingConsecutiveDomainAwareRelationshipPaths(sourceConcept)(_ => true).

    Returns filterOutgoingConsecutiveDomainAwareRelationshipPaths(sourceConcept)(_ => true).

    Definition Classes
    DimensionalRelationshipContainerApi

  132. abstract def findAllOutgoingConsecutiveDomainMemberRelationshipPaths(sourceConcept: EName): IndexedSeq[DomainMemberRelationshipPath]

    Permalink

    Returns filterOutgoingConsecutiveDomainMemberRelationshipPaths(sourceConcept)(_ => true).

    Returns filterOutgoingConsecutiveDomainMemberRelationshipPaths(sourceConcept)(_ => true).

    Definition Classes
    DimensionalRelationshipContainerApi

  133. abstract def findAllOutgoingConsecutiveParentChildRelationshipPaths(sourceConcept: EName): IndexedSeq[ParentChildRelationshipPath]

    Permalink

    Returns filterOutgoingConsecutiveParentChildRelationshipPaths(sourceConcept)(_ => true).

    Returns filterOutgoingConsecutiveParentChildRelationshipPaths(sourceConcept)(_ => true).

    Definition Classes
    PresentationRelationshipContainerApi

  134. abstract def findAllOutgoingDimensionDefaultRelationships(sourceConcept: EName): IndexedSeq[DimensionDefaultRelationship]

    Permalink

    Finds all dimension-default relationships that are outgoing from the given concept.

    Finds all dimension-default relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  135. abstract def findAllOutgoingDimensionDomainRelationships(sourceConcept: EName): IndexedSeq[DimensionDomainRelationship]

    Permalink

    Finds all dimension-domain relationships that are outgoing from the given concept.

    Finds all dimension-domain relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  136. abstract def findAllOutgoingDomainMemberRelationships(sourceConcept: EName): IndexedSeq[DomainMemberRelationship]

    Permalink

    Finds all domain-member relationships that are outgoing from the given concept.

    Finds all domain-member relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  137. abstract def findAllOutgoingElementLabelRelationships(sourceKey: XmlFragmentKey): IndexedSeq[ElementLabelRelationship]

    Permalink

    Finds all element-label relationships that are outgoing from the given XML element.

    Finds all element-label relationships that are outgoing from the given XML element.

    Definition Classes
    ElementLabelRelationshipContainerApi

  138. abstract def findAllOutgoingElementReferenceRelationships(sourceKey: XmlFragmentKey): IndexedSeq[ElementReferenceRelationship]

    Permalink

    Finds all element-reference relationships that are outgoing from the given XML element.

    Finds all element-reference relationships that are outgoing from the given XML element.

    Definition Classes
    ElementReferenceRelationshipContainerApi

  139. abstract def findAllOutgoingHasHypercubeRelationships(sourceConcept: EName): IndexedSeq[HasHypercubeRelationship]

    Permalink

    Finds all has-hypercube relationships that are outgoing from the given concept.

    Finds all has-hypercube relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  140. abstract def findAllOutgoingHypercubeDimensionRelationships(sourceConcept: EName): IndexedSeq[HypercubeDimensionRelationship]

    Permalink

    Finds all hypercube-dimension relationships that are outgoing from the given concept.

    Finds all hypercube-dimension relationships that are outgoing from the given concept.

    Definition Classes
    DimensionalRelationshipContainerApi

  141. abstract def findAllOutgoingInterConceptRelationships(sourceConcept: EName): IndexedSeq[InterConceptRelationship]

    Permalink

    Finds all inter-concept relationships that are outgoing from the given concept.

    Finds all inter-concept relationships that are outgoing from the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  142. abstract def findAllOutgoingInterConceptRelationshipsOfType[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all inter-concept relationships of the given type that are outgoing from the given concept.

    Finds all inter-concept relationships of the given type that are outgoing from the given concept.

    Definition Classes
    InterConceptRelationshipContainerApi

  143. abstract def findAllOutgoingNonStandardRelationships(sourceKey: XmlFragmentKey): IndexedSeq[NonStandardRelationship]

    Permalink

    Finds all non-standard relationships that are outgoing from the given concept.

    Finds all non-standard relationships that are outgoing from the given concept.

    Definition Classes
    NonStandardRelationshipContainerApi

  144. abstract def findAllOutgoingNonStandardRelationshipsOfType[A <: NonStandardRelationship](sourceKey: XmlFragmentKey, relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all non-standard relationships of the given type that are outgoing from the given XML element.

    Finds all non-standard relationships of the given type that are outgoing from the given XML element.

    Definition Classes
    NonStandardRelationshipContainerApi

  145. abstract def findAllOutgoingParentChildRelationships(sourceConcept: EName): IndexedSeq[ParentChildRelationship]

    Permalink

    Finds all parent-child relationships that are outgoing from the given concept.

    Finds all parent-child relationships that are outgoing from the given concept.

    Definition Classes
    PresentationRelationshipContainerApi

  146. abstract def findAllOutgoingStandardRelationships(sourceConcept: EName): IndexedSeq[StandardRelationship]

    Permalink

    Finds all standard relationships that are outgoing from the given concept.

    Finds all standard relationships that are outgoing from the given concept.

    Definition Classes
    StandardRelationshipContainerApi

  147. abstract def findAllOutgoingStandardRelationshipsOfType[A <: StandardRelationship](sourceConcept: EName, relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all standard relationships of the given type that are outgoing from the given concept.

    Finds all standard relationships of the given type that are outgoing from the given concept.

    Definition Classes
    StandardRelationshipContainerApi

  148. abstract def findAllOwnOrInheritedHasHypercubes(concept: EName): IndexedSeq[HasHypercubeRelationship]

    Permalink

    Finds all own or inherited has-hypercubes.

    Finds all own or inherited has-hypercubes. See section 2.6.1 of the XBRL Dimensions specification.

    Definition Classes
    DimensionalRelationshipContainerApi

  149. abstract def findAllOwnOrInheritedHasHypercubesAsElrToPrimariesMap(concept: EName): Map[String, Set[EName]]

    Permalink

    Finds all own or inherited has-hypercubes as a Map from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR.

    Finds all own or inherited has-hypercubes as a Map from ELRs to all primaries that are source concepts of the has-hypercube relationships with that ELR. See section 2.6.1 of the XBRL Dimensions specification.

    Definition Classes
    DimensionalRelationshipContainerApi

  150. abstract def findAllParentChildRelationships: IndexedSeq[ParentChildRelationship]

    Permalink
    Definition Classes
    PresentationRelationshipContainerApi

  151. abstract def findAllPresentationRelationshipsOfType[A <: PresentationRelationship](relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink
    Definition Classes
    PresentationRelationshipContainerApi

  152. abstract def findAllPrimaryItemDeclarations: IndexedSeq[PrimaryItemDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  153. abstract def findAllStandardRelationships: IndexedSeq[StandardRelationship]

    Permalink
    Definition Classes
    StandardRelationshipContainerApi

  154. abstract def findAllStandardRelationshipsOfType[A <: StandardRelationship](relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink
    Definition Classes
    StandardRelationshipContainerApi

  155. abstract def findAllTupleDeclarations: IndexedSeq[TupleDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  156. abstract def findAllTypedDimensionDeclarations: IndexedSeq[TypedDimensionDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

  157. abstract def findAllUsableDimensionMembers(hasHypercubeRelationship: HasHypercubeRelationship): Map[EName, Set[EName]]

    Permalink

    Finds all usable (explicit) dimension members for the given has-hypercube relationship.

    Finds all usable (explicit) dimension members for the given has-hypercube relationship.

    Definition Classes
    DimensionalRelationshipContainerApi

  158. abstract def findAllUsableMembers(dimension: EName, domainElrPairs: Set[(EName, String)]): Set[EName]

    Permalink

    Finds all usable members in the given effective domain of the given dimension.

    Finds all usable members in the given effective domain of the given dimension. If a member is usable in one dimension-domain but not usable in another one, it is considered not usable.

    Definition Classes
    DimensionalRelationshipContainerApi

  159. abstract def findAllUsableMembers(dimension: EName, domain: EName, dimensionDomainElr: String): Set[EName]

    Permalink

    Finds all usable members in the given dimension-domain.

    Finds all usable members in the given dimension-domain. There should be at most one dimension-domain relationship from the given dimension to the given domain, having the given ELR.

    Definition Classes
    DimensionalRelationshipContainerApi

  160. 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

  161. 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

  162. abstract def findConceptDeclaration(ename: EName): Option[ConceptDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    SchemaApi

  169. abstract def findGlobalAttributeDeclaration(p: (GlobalAttributeDeclaration) ⇒ Boolean): Option[GlobalAttributeDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  170. abstract def findGlobalElementDeclaration(ename: EName): Option[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  171. abstract def findGlobalElementDeclaration(p: (GlobalElementDeclaration) ⇒ Boolean): Option[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  172. abstract def findGlobalElementDeclarationByUri(uri: URI): Option[GlobalElementDeclaration]

    Permalink
    Definition Classes
    SchemaApi

  173. abstract def findHypercubeDeclaration(ename: EName): Option[HypercubeDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    SchemaApi

  179. abstract def findNamedComplexTypeDefinition(p: (NamedComplexTypeDefinition) ⇒ Boolean): Option[NamedComplexTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  180. abstract def findNamedSimpleTypeDefinition(ename: EName): Option[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  181. abstract def findNamedSimpleTypeDefinition(p: (NamedSimpleTypeDefinition) ⇒ Boolean): Option[NamedSimpleTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  182. abstract def findNamedTypeDefinition(ename: EName): Option[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  183. abstract def findNamedTypeDefinition(p: (NamedTypeDefinition) ⇒ Boolean): Option[NamedTypeDefinition]

    Permalink
    Definition Classes
    SchemaApi

  184. abstract def findPrimaryItemDeclaration(ename: EName): Option[PrimaryItemDeclaration]

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

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

    Permalink
    Definition Classes
    TaxonomySchemaApi

  190. 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

  191. abstract def getConceptDeclaration(ename: EName): ConceptDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  192. abstract def getDimensionDeclaration(ename: EName): DimensionDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  193. abstract def getExplicitDimensionDeclaration(ename: EName): ExplicitDimensionDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  194. abstract def getGlobalAttributeDeclaration(ename: EName): GlobalAttributeDeclaration

    Permalink
    Definition Classes
    SchemaApi

  195. abstract def getGlobalElementDeclaration(ename: EName): GlobalElementDeclaration

    Permalink
    Definition Classes
    SchemaApi

  196. abstract def getGlobalElementDeclarationByUri(uri: URI): GlobalElementDeclaration

    Permalink
    Definition Classes
    SchemaApi

  197. abstract def getHypercubeDeclaration(ename: EName): HypercubeDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  198. abstract def getItemDeclaration(ename: EName): ItemDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  199. abstract def getMemberDeclarationOfTypedDimension(typedDimension: EName): GlobalElementDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  200. abstract def getNamedComplexTypeDefinition(ename: EName): NamedComplexTypeDefinition

    Permalink
    Definition Classes
    SchemaApi

  201. abstract def getNamedSimpleTypeDefinition(ename: EName): NamedSimpleTypeDefinition

    Permalink
    Definition Classes
    SchemaApi

  202. abstract def getNamedTypeDefinition(ename: EName): NamedTypeDefinition

    Permalink
    Definition Classes
    SchemaApi

  203. abstract def getPrimaryItemDeclaration(ename: EName): PrimaryItemDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  204. abstract def getTupleDeclaration(ename: EName): TupleDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  205. abstract def getTypedDimensionDeclaration(ename: EName): TypedDimensionDeclaration

    Permalink
    Definition Classes
    TaxonomySchemaApi

  206. abstract def relationships: IndexedSeq[Relationship]

    Permalink

    Returns all relationships in the taxonomy

  207. abstract def rootElems: IndexedSeq[TaxonomyElem]

    Permalink

    Returns all (document) root elements.

    Returns all (document) root elements. To find certain taxonomy elements across the taxonomy, in taxonomy schemas and linkbases, the following pattern can be used:

    rootElems.flatMap(_.filterElemsOrSelfOfType(classTag[E])(pred))

  208. 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

  209. abstract def taxonomyDocs: IndexedSeq[TaxonomyDocument]

    Permalink

    Returns all taxonomy documents.

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 DimensionalRelationshipContainerApi

Inherited from ElementReferenceRelationshipContainerApi

Inherited from ElementLabelRelationshipContainerApi

Inherited from ConceptReferenceRelationshipContainerApi

Inherited from ConceptLabelRelationshipContainerApi

Inherited from PresentationRelationshipContainerApi

Inherited from InterConceptRelationshipContainerApi

Inherited from NonStandardRelationshipContainerApi

Inherited from StandardRelationshipContainerApi

Inherited from TaxonomySchemaApi

Inherited from SchemaApi

Inherited from AnyRef

Inherited from Any

Ungrouped