com.ihr.xbrl.om.resolvers

Class TaxonomyPackageURIResolver

java.lang.Object

com.ihr.xbrl.om.resolvers.TaxonomyPackageURIResolver

All Implemented Interfaces:

DTSCascadeSchemaURIResolver, DTSCascadeURIResolver, javax.xml.transform.URIResolver, net.sf.saxon.lib.SchemaURIResolver, org.xml.sax.EntityResolver

public class TaxonomyPackageURIResolver
extends java.lang.Object
implements DTSCascadeSchemaURIResolver, org.xml.sax.EntityResolver

This URI Resolver implements the Taxonomy Package 1.0 - Public Working Draft 15 January 2014

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaxonomyPackageURIResolver.EntryPointHRefs The Class EntryPointHRefs.
static class	TaxonomyPackageURIResolver.EntryPointLangInfo Represents an entry point in a taxonomy package.
static class	TaxonomyPackageURIResolver.EntryPointLangInfoKey The Class EntryPointLangInfoKey.
static class	TaxonomyPackageURIResolver.PackageByLangInfo Holds all elements that may contain different values by language.
static class	TaxonomyPackageURIResolver.TaxonomyPackage Represents a package (zip file) that contains a set of entry points and mapping rules as indicated in the Taxonomy Packages Specification(s) .

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	mandatoryCatalogFileName The Constant mandatoryCatalogFileName.
static java.lang.String	mandatoryFileName The Constant mandatoryFileName.
static java.lang.String	mandatoryFileNameNew The Constant mandatoryFileNameNew.
static java.lang.String	namespace from the multiple namespaces recognized, this will point to the last one implemented.
static java.lang.String	schemaURL from the multiple schema versions recognized, this will point to the last one implemented.
static javax.xml.namespace.QName	taxonomyPackage This is the taxonomyPackage element declaration using the last implemented namespace.
static java.lang.String	tpNamespace_Corefiling The Constant tpNamespace_Corefiling.
static java.lang.String	tpNamespace_PR_20151209 The Constant tpNamespace_PR_20151209.
static java.lang.String	tpNamespace_PWD_20140115 The Constant tpNamespace_PWD_20140115.
static java.lang.String	tpNamespace_PWD_20150114 The Constant tpNamespace_PWD_20150114.
static java.lang.String	tpNamespace_REC_20160419 The Constant tpNamespace_REC_20160419.
static java.lang.String	tpNamespace_WGWD_YYYYMMDD The Constant tpNamespace_WGWD_YYYYMMDD.
static java.lang.String	tpURL_PR_20151209 The Constant tpURL_PR_20151209.
static java.lang.String	tpURL_PWD_20140115 The Constant tpURL_PWD_20140115.
static java.lang.String	tpURL_REC_20160419 The Constant tpURL_REC_20160419.
static java.lang.String	typicalDirectoryOfPackages The Constant typicalDirectoryOfPackages.

Constructor Summary

Constructors

Constructor and Description
TaxonomyPackageURIResolver(net.sf.saxon.lib.SchemaURIResolver nextResolver) Instantiates a new zip cascade uri resolver.
TaxonomyPackageURIResolver(javax.xml.transform.URIResolver nextResolver) Instantiates a new zip cascade uri resolver.

Method Summary

