Package

eu.cdevreeze.tqa.base

taxonomy

Permalink

package taxonomy

Taxonomy classes, containing type-safe DOM trees, and mixing in taxonomy query API traits. In particular, the eu.cdevreeze.tqa.base.queryapi.TaxonomyApi trait is mixed in as taxonomy query API. See package eu.cdevreeze.tqa.base.queryapi for more information about how to query XBRL taxonomy content.

The term taxonomy is used here in a very general sense, namely as a collection of taxonomy documents.

Various scenarios are supported. Taxonomies that are not closed (and not validated in any way) must be supported in order for TQA to be useful for taxonomy validation. Closed taxonomies are supported for reliable taxonomy querying. Taxonomies that model networks of relationships are also supported. Specific taxonomies knowing about formulas and/or tables are also supported. Extension taxonomies are also supported.

Some important operations on taxonomies are prohibition/overriding resolution (to find networks of relationships), combining taxonomies (for building extension taxonomies, for example), filtering relationships (to ignore relationships that we are not interested in).

Each taxonomy class has at least the following state (directly or indirectly): a collection of taxonomy DOM root elements, and a collection of relationships. The underlying arcs, locators and resources of those relationships must exist in the collection of taxonomy DOM trees, or else the taxonomy is corrupt.

TQA has no knowledge about XPath, so any XPath in taxonomies is just text, as far as TQA is concerned.

This package unidirectionally depends on the eu.cdevreeze.tqa.base.queryapi, eu.cdevreeze.tqa.base.relationship and eu.cdevreeze.tqa.base.dom packages.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. taxonomy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class BasicTaxonomy extends TaxonomyLike

    Permalink

    Basic implementation of a taxonomy that offers the TaxonomyApi query API.

    Basic implementation of a taxonomy that offers the TaxonomyApi query API. It does not enforce closure under DTS discovery rules, or uniqueness of "target expanded names" of concept declarations etc. It does not know anything about tables and formulas. It also does not know anything about networks of relationships.

    The passed relationships must be backed by XLink arcs in the underlying taxonomy, or else the instance is corrupt. This is not checked by this class.

    This object is expensive to create (through the build method), primarily due to the mappings from source and target concepts to standard relationships. Looking up schema content by EName (or by URI for global element declarations) is also fast.

Value Members

  1. object BasicTaxonomy

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped