com.ihr.xbrl.dataloader

Class LoaderContext

java.lang.Object

com.ihr.xbrl.dataloader.LoaderContext

public final class LoaderContext
extends java.lang.Object

A Loader context is created for each Loader execution and holds the output of the Loader process. LoaderContext are created by calling newLoaderContext() on the LoaderEngine instance

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getExtra(java.lang.String key) Access to an object generated during the transformation using the object key.
java.util.Collection<java.lang.String>	getExtraKeys() Returns a collection of keys for additional information generated during the transformation of an XBRL report to the target format.
java.lang.Object[]	load(javax.xml.transform.Source streamSource) Loads a Loader context from a Source.
void	setExtra(java.lang.String key, java.lang.Object value) Adds a new object to the collection of additional objects generated during a transformation.

Methods inherited from class java.lang.Object

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

Method Detail

load

public java.lang.Object[] load(javax.xml.transform.Source streamSource)
                        throws LoaderException

Loads a Loader context from a Source.

Parameters:

streamSource - the Source

Returns:

array of Object returned from LoaderEngine.load(Source, LoaderContext) using this as LoaderContext

Throws:

LoaderException - the loader exception

See Also:

LoaderEngine.load(Source, LoaderContext)

getExtraKeys

public java.util.Collection<java.lang.String> getExtraKeys()

Returns a collection of keys for additional information generated during the transformation of an XBRL report to the target format. One example is the HTML files embedded inside an XBRL report that are not loaded to a produced Excel file but are hold in the context to be used by applications.

This method does not returns null it returns an empty Collection when no keys exists.

Returns:

Collection of strings

getExtra

public java.lang.Object getExtra(java.lang.String key)

Access to an object generated during the transformation using the object key. Keys are returned in the getExtraKeys() method. If no value is found for the key, null is returned

Parameters:

key - the key

Returns:

the extra

setExtra

public void setExtra(java.lang.String key,
                     java.lang.Object value)

Adds a new object to the collection of additional objects generated during a transformation. This method shall be called by the driver to add the object to the context.

Parameters:

key - string, object key

value - the object value. every driver might generate different object types