Modifier and Type	Method and Description
static void	addPackage(TaxonomyPackageURIResolver.TaxonomyPackage tp) Adds a new taxonomy package to loaded packages and calls reorderPackages internally.
static void	checkIsLoaded(RSRemoteCatalogResolver.StaticCatalogEntry sce) Check is loaded for the StaticCatalogEntry received as a parameter.
static java.nio.file.Path	copyFile(java.io.File file) Copies the file indicated in the file parameter to the typical directory of taxonomy packages.
static void	declareInjectedPackage(TaxonomyPackageURIResolver.TaxonomyPackage tp) Declare injected package.
void	endDTSDiscovery() End DTS discovery.
static java.util.Iterator<java.util.Collection<java.net.URI>>	getEntryPointsIterator(java.lang.String id) Gets the entry points iterator.
static java.util.List<TaxonomyPackageURIResolver.TaxonomyPackage>	getInjectedTaxonomyPackages() Gets the injected taxonomy packages.
static java.util.Iterator<java.net.URI>	getIterator(java.lang.String id) Gets the iterator.
javax.xml.transform.URIResolver	getNextResolver() Gets the next resolver.
net.sf.saxon.lib.SchemaURIResolver	getNextSchemaResolver() Gets the next schema resolver.
static TaxonomyPackageURIResolver.TaxonomyPackage	getPackage(java.io.File zipFile) Load the ZIP file received as a parameter and prepares a TaxonomyPackage entry loaded from the file.
static TaxonomyPackageURIResolver.TaxonomyPackage	getPackage(java.lang.String id) Returns the TaxonomyPackage using the id as the key to search for.
static java.util.Collection<TaxonomyPackageURIResolver.TaxonomyPackage>	getPackages(java.io.File fDirectory) Read all packages in a directory.
static RSRemoteCatalogResolver.StaticCatalogEntry	getStaticCatalogEntry(TaxonomyPackageURIResolver.TaxonomyPackage tp) Gets the static catalog entry.
static TPValidationException	getTaxonomyPackageError(java.io.File key) When the method getPackage(File) receives an error for the indicated file the error is stored in a table.
static java.lang.String	getVersion(java.lang.String id) Gets the version.
static java.util.Set<java.lang.String>	installedPackagesIDs() This method returns a set of ids of packages installed.
static TaxonomyPackageURIResolver.TaxonomyPackage	loadTaxonomyPackageFromFile(java.io.File fileZip) Process a ZIP file indicated in the fileZip parameter as a Taxonomy Package and returns an instance of TaxonomyPackage class.
static void	removePackage(java.lang.String id) Removes the package from the file system and from the loaded packages.
static void	removePackage(TaxonomyPackageURIResolver.TaxonomyPackage tp) Removes a taxonomy package from loaded packages and calls reorderPackages internally.
javax.xml.transform.Source	resolve(java.lang.String href, java.lang.String base) Resolve.
javax.xml.transform.Source[]	resolve(java.lang.String targetNamespace, java.lang.String baseURI, java.lang.String[] locations) Resolve.
org.xml.sax.InputSource	resolveEntity(java.lang.String publicId, java.lang.String systemId) Resolve entity.
void	setConfiguration(net.sf.saxon.Configuration config) Sets the configuration.
void	setNextResolver(net.sf.saxon.lib.SchemaURIResolver newNextResolver) Sets the next resolver.
void	setNextResolver(javax.xml.transform.URIResolver newNextResolver) Sets the next resolver.
void	startDTSDiscovery() Start DTS discovery.
static void	undeclareInjectedPackage(TaxonomyPackageURIResolver.TaxonomyPackage tp) Undeclare injected package.
static void	unloadPackage(java.io.File zipFile) Removes from memory all structures related with the ZIP file received as a parameter and loaded from the local ZIP file so a call to getPackage(File) can read the same entry again (but new version).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

typicalDirectoryOfPackages

public static final java.lang.String typicalDirectoryOfPackages

The Constant typicalDirectoryOfPackages.

See Also:

Constant Field Values

tpNamespace_Corefiling

public static final java.lang.String tpNamespace_Corefiling

The Constant tpNamespace_Corefiling.

See Also:

Constant Field Values

tpNamespace_PWD_20140115

public static final java.lang.String tpNamespace_PWD_20140115

The Constant tpNamespace_PWD_20140115.

See Also:

Constant Field Values

tpNamespace_PWD_20150114

public static final java.lang.String tpNamespace_PWD_20150114

The Constant tpNamespace_PWD_20150114.

See Also:

Constant Field Values

tpNamespace_PR_20151209

public static final java.lang.String tpNamespace_PR_20151209

The Constant tpNamespace_PR_20151209.

See Also:

Constant Field Values

tpNamespace_WGWD_YYYYMMDD

public static final java.lang.String tpNamespace_WGWD_YYYYMMDD

The Constant tpNamespace_WGWD_YYYYMMDD.

See Also:

Constant Field Values

tpNamespace_REC_20160419

public static final java.lang.String tpNamespace_REC_20160419

The Constant tpNamespace_REC_20160419.

See Also:

Constant Field Values

tpURL_PWD_20140115

public static final java.lang.String tpURL_PWD_20140115

The Constant tpURL_PWD_20140115.

See Also:

Constant Field Values

tpURL_PR_20151209

public static final java.lang.String tpURL_PR_20151209

The Constant tpURL_PR_20151209.

See Also:

Constant Field Values

tpURL_REC_20160419

public static final java.lang.String tpURL_REC_20160419

The Constant tpURL_REC_20160419.

See Also:

Constant Field Values

namespace

public static final java.lang.String namespace

from the multiple namespaces recognized, this will point to the last one implemented.

See Also:

Constant Field Values

schemaURL

