DimensionalRelationshipContainerApi

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.

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.

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)

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)

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.

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)

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)

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.

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.

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.

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 beyond a certain path length.

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 beyond a certain path length.

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

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

Filters has-hypercube relationships that are incoming to the given (hypercube) concept.

Filters hypercube-dimension relationships that are incoming to the given (dimension) 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 beyond a certain path length.

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 beyond a certain path length.

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

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

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

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

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

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

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

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

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

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

Finds all consecutive dimension-domain relationships.

This method is shorthand for:

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

Finds all consecutive domain-member relationships.

This method is shorthand for:

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

Finds all consecutive hypercube-dimension relationships.

This method is shorthand for:

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

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

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

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

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

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

Finds all has-hypercube relationships that are incoming to the given (hypercube) concept.

Finds all hypercube-dimension relationships that are incoming to the given (dimension) concept.

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

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.

Finds all members in the given domain, for the given ELR. This method is more general than the corresponding findAllMembers method that takes a dimension as first parameter. This method is also applicable to Extensible Enumerations 2.0, to find a domain of (allowed or disallowed) enumeration values.

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.

This method is equivalent to but more user-friendly than:

findAllMembers(domain, targetElr)

where targetElr is the target ELR of the dimension-domain relationship.

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

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

Finds all non-usable members in the given domain, for the given ELR. This method is more general than the corresponding findAllNonUsableMembers method that takes a dimension as first parameter. This method is also applicable to Extensible Enumerations 2.0, to find a domain of disallowed enumeration values.

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.

This method is equivalent to but more user-friendly than:

findAllNonUsableMembers(domain, targetElr, headUsable)

where headUsable is taken from the xbrldt:usable attribute on the dimension-domain relationship, and targetElr is the target ELR of the dimension-domain relationship.

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.

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

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

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

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

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

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

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

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

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.

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

Finds all usable members in the given domain, for the given ELR. This method is more general than the corresponding findAllUsableMembers method that takes a dimension as first parameter. This method is also applicable to Extensible Enumerations 2.0, to find a domain of allowed enumeration values.

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.

This method is equivalent to but more user-friendly than:

findAllUsableMembers(domain, targetElr, headUsable)

where headUsable is taken from the xbrldt:usable attribute on the dimension-domain relationship, and targetElr is the target ELR of the dimension-domain relationship.

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.