eu.cdevreeze.tqa.base.taxonomybuilder

Abstract partially implemented DTS discovery as document collector. It is memory-hungry in that all found documents are stored in memory while finding the DTS. It is also unforgiving in that broken links are not allowed.

If there is a broken link due to a typo, consider tweaking the DocumentBuilder with some post-processing.

Default DTS discovery implementation. It will fail for all found URIs that cannot be resolved to taxonomy documents.

This document collector works well with XBRL Taxonomy Packages, passing an entry point in such a taxonomy package, and using a document builder that uses the XML catalog of the taxonomy package.

DTS discovery also works if one or more taxonomy schemas and/or linkbases have been combined in the same XML document, below another (wrapper) root element. Embedded linkbases are also picked up.

Description in a taxonomy package

Strategy for collecting taxonomy documents. Typically implemented as DTS discovery, although it is also possible that all document URIs must be explicitly mentioned, as is the case for TrivialDocumentCollector.

Documentation group, so either a Name or a Description

EntryPoint in a taxonomy package

EntryPoint document in a taxonomy package

EntryPoints element in a taxonomy package

Identifier in a taxonomy package

Language in a taxonomy package

Languages element in a taxonomy package

License in a taxonomy package

Name in a taxonomy package

Other element in a taxonomy package

Publication date in a taxonomy package

Publisher in a taxonomy package

Publisher country in a taxonomy package

Publisher URL in a taxonomy package

Superseded taxonomy packages element in a taxonomy package

Fluent interface for bootstrapping a taxonomy. The type system helps in getting bootstrapping right, if we start with the TaxonomyBuilder companion object.

Fluent type-safe API to create a TaxonomyBuilder. Note that typically it makes sense to create a TaxonomyBuilder once, and keep it, using it to create taxonomies for different entrypoints. Hence, creating a TaxonomyBuilder is typically rather easy, given a DocumentBuilder. Mostly it is the creation of the DocumentBuilder that can be challenging, due to the URI resolution strategy to pass, and possibly also due to the use of a document cache.

Taxonomy package root element.

It does not check validity of the taxonomy package.

XML element inside a taxonomy package XML tree. This API is immutable, provided the backing element is immutable.

The yaidom SubtypeAwareElemApi and ScopedElemApi query API is offered.

Note that the package-private constructor contains redundant data, in order to speed up (yaidom-based) querying.

It is not required that the taxonomy package elements are schema-valid. Construction of a taxonomy package element is indeed quite lenient.

Note that the backing element implementation can be any implementation of yaidom query API trait BackingNodes.Elem.

This class hierarchy depends on Java 8 or later, due to the use of Java 8 time API.

Creation of TaxonomyPackageElem objects is designed not to fail, even if the XML element is not taxonomy package element content. Of course, after creation many query methods may fail in such cases. It is also possible to use these data classes for taxonomy package elements embedded in other XML elements, or only for parts of taxonomy package elements.

"Taxonomy package DOM node".

Taxonomy package reference in a taxonomy package

Trivial document collector, performing no DTS discovery, but expecting all document URIs to be explicitly given as "entry points" instead.

Version in a taxonomy package

Versioning report in a taxonomy package

Versioning reports element in a taxonomy package