RSRemoteCatalogResolver

java.lang.Object
- com.ihr.xbrl.om.resolvers.RSRemoteCatalogResolver

All Implemented Interfaces:

DTSCascadeURIResolver, javax.xml.transform.URIResolver
```
public class RSRemoteCatalogResolver
extends java.lang.Object
implements DTSCascadeURIResolver
```
This resolver is inserted to allow for dynamic installation of taxonomy packages.
The idea is that if a file is not in the ZIP Catalog and not in the XML Catalog this resolver will try to obtain a reference of the target file. The file is not locally installed so it will be required to go throw the Internet or open a file connection. In case of using the Internet, this class can capture the request and do further work:
1. Can inform Reporting Standard about the existence of a new taxonomy and we can add it to the local (zip) catalog (optional feature)
2. Can investigate the content of the dynamic catalog and let the user install the taxonomy to work "offline" if the taxonomy already exist there
3. Can request Reporting Standard to install the taxonomy and made it available through the dynamic catalog in a future edition
The dynamic catalog content is static and located at a fixed URL.
Author:

Ignacio

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RSRemoteCatalogResolver.CatalogFormat` The Enum CatalogFormat.
`static class`	`RSRemoteCatalogResolver.StaticCatalogEntry` This is the object model representation of an entry in the static catalog.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`IGNOREALLREQUESTS` If this property is set to "true" this catalog will be disabled and no requests about the StaticCatalog file will be ever sent.
`static java.lang.String`	`LocalCopyMasterCatalogFileName` The local copy file name.
`static java.lang.String`	`StaticCatalogNamespace` The Static catalog namespace.
`static java.lang.String`	`SYNCHRONIZEREMOTECATALOG` The synchronizeremotecatalog.

Constructor Summary

Constructors
Constructor and Description
`RSRemoteCatalogResolver(RSRemoteCatalogGUI theGUI, javax.xml.transform.URIResolver nextResolver)` Creates an instance of this resolver and sets the resolver passed in as the next resolver to be used Also, sets the instance of the class that will implement all dialogs with the end user in order to interact and ask questions and obtain feedback.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`endDTSDiscovery()` End DTS discovery.
`static java.util.Collection<RSRemoteCatalogResolver.StaticCatalogEntry>`	`getEntries()` Gets the entries.
`static RSRemoteCatalogResolver.StaticCatalogEntry`	`getEntry(java.lang.String id)` Returns the entry that corresponds with the id passed in as parameter if no entry exists in the catalog with that id, then null is returned.
`static java.util.Date`	`getLocalFileLastTimeUpdated()` Gets the local file last time updated.
`javax.xml.transform.URIResolver`	`getNextResolver()` Gets the next resolver.
`static java.util.Date`	`getRemoteFileLastTimeUpdated()` Gets the remote file last time updated.
`static boolean`	`getSynchronizeRemoteCatalog()` Gets the synchronize remote catalog.
`static java.lang.Object`	`getVersion(java.lang.String packageID)` Access to the version number of a package in the remote catalog returns the version number or 0 if it does not exists.
`static void`	`installEntry(java.lang.String id, InstallCallBack gui)` Install entry.
`static void`	`processNewFile(InstallCallBack installCallback)` Process new file.
`static void`	`removeIgnoreMessages()` Removes the ignore messages.
`javax.xml.transform.Source`	`resolve(java.lang.String href, java.lang.String base)` Resolve.
`void`	`setNextResolver(javax.xml.transform.URIResolver newNextResolver)` Sets the next resolver.
`static boolean`	`setSynchronizeRemoteCatalog(boolean newValue)` Sets the synchronize remote catalog.
`void`	`startDTSDiscovery()` Start DTS discovery.
`static void`	`updateRemoteCatalog()` This method physically copies the remote file into the local destination.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LocalCopyMasterCatalogFileName
```
public static final java.lang.String LocalCopyMasterCatalogFileName
```
    The local copy file name.
    
    See Also:
    
    Constant Field Values
  - IGNOREALLREQUESTS
```
public static final java.lang.String IGNOREALLREQUESTS
```
    If this property is set to "true" this catalog will be disabled and no requests about the StaticCatalog file will be ever sent. The default value for this property is "false"
    
    See Also:
    
    Constant Field Values
  - SYNCHRONIZEREMOTECATALOG
```
public static final java.lang.String SYNCHRONIZEREMOTECATALOG
```
    The synchronizeremotecatalog.
    
    See Also:
    
    Constant Field Values
  - StaticCatalogNamespace
```
public static final java.lang.String StaticCatalogNamespace
```
    The Static catalog namespace.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RSRemoteCatalogResolver
```
public RSRemoteCatalogResolver(RSRemoteCatalogGUI theGUI,
                               javax.xml.transform.URIResolver nextResolver)
