Trait

eu.cdevreeze.tqa.base.queryapi

DimensionalRelationshipContainerApi

Related Doc: package queryapi

Permalink

trait DimensionalRelationshipContainerApi extends AnyRef

Purely abstract trait offering a dimensional relationship query API.

Implementations may be strict or lenient in enforced requirements on the relationship container.

Linear Supertypes
AnyRef, Any
Known Subclasses
BasicTaxonomy, DimensionalRelationshipContainerLike, TaxonomyApi, TaxonomyLike
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DimensionalRelationshipContainerApi
  2. AnyRef
  3. 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.

  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.

  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)

  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)

  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.

  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)

  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)

  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.

  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.

  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.

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

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

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

    Permalink

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

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

    Permalink

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

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

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

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

    Permalink

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

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

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

    Permalink

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

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

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

    Permalink

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

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

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

    Permalink

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

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

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

    Permalink

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

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

  34. 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)
}

  35. 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)
}

  36. 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)
}

  37. abstract def findAllDimensionDefaultRelationships: IndexedSeq[DimensionDefaultRelationship]

    Permalink

  38. abstract def findAllDimensionDomainRelationships: IndexedSeq[DimensionDomainRelationship]

    Permalink

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

    Permalink

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

  40. abstract def findAllDimensionalRelationships: IndexedSeq[DimensionalRelationship]

    Permalink

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

    Permalink

  42. abstract def findAllDomainMemberRelationships: IndexedSeq[DomainMemberRelationship]

    Permalink

  43. abstract def findAllHasHypercubeRelationships: IndexedSeq[HasHypercubeRelationship]

    Permalink

  44. abstract def findAllHypercubeDimensionRelationships: IndexedSeq[HypercubeDimensionRelationship]

    Permalink

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

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

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

    Permalink

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

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

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

    Permalink

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

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

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

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

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

    Permalink

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

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

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

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 AnyRef

Inherited from Any

Ungrouped