public static final java.lang.String schemaURL

from the multiple schema versions recognized, this will point to the last one implemented.

See Also:

Constant Field Values

taxonomyPackage

public static final javax.xml.namespace.QName taxonomyPackage

This is the taxonomyPackage element declaration using the last implemented namespace. It is used to serialize new files

mandatoryFileName

public static final java.lang.String mandatoryFileName

The Constant mandatoryFileName.

See Also:

Constant Field Values

mandatoryFileNameNew

public static final java.lang.String mandatoryFileNameNew

The Constant mandatoryFileNameNew.

See Also:

Constant Field Values

mandatoryCatalogFileName

public static final java.lang.String mandatoryCatalogFileName

The Constant mandatoryCatalogFileName.

See Also:

Constant Field Values

Constructor Detail

TaxonomyPackageURIResolver

public TaxonomyPackageURIResolver(javax.xml.transform.URIResolver nextResolver)

Instantiates a new zip cascade uri resolver.

Parameters:

nextResolver - the next resolver

TaxonomyPackageURIResolver

public TaxonomyPackageURIResolver(net.sf.saxon.lib.SchemaURIResolver nextResolver)

Instantiates a new zip cascade uri resolver.

Parameters:

nextResolver - the next resolver

Method Detail

getPackages

public static java.util.Collection<TaxonomyPackageURIResolver.TaxonomyPackage> getPackages(java.io.File fDirectory)

Read all packages in a directory. New packages will be added to the catalog. Removed packages are not removed from the loaded packages.

Parameters:

fDirectory - the f directory

Returns:

Collection of TaxonomyPackage instances

loadTaxonomyPackageFromFile

public static TaxonomyPackageURIResolver.TaxonomyPackage loadTaxonomyPackageFromFile(java.io.File fileZip)
                                                                              throws TPValidationException

Process a ZIP file indicated in the fileZip parameter as a Taxonomy Package and returns an instance of TaxonomyPackage class. This method does not add the package to the catalog.

Parameters:

fileZip - the file zip

Returns:

the taxonomy package

Throws:

TPValidationException - the TP validation exception

getPackage

public static TaxonomyPackageURIResolver.TaxonomyPackage getPackage(java.io.File zipFile)

Load the ZIP file received as a parameter and prepares a TaxonomyPackage entry loaded from the file. If the same file name is processed twice the information is cached and returned. A call to unloadPackage(File) removes the information in memory and allows the same file to be loaded again

Parameters:

zipFile - the zip file

Returns:

the package

addPackage

public static void addPackage(TaxonomyPackageURIResolver.TaxonomyPackage tp)

Adds a new taxonomy package to loaded packages and calls reorderPackages internally.

Parameters:

tp - the tp

removePackage

public static void removePackage(TaxonomyPackageURIResolver.TaxonomyPackage tp)

Removes a taxonomy package from loaded packages and calls reorderPackages internally.

Parameters:

tp - the tp

unloadPackage

public static void unloadPackage(java.io.File zipFile)

Removes from memory all structures related with the ZIP file received as a parameter and loaded from the local ZIP file so a call to getPackage(File) can read the same entry again (but new version).

Parameters:

zipFile - the zip file

removePackage

public static void removePackage(java.lang.String id)

Removes the package from the file system and from the loaded packages.

Parameters:

id - the id

getPackage

public static TaxonomyPackageURIResolver.TaxonomyPackage getPackage(java.lang.String id)

Returns the TaxonomyPackage using the id as the key to search for.

Parameters:

id - String, taxonomy package id

Returns:

the taxonomy package or null if not found

getTaxonomyPackageError

public static TPValidationException getTaxonomyPackageError(java.io.File key)

When the method getPackage(File) receives an error for the indicated file the error is stored in a table. This method uses the same key to access the error raised at that time

Parameters:

key - the key

Returns:

TPValidationException or null if the key did not generate any errors

resolve

public javax.xml.transform.Source resolve(java.lang.String href,
                                          java.lang.String base)
                                   throws javax.xml.transform.TransformerException

Resolve.

Specified by:

resolve in interface javax.xml.transform.URIResolver

Parameters:

href - the href

base - the base

Returns:

the source

Throws:

javax.xml.transform.TransformerException - the transformer exception

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                             java.lang.String systemId)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException

Resolve entity.

Specified by:

resolveEntity in interface org.xml.sax.EntityResolver

Parameters:

publicId - the public id

systemId - the system id

Returns:

the input source

Throws:

org.xml.sax.SAXException - the SAX exception

