TaxonomyApi
Related Doc:
package queryapi
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.
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.
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.
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.
Filters "domain-aware" relationships that are incoming to the given concept.
Filters "domain-aware" relationships that are incoming to the given concept.
Filters domain-member relationships that are incoming to the given concept.
Filters domain-member relationships that are incoming to the given concept.
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.
Filters parent-child relationships that are incoming to the given concept.
Filters parent-child relationships that are incoming to the given concept.
Filters the longest consecutive (!) dimension-domain-or-domain-member relationship paths that are incoming to the given concept.
Filters the longest 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!
It is a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Filters the longest consecutive (!) domain-member relationship paths that are incoming to the given concept.
Filters the longest 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!
It is a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Filters the longest consecutive (!) parent-child relationship paths that are incoming to the given concept.
Filters the longest 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!
It is a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Filters the longest inter-concept relationship paths that are incoming to the given concept and whose relationships are of the given type.
Filters the longest 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!
This is a very general method that is used to implement specific methods in more specific relationship query API traits.
It is also a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Calls filterLongestIncomingInterConceptRelationshipPaths, but adds cycle detection to the predicate.
Calls filterLongestIncomingInterConceptRelationshipPaths, but adds cycle detection to the predicate.
Filters the longest consecutive (!) dimension-domain-or-domain-member relationship paths that are outgoing from the given concept.
Filters the longest 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!
It is a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Filters the longest consecutive (!) domain-member relationship paths that are outgoing from the given concept.
Filters the longest 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!
It is a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Filters the longest consecutive (!) parent-child relationship paths that are outgoing from the given concept.
Filters the longest 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!
It is a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Filters the longest inter-concept relationship paths that are outgoing from the given concept and whose relationships are of the given type.
Filters the longest 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!
This is a very general method that is used to implement specific methods in more specific relationship query API traits.
It is also a dangerous method in that termination is not guaranteed, but may depend on the passed relationship path predicate. For safety, make sure that the predicate detects cycles and returns false on detecting them.
Calls filterLongestOutgoingInterConceptRelationshipPaths, but adds cycle detection to the predicate.
Calls filterLongestOutgoingInterConceptRelationshipPaths, but adds cycle detection to the predicate.
Filters concept-label relationships that are outgoing from the given concept.
Filters concept-label relationships that are outgoing from the given concept.
Filters concept-reference relationships that are outgoing from the given concept.
Filters concept-reference relationships that are outgoing from the given concept.
Filters dimension-default relationships that are outgoing from the given concept.
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-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.
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.
Filters domain-member relationships that are outgoing from the given concept.
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 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.
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.
Filters hypercube-dimension relationships that are outgoing from the given concept.
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.
Filters hypercube-dimension relationships that are outgoing from the given concept on the given ELR.
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.
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.
Filters parent-child relationships that are outgoing from the given concept.
Filters parent-child relationships that are outgoing from the given concept.
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.
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.
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))
Finds all consecutive dimension-domain relationships.
Finds all consecutive dimension-domain relationships.
This method is shorthand for:
filterOutgoingDimensionDomainRelationships(relationship.targetConceptEName) { rel =>
relationship.isFollowedBy(rel)
}
Finds all consecutive domain-member relationships.
Finds all consecutive domain-member relationships.
This method is shorthand for:
filterOutgoingDomainMemberRelationships(relationship.targetConceptEName) { rel =>
relationship.isFollowedBy(rel)
}
Finds all consecutive hypercube-dimension relationships.
Finds all consecutive hypercube-dimension relationships.
This method is shorthand for:
filterOutgoingHypercubeDimensionRelationships(relationship.targetConceptEName) { rel =>
relationship.isFollowedBy(rel)
}
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)
}
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)
}
Finds all (explicit) dimension members for the given has-hypercube relationship.
Finds all (explicit) dimension members for the given has-hypercube relationship.
Finds all "domain-aware" relationships that are incoming to the given concept.
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 domain-member relationships that are incoming to the given concept.
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.
Finds all parent-child relationships that are incoming to the given concept.
Finds all parent-child relationships that are incoming to the given concept.
Finds all inherited has-hypercubes.
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.
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.
Returns filterLongestIncomingConsecutiveDomainAwareRelationshipPaths(targetConcept)(_ => true).
Returns filterLongestIncomingConsecutiveDomainAwareRelationshipPaths(targetConcept)(_ => true).
Returns filterLongestIncomingConsecutiveDomainMemberRelationshipPaths(targetConcept)(_ => true).
Returns filterLongestIncomingConsecutiveDomainMemberRelationshipPaths(targetConcept)(_ => true).
Returns filterLongestIncomingConsecutiveParentChildRelationshipPaths(targetConcept)(_ => true).
Returns filterLongestIncomingConsecutiveParentChildRelationshipPaths(targetConcept)(_ => true).
Returns filterLongestOutgoingConsecutiveDomainAwareRelationshipPaths(sourceConcept)(_ => true).
Returns filterLongestOutgoingConsecutiveDomainAwareRelationshipPaths(sourceConcept)(_ => true).
Returns filterLongestOutgoingConsecutiveDomainMemberRelationshipPaths(sourceConcept)(_ => true).
Returns filterLongestOutgoingConsecutiveDomainMemberRelationshipPaths(sourceConcept)(_ => true).
Returns filterLongestOutgoingConsecutiveParentChildRelationshipPaths(sourceConcept)(_ => true).
Returns filterLongestOutgoingConsecutiveParentChildRelationshipPaths(sourceConcept)(_ => true).
Finds all members in the given effective domain of the given dimension.
Finds all members in the given effective domain of the given dimension.
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.
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.
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.
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.
Finds all concept-label relationships that are outgoing from the given concept.
Finds all concept-label relationships that are outgoing from the given concept.
Finds all concept-reference relationships that are outgoing from the given concept.
Finds all concept-reference relationships that are outgoing from the given concept.
Finds all dimension-default relationships that are outgoing from the given concept.
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 dimension-domain relationships that are outgoing from the given concept.
Finds all domain-member 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 has-hypercube relationships that are outgoing from the given concept.
Finds all hypercube-dimension relationships that are outgoing from the given concept.
Finds all hypercube-dimension relationships that are outgoing from the given concept.
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.
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.
Finds all parent-child relationships that are outgoing from the given concept.
Finds all parent-child relationships that are outgoing from the given concept.
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.
Finds all own or inherited has-hypercubes.
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.
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 (explicit) dimension members for the given has-hypercube relationship.
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.
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.
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))
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.
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))
Returns all relationships in the taxonomy
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))
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.
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.