com.ihr.xbrl.mapper.source

Class ExcelDataSource

java.lang.Object

com.ihr.xbrl.mapper.source.worksheet.AbstractWorksheetDataSource

com.ihr.xbrl.mapper.source.ExcelDataSource

All Implemented Interfaces:

HasSomethingToSay, HasMethod, HasMult, HasAddMap, HasDataFile, MapeableDataSource, XBRLDataSource, XBRLDataSourceMapIdInUse

public class ExcelDataSource
extends AbstractWorksheetDataSource

The Class ExcelDataSource.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
ExcelDataSource()

Method Summary

Modifier and Type	Method and Description
void	endOfDocument(XBRLInstance instance) Called by the MapEngine when a new instance is finished Can be used to close connections to data sources.
java.lang.Object	getFootnote(java.lang.String mapIdentifier, int index, XBRLFact fact) After a fact is produced the data source is asked for a footnote to be added to the instance document by doing a call to this method.
java.lang.String	getFootnoteLang(java.lang.String mapIdentifier, int index, XBRLFact fact, java.lang.Object footnoteContent) Every footnote MUST have an xml:lang attribute.
java.lang.Object	getSampleData(java.lang.Object data) This method is used by the mapper editor during test cycles of the mapper The implemented class should use the incoming data to produce an object that the mapper can use later to produce an instance document .
SheetPointFactory	getSheetPointFactory() Gets the sheet point factory.
java.lang.String	getTooltip() This is the method that must be implemented by classes that provides the tooltip historical information.
net.sf.saxon.value.AtomicValue	getValue(java.lang.String mapIdentifier, int index, XBRLContext context, net.sf.saxon.type.SimpleType type) Each data item has mapIdentifier string each used concept in the taxonomy has at least one mapIdentifier returns the Value to be sent to the fact item. null is allowed and will be considered as no input data available
boolean	isNil(java.lang.String mapIdentifier, int index, XMLElementDefinition concept) Return true if the concept content is xsi:nil so there will be no request for a value.
void	startOfDocument(XBRLInstance instance, java.lang.Object[] inputs, DTSLoadingBarInterface bar) Called by the MapEngine when a new instance that requires this data source is going to be created.

Methods inherited from class com.ihr.xbrl.mapper.source.worksheet.AbstractWorksheetDataSource

addMap, addOrModifyRound, addRuleMap, createConfigFileContent, createOrGetRoundIdentifier, deleteRegion, delRound, delRuleMap, endOfFact, getApiMessages, getCells, getComments, getConfigFile, getContext, getDataFile, getDefaultZeroValuePolicyType, getExactMode, getExactModeValue, getFootnoteCellAndLang, getFormat, getFormatValue, getHistoricalMessage, getMapId, getMapIdentifierReferences, getMapIterator, getMapSheetPoint, getMethod, getMethod, getMult, getMult, getNumberOfValues, getRound, getRoundingIdentifiers, getRoundMode, getRuleCells, getSourceReference, getUnit, getZeroValuePolicy, init, isConfigfileRequired, isInputFileRequired, isMapIdentifierInUse, isTupleSourceRequired, moveRegion, removeMap, save, setConfigFile, setDataFile, setDefaultRounding, startOfFact, verifyRule

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ihr.xbrl.mapper.source.XBRLDataSource

equals, hashCode

Constructor Detail

ExcelDataSource

public ExcelDataSource()

Method Detail

startOfDocument

public void startOfDocument(XBRLInstance instance,
                            java.lang.Object[] inputs,
                            DTSLoadingBarInterface bar)
                     throws MapException

Description copied from interface: XBRLDataSource

Called by the MapEngine when a new instance that requires this data source is going to be created. Can be used to open connections to data sources. Be careful when processing the inputs because the same mapper could use more than one driver and inputs are shared across all the drivers. Don't assume there will always be just one driver providing data to the mapper.

Parameters:

