eu.cdevreeze.tqa.docbuilder.jvm

Type members

Classlikes

final class CachingDocumentBuilder[D <: BackingDocumentApi](val cache: LoadingCache[URI, D]) extends DocumentBuilder

DocumentBuilder using a Caffeine document cache. By all means, reuse the underlying document cache as much as possible.

DocumentBuilder using a Caffeine document cache. By all means, reuse the underlying document cache as much as possible.

Authors

Chris de Vreeze

Companion
object
final class CachingThreadSafeDocumentBuilder[D <: BackingDocumentApi](val cacheWrapper: LoadingCacheWrapper[D]) extends ThreadSafeDocumentBuilder

ThreadSafeDocumentBuilder using a Caffeine document cache. By all means, reuse the underlying document cache as much as possible.

ThreadSafeDocumentBuilder using a Caffeine document cache. By all means, reuse the underlying document cache as much as possible.

Authors

Chris de Vreeze

Companion
object

Partial URI converters, typically converting HTTP or HTTPS URIs to local file URIs. Typically a PartialUriConverter is created from a SimpleCatalog. This is also desirable, because catalogs are clear and precise URI mappings. Yet not every PartialUriConverter can be created from a SimpleCatalog, for example because an URI may map to the first of a list of local URIs where the document can be found, which cannot be expressed with a SimpleCatalog.

Partial URI converters, typically converting HTTP or HTTPS URIs to local file URIs. Typically a PartialUriConverter is created from a SimpleCatalog. This is also desirable, because catalogs are clear and precise URI mappings. Yet not every PartialUriConverter can be created from a SimpleCatalog, for example because an URI may map to the first of a list of local URIs where the document can be found, which cannot be expressed with a SimpleCatalog.

Sometimes it is desirable to create a SimpleCatalog and corresponding PartialUriConverter from some parent directory, but there are several possible heuristics for creating a SimpleCatalog from such a parent directory. Hence it is up to the application to generate a SimpleCatalog from the parent directory. Method PartialUriConverters.fromCatalog can then be used to turn that SimpleCatalog into a PartialUriConverter.

Note that there is only one fundamental method in this singleton object, namely fromCatalog.

Authors

Chris de Vreeze

Partial URI resolvers, converting an URI to a SAX InputSource.

Partial URI resolvers, converting an URI to a SAX InputSource.

Note that the only fundamental methods in this singleton object are fromPartialUriConverter and its counterpart for ZIP files, namely forZipFile.

Authors

Chris de Vreeze

Partial URI resolvers specifically for a taxonomy package (see https://www.xbrl.org/Specification/taxonomy-package/REC-2016-04-19/taxonomy-package-REC-2016-04-19.html).

Authors

Chris de Vreeze

URI resolvers specifically for taxonomy packages (see https://www.xbrl.org/Specification/taxonomy-package/REC-2016-04-19/taxonomy-package-REC-2016-04-19.html).

Authors

Chris de Vreeze

URI converters, typically converting an HTTP or HTTPS URI to a local file URI. The implementations use SimpleCatalog objects to perform the actual URI conversions.

URI converters, typically converting an HTTP or HTTPS URI to a local file URI. The implementations use SimpleCatalog objects to perform the actual URI conversions.

Note that the only fundamental methods in this singleton object are fromPartialUriConvertersWithoutFallback and fromPartialUriConvertersFallingBackToIdentity.

Authors

Chris de Vreeze

object UriResolvers

URI resolvers, converting an URI to a SAX InputSource.

URI resolvers, converting an URI to a SAX InputSource.

Note that the only fundamental methods in this singleton object are fromPartialUriResolversWithoutFallback and fromPartialUriResolversWithFallback.

Authors

Chris de Vreeze