java.io.IOException - Signals that an I/O exception has occurred.

getNextResolver

public javax.xml.transform.URIResolver getNextResolver()

Gets the next resolver.

Specified by:

getNextResolver in interface DTSCascadeURIResolver

Returns:

the next resolver

setNextResolver

public void setNextResolver(javax.xml.transform.URIResolver newNextResolver)

Sets the next resolver.

Specified by:

setNextResolver in interface DTSCascadeURIResolver

Parameters:

newNextResolver - the new next resolver

installedPackagesIDs

public static java.util.Set<java.lang.String> installedPackagesIDs()

This method returns a set of ids of packages installed. The IDs are from the RSRemoteCatalog so this method will return an empty set if the RSRemoveCatalog has not finished initialization process

Returns:

a Set of package IDs of installed packages.

checkIsLoaded

public static void checkIsLoaded(RSRemoteCatalogResolver.StaticCatalogEntry sce)

Check is loaded for the StaticCatalogEntry received as a parameter. This method will search packages for a TaxonomyPackage entry already loaded by a call to getPackage(File), attach the TaxonomyPackage with the StaticCatalogEntry and populate the cache of version and packageId

Parameters:

sce - the StaticCatalogEntry to check is loaded

getStaticCatalogEntry

public static RSRemoteCatalogResolver.StaticCatalogEntry getStaticCatalogEntry(TaxonomyPackageURIResolver.TaxonomyPackage tp)

Gets the static catalog entry.

Parameters:

tp - the tp

Returns:

the static catalog entry

getVersion

public static java.lang.String getVersion(java.lang.String id)

Gets the version.

Parameters:

id - the id

Returns:

the version

setConfiguration

public void setConfiguration(net.sf.saxon.Configuration config)

Sets the configuration.

Specified by:

setConfiguration in interface net.sf.saxon.lib.SchemaURIResolver

Parameters:

config - the new configuration

resolve

public javax.xml.transform.Source[] resolve(java.lang.String targetNamespace,
                                            java.lang.String baseURI,
                                            java.lang.String[] locations)
                                     throws net.sf.saxon.trans.XPathException

Resolve.

Specified by:

resolve in interface net.sf.saxon.lib.SchemaURIResolver

Parameters:

targetNamespace - the target namespace

baseURI - the base URI

locations - the locations

Returns:

the source[]

Throws:

net.sf.saxon.trans.XPathException - the x path exception

setNextResolver

public void setNextResolver(net.sf.saxon.lib.SchemaURIResolver newNextResolver)

Sets the next resolver.

Specified by:

setNextResolver in interface DTSCascadeSchemaURIResolver

Parameters:

newNextResolver - the new next resolver

getNextSchemaResolver

public net.sf.saxon.lib.SchemaURIResolver getNextSchemaResolver()

Gets the next schema resolver.

Specified by:

getNextSchemaResolver in interface DTSCascadeSchemaURIResolver

Returns:

the next schema resolver

startDTSDiscovery

public void startDTSDiscovery()

Start DTS discovery.

Specified by:

startDTSDiscovery in interface DTSCascadeURIResolver

endDTSDiscovery

public void endDTSDiscovery()

End DTS discovery.

Specified by:

endDTSDiscovery in interface DTSCascadeURIResolver

getIterator

public static java.util.Iterator<java.net.URI> getIterator(java.lang.String id)

Gets the iterator.

Parameters:

id - the id

Returns:

the iterator

getEntryPointsIterator

public static java.util.Iterator<java.util.Collection<java.net.URI>> getEntryPointsIterator(java.lang.String id)

Gets the entry points iterator.

Parameters:

id - the id

Returns:

the entry points iterator

copyFile

public static java.nio.file.Path copyFile(java.io.File file)
                                   throws java.io.IOException

Copies the file indicated in the file parameter to the typical directory of taxonomy packages.

Parameters:

file - the file

Returns:

the target file

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

declareInjectedPackage

public static void declareInjectedPackage(TaxonomyPackageURIResolver.TaxonomyPackage tp)

Declare injected package.

Parameters:

tp - the tp

undeclareInjectedPackage

public static void undeclareInjectedPackage(TaxonomyPackageURIResolver.TaxonomyPackage tp)

Undeclare injected package.

Parameters:

tp - the tp

getInjectedTaxonomyPackages

public static java.util.List<TaxonomyPackageURIResolver.TaxonomyPackage> getInjectedTaxonomyPackages()

Gets the injected taxonomy packages.

Returns:

the injected taxonomy packages