dvreeze / tqa Goto Github PK

Hi Chris! Hope you are doing well!

According to https://www.xbrl.org/Specification/taxonomy-package/REC-2016-04-19/taxonomy-package-REC-2016-04-19.html,
a taxonomy package zip should contain only a single root entry, which is a folder with the same name as the zip file itself:

A Taxonomy Package MUST contain a single top-level directory, with all other files being contained within that directory or descendant subdirectories (tpe:invalidDirectoryStructure). It is recommended, but not required, that the name of the top-level directory be the same as the name of the Taxonomy Package with the .zip file extension removed.

In any case it's easy to assume they mean the implicit root of every zip file, but in fact they truly mean that an explicit single folder should be inside the zip.

Currently TQA assumes a top level folder "META-INF/catalog.xml", but that should rather be "???/META-INF/catalog.xml" (see TaxonomyBaseFactoryFromRemoteZip.scala and TaxonomyPackagePartialUriResolver.scala).

Recursive TaxonomyElem creation looks at the parent element to distinguish between global and local element declarations, for example. The way the parent element is determined is not through a call to method parentOption, but through a call to method reverseAncestryOrSelfENames instead. The latter is optimal if the backing element is a native yaidom indexed element, but quite inefficient (and generating lots of garbage) for Saxon wrapper elements. This should be fixed.

The fix could be twofold:

• During TaxonomyElem creation, reduce the number of parent element/EName calls, by passing the parent around
• Make parent element/EName querying itself very efficient, with custom implementations for well-known backing elements

About the second point: we could have an (internal) element query API extension API, one "instanceof" pattern match for well-known backing element implementations, and then type-safe implementations of that query API extension for those element implementations. One method in that extension query API could be "hasParentWithName(ename)", and it would have quite different implementations for Saxon wrappers and native yaidom indexed elements.

This could all be done in TQA (no need to change yaidom), without any breaking changes.