com.ihr.xbrl.om.resolvers

Class DynamicCacheCatalogResolver

java.lang.Object

com.ihr.xbrl.om.resolvers.DynamicCacheCatalogResolver

All Implemented Interfaces:

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

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

The Dynamic Cache Catalog Resolver obtain DTS files that has been stored on disk during DTS Discovery process prior to this one. The idea is, during DTS Discovery, if a file is on the Internet, a copy of the remote file is stored locally and used in the DTS. In a second step. this DynamicCacheCatalogResolver is able to return the previously stored file to speed-up DTS Discovery TODO: This catalog maintains a copy of downloaded files for 2 days. But the users are not aware of how it works there is a need to add a menu/button or whatever in the GUI to clear the cache content. For example, if an user tried to download a file without Internet connection, the dynamic catalog stores a file that is invalid because of lack of capacity to download the file, but later the user fix the Internet connection problem. The user will not be able to download the files until after 2 days later which is annoying for them. This is why the error message might contain a message or even a button to clear the cache content. The GUI shall call a method on this class to clear cache content and this method here shall be responsible of removing files downloaded from the Internet

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	typicalDirectoryOfPackages The Constant typicalDirectoryOfPackages.

Constructor Summary

Constructors

Constructor and Description
DynamicCacheCatalogResolver(net.sf.saxon.lib.SchemaURIResolver nextResolver) Instantiates a new dynamic cache catalog resolver.
DynamicCacheCatalogResolver(javax.xml.transform.URIResolver nextResolver) Instantiates a new dynamic cache catalog resolver.

Method Summary

Modifier and Type	Method and Description
void	endDTSDiscovery() End DTS discovery.
javax.xml.transform.URIResolver	getNextResolver() Gets the next resolver.
net.sf.saxon.lib.SchemaURIResolver	getNextSchemaResolver() Gets the next schema resolver.
static void	reset() This method removes all cache content already loaded into the memory cache and downloaded files so the next time it is used it starts from a clean dynamic cache.
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	storeSystemId(java.lang.String systemId, java.io.File dir) Store system id.

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

Constructor Detail

DynamicCacheCatalogResolver

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

Instantiates a new dynamic cache catalog resolver.

Parameters:

nextResolver - the next resolver

DynamicCacheCatalogResolver

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

Instantiates a new dynamic cache catalog resolver.

Parameters:

nextResolver - the next resolver

Method Detail

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.

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

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

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

reset

public static void reset()

This method removes all cache content already loaded into the memory cache and downloaded files so the next time it is used it starts from a clean dynamic cache.

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

storeSystemId

public static void storeSystemId(java.lang.String systemId,
                                 java.io.File dir)

Store system id.

Parameters:

systemId - the system id

dir - the dir