com.ihr.xbrl.dataloader.target

Class NullDriver

java.lang.Object

com.ihr.xbrl.dataloader.target.NullDriver

All Implemented Interfaces:

XBRLLoaderInterface

public class NullDriver
extends java.lang.Object
implements XBRLLoaderInterface

This is a driver that receives events to load xbrl data but does nothing with that data.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
NullDriver()

Method Summary

Modifier and Type	Method and Description
void	addMap(java.lang.String mapIdentifier, java.lang.Object info, XBRLDataSource source) Used to programmatically add an entry on this XBRLLoaderInterface.
XBRLTransformationResult	createNewResult(DTSContainer dts) Creates a new document container.
void	endOfDocument() Called by the transformation processor to indicate the end of a document processing Usually a document footer is produced.
java.net.URI	getConfigFile() Returns back the URI of the configuration file.
XBRLFilterContext	getFilterContext() Returns an instance of the XBRLFilterContext class that will be used to pick up the appropriate context.
void	init() This method is called by the loader just after object has been created and if a configuration file is set (which is an optional step only if configuration file is indicated as a parameter) This method should read the configuration file and set values for constants and things like that.
void	processContexts(java.util.Iterator<XBRLContext> contexts) Called by the transformation processor to provide the contexts for the data that will be found later during the processing of facts the default process updates the content of some variables. or calculates number of columns, rows.
void	processFact(java.lang.String identifier, XBRLFact fact) Called by the processor to inform about a new fact that requires processing.
void	setConfigFile(java.net.URI configFile) This method is called by the loader when a new loader is just created and for each one of the drivers that exist on the loader configuration file and only if the driver has a parameter indicating the URL of the configuration file Next call is XBRLLoaderInterface.init().
void	setLoaderContext(LoaderContext lc) Temporally sets a loader context during the transformation of an XBRL report to the destination target.
void	startOfDocument(XBRLInstance instance) Called by the transformation processor to indicate the start of a new document.
void	writeConfigFile(DTSContainer dts) Serializes the configuration file back to the URI assigned in the configuration file from the internal data model.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullDriver

public NullDriver()

Method Detail

createNewResult

public XBRLTransformationResult createNewResult(DTSContainer dts)
                                         throws FactHandlerException

Description copied from interface: XBRLLoaderInterface

Creates a new document container. This method is the first one called when a new instance document requires to be processed. This method can be used to open connections to the target repository. Next call is XBRLLoaderInterface.startOfDocument(XBRLInstance)

Specified by:

createNewResult in interface XBRLLoaderInterface

Parameters:

dts - the dts

Returns:

XBRLTransformationResult an object that implements the XBRLTransformationResult interface.

Throws:

FactHandlerException - if anything goes wrong.

endOfDocument

public void endOfDocument()

Description copied from interface: XBRLLoaderInterface

Called by the transformation processor to indicate the end of a document processing Usually a document footer is produced. Or the transaction is committed. There is no a next call.

Specified by:

endOfDocument in interface XBRLLoaderInterface

getConfigFile

public java.net.URI getConfigFile()

Description copied from interface: XBRLLoaderInterface

Returns back the URI of the configuration file.

Specified by:

getConfigFile in interface XBRLLoaderInterface

Returns:

URI

init

public void init()
          throws LoaderConfigurationFileException

Description copied from interface: XBRLLoaderInterface

This method is called by the loader just after object has been created and if a configuration file is set (which is an optional step only if configuration file is indicated as a parameter) This method should read the configuration file and set values for constants and things like that. Next call is XBRLLoaderInterface.createNewResult(DTSContainer)

Specified by:

init in interface XBRLLoaderInterface

Throws:

LoaderConfigurationFileException - the loader configuration file exception

processContexts

public void processContexts(java.util.Iterator<XBRLContext> contexts)

Description copied from interface: XBRLLoaderInterface

Called by the transformation processor to provide the contexts for the data that will be found later during the processing of facts the default process updates the content of some variables. or calculates number of columns, rows. Next call is XBRLLoaderInterface.processFact(String, XBRLFact) for facts that passes the filters established by the loader engine and are the true loading events.

Specified by:

processContexts in interface XBRLLoaderInterface

Parameters:

contexts - Iterator<XBRLContext>

processFact

public void processFact(java.lang.String identifier,
                        XBRLFact fact)
                 throws FactHandlerException

Description copied from interface: XBRLLoaderInterface

Called by the processor to inform about a new fact that requires processing. This is where the real loading event is handled by the driver. Next call is XBRLLoaderInterface.endOfDocument() when the instance document is finished and no more events needs to be generated

Specified by:

processFact in interface XBRLLoaderInterface

Parameters:

identifier - as String which is the identifier code in the loader configuration file.

fact - XBRLFact the loaded fact

Throws:

FactHandlerException - if something goes wrong.

setConfigFile

public void setConfigFile(java.net.URI configFile)

Description copied from interface: XBRLLoaderInterface

This method is called by the loader when a new loader is just created and for each one of the drivers that exist on the loader configuration file and only if the driver has a parameter indicating the URL of the configuration file Next call is XBRLLoaderInterface.init().

Specified by:

setConfigFile in interface XBRLLoaderInterface

Parameters:

configFile - the new config file

startOfDocument

public void startOfDocument(XBRLInstance instance)
                     throws FactHandlerException

Description copied from interface: XBRLLoaderInterface

Called by the transformation processor to indicate the start of a new document. Usually a document header is produced. A new template document is initialized or a transaction is created. Next call is XBRLLoaderInterface.processContexts(Iterator)

Specified by:

startOfDocument in interface XBRLLoaderInterface

Parameters:

instance - the instance

Throws:

FactHandlerException - the fact handler exception

getFilterContext

public XBRLFilterContext getFilterContext()

Description copied from interface: XBRLLoaderInterface

Returns an instance of the XBRLFilterContext class that will be used to pick up the appropriate context.

Specified by:

getFilterContext in interface XBRLLoaderInterface

Returns:

XBRLFilterContext

addMap

public void addMap(java.lang.String mapIdentifier,
                   java.lang.Object info,
                   XBRLDataSource source)

Description copied from interface: XBRLLoaderInterface

Used to programmatically add an entry on this XBRLLoaderInterface. The source parameter may be null. When the Loader is creating a new configuration from a Mapper, the source contains the source driver for data. This can be used to obtain additional properties for example the multiplier used in the excel driver and translate the multiplier to the export rules.

Specified by:

addMap in interface XBRLLoaderInterface

Parameters:

mapIdentifier - the map identifier

info - the info

source - the XBRLDataSource if any exists. This argument may be null.

writeConfigFile

public void writeConfigFile(DTSContainer dts)
                     throws LoaderException

Description copied from interface: XBRLLoaderInterface

Serializes the configuration file back to the URI assigned in the configuration file from the internal data model.

Specified by:

writeConfigFile in interface XBRLLoaderInterface

Parameters:

dts - the dts

Throws:

LoaderException - the loader exception

setLoaderContext

public void setLoaderContext(LoaderContext lc)

Description copied from interface: XBRLLoaderInterface

Temporally sets a loader context during the transformation of an XBRL report to the destination target. The Loader Context shall be informed about relevant information that happened during the transformation. The loader context will be set to null when the transformation finishes but the loader context is available to the application requesting the transformation

Specified by:

setLoaderContext in interface XBRLLoaderInterface

Parameters:

lc - the instance of the LoaderContext or null to reset