```
    Creates an instance of this resolver and sets the resolver passed in as the next resolver to be used
    Also, sets the instance of the class that will implement all dialogs with the end user in order to interact and ask questions and obtain feedback.
    
    Parameters:
    
    theGUI - the the gui
    
    nextResolver - the next resolver
- Method Detail
  - getVersion
```
public static java.lang.Object getVersion(java.lang.String packageID)
```
    Access to the version number of a package in the remote catalog returns the version number or 0 if it does not exists.
    
    Parameters:
    
    packageID - the package id
    
    Returns:
    
    version number as integer
  - installEntry
```
public static void installEntry(java.lang.String id,
                                InstallCallBack gui)
```
    Install entry.
    
    Parameters:
    
    id - the id
    
    gui - the gui
  - getEntries
```
public static java.util.Collection<RSRemoteCatalogResolver.StaticCatalogEntry> getEntries()
```
    Gets the entries.
    
    Returns:
    
    the entries
  - getLocalFileLastTimeUpdated
```
public static java.util.Date getLocalFileLastTimeUpdated()
```
    Gets the local file last time updated.
    
    Returns:
    
    the file last time updated
  - getRemoteFileLastTimeUpdated
```
public static java.util.Date getRemoteFileLastTimeUpdated()
```
    Gets the remote file last time updated.
    
    Returns:
    
    the file last time updated
  - removeIgnoreMessages
```
public static void removeIgnoreMessages()
```
    Removes the ignore messages.
  - getSynchronizeRemoteCatalog
```
public static boolean getSynchronizeRemoteCatalog()
```
    Gets the synchronize remote catalog.
    
    Returns:
    
    the synchronize remote catalog
  - setSynchronizeRemoteCatalog
```
public static boolean setSynchronizeRemoteCatalog(boolean newValue)
```
    Sets the synchronize remote catalog.
    
    Parameters:
    
    newValue - the new value
    
    Returns:
    
    true, if successful
  - 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
  - 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
  - updateRemoteCatalog
```
public static void updateRemoteCatalog()
                                throws java.io.IOException
```
    This method physically copies the remote file into the local destination.
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - processNewFile
```
public static void processNewFile(InstallCallBack installCallback)
```
    Process new file.
    
    Parameters:
    
    installCallback - the install callback
  - getEntry
```
public static RSRemoteCatalogResolver.StaticCatalogEntry getEntry(java.lang.String id)
```
    Returns the entry that corresponds with the id passed in as parameter if no entry exists in the catalog with that id, then null is returned.
    
    Parameters:
    
    id - the catalog entry id
    
    Returns:
    
    null if no entry exists for that id or StaticVatalogEntry instance
  - 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

Class RSRemoteCatalogResolver

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LocalCopyMasterCatalogFileName

IGNOREALLREQUESTS

SYNCHRONIZEREMOTECATALOG

StaticCatalogNamespace

Constructor Detail

RSRemoteCatalogResolver

Method Detail

getVersion

installEntry

getEntries

getLocalFileLastTimeUpdated

getRemoteFileLastTimeUpdated

removeIgnoreMessages

getSynchronizeRemoteCatalog

setSynchronizeRemoteCatalog

resolve

getNextResolver

setNextResolver

updateRemoteCatalog

processNewFile

getEntry

startDTSDiscovery

endDTSDiscovery