instance - this is the XBRLInstance document.

inputs - Input parameters, they are different objects for each driver.

bar - this is an optional parameter, if not null, the driver can send messages to inform about the initialization process

Throws:

MapException - the map exception

endOfDocument

public void endOfDocument(XBRLInstance instance)

Description copied from interface: XBRLDataSource

Called by the MapEngine when a new instance is finished Can be used to close connections to data sources.

Specified by:

endOfDocument in interface XBRLDataSource

Overrides:

endOfDocument in class AbstractWorksheetDataSource

Parameters:

instance - this is the XBRLInstance document.

isNil

public boolean isNil(java.lang.String mapIdentifier,
                     int index,
                     XMLElementDefinition concept)

Description copied from interface: XBRLDataSource

Return true if the concept content is xsi:nil so there will be no request for a value.

Specified by:

isNil in interface XBRLDataSource

Overrides:

isNil in class AbstractWorksheetDataSource

Parameters:

mapIdentifier - the map identifier

index - the index

concept - the concept

Returns:

boolean

getValue

public net.sf.saxon.value.AtomicValue getValue(java.lang.String mapIdentifier,
                                               int index,
                                               XBRLContext context,
                                               net.sf.saxon.type.SimpleType type)
                                        throws MapException

Description copied from interface: XBRLDataSource

Each data item has mapIdentifier string each used concept in the taxonomy has at least one mapIdentifier returns the Value to be sent to the fact item. null is allowed and will be considered as no input data available

Parameters:

mapIdentifier - String

index - int

context - XBRLContext the XBRL Context for the fact being reported. The context should not be modified here.

type - This is that target schema type obtained from the element definition

Returns:

net.sf.saxon.Value

Throws:

MapException - the map exception

getFootnote

public java.lang.Object getFootnote(java.lang.String mapIdentifier,
                                    int index,
                                    XBRLFact fact)

Description copied from interface: XBRLDataSource

After a fact is produced the data source is asked for a footnote to be added to the instance document by doing a call to this method. If this method returns null then the concept has no text in a footnote. If this method returns a java.lang.String then the string text will be added as a footnote to the instance document.

Specified by:

getFootnote in interface XBRLDataSource

Overrides:

getFootnote in class AbstractWorksheetDataSource

Parameters:

mapIdentifier - String

index - int

fact - XBRLFactItem

Returns:

Object , null, String or Content

getFootnoteLang

public java.lang.String getFootnoteLang(java.lang.String mapIdentifier,
                                        int index,
                                        XBRLFact fact,
                                        java.lang.Object footnoteContent)

Description copied from interface: XBRLDataSource

Every footnote MUST have an xml:lang attribute. This function is called by the mapping engine in order to obtain the value of the xml:lang attribute for a particular footnote. The call is made after the footnote resource is created.

Specified by:

getFootnoteLang in interface XBRLDataSource

Overrides:

getFootnoteLang in class AbstractWorksheetDataSource

Parameters:

mapIdentifier - the map identifier

index - the index

fact - the fact

footnoteContent - the footnote content

Returns:

String

getSampleData

public java.lang.Object getSampleData(java.lang.Object data)
                               throws MapException

Description copied from interface: XBRLDataSource

This method is used by the mapper editor during test cycles of the mapper The implemented class should use the incoming data to produce an object that the mapper can use later to produce an instance document .

Parameters:

data - object

Returns:

another object

Throws:

MapException - in the case the input object cannot be used

getSheetPointFactory

public SheetPointFactory getSheetPointFactory()

Description copied from class: AbstractWorksheetDataSource

Gets the sheet point factory.

Specified by:

getSheetPointFactory in class AbstractWorksheetDataSource

Returns:

the sheet point factory

getTooltip

public java.lang.String getTooltip()

Description copied from interface: HasSomethingToSay

This is the method that must be implemented by classes that provides the tooltip historical information.

Returns:

the tooltip