com.ihr.xbrl.mapper

Class MapperBase

java.lang.Object

com.ihr.xbrl.mapper.MapperBase

Direct Known Subclasses:

Mapper

public abstract class MapperBase
extends java.lang.Object

A Mapper Base is a base class for implementing a Mapper to convert values from any source to XBRL. This class allows for the basic functionality about adding facts, contexts, sections and data sources

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
MapperBase()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addContext(MapperContext newMapperContext) Adds the context.
java.lang.String	addContext(MapperContext newMapperContext, java.lang.String oldContextId) Adds the context.
void	addFact(MapperFact newMapperFact) Adds the fact.
void	addFactAt(MapperFact newMapperFact, int pos) Adds the fact at.
void	addMapperId(java.lang.String id) Adds the mapper id.
void	addSection(MapperSection mapperSection) This is called internally when a new Fact is added and the fact contains a section that is not on this file.
java.lang.String	addSource(XBRLDataSource ds) Adds the source.
java.lang.String	addUnit(XBRLUnit newUnit) Adds the unit.
java.lang.String	addUnit(XBRLUnit newUnit, java.lang.String oldUnitId) Adds the unit.
void	addWarning(MapperWarningMessage mm) Adds the warning.
java.util.List<java.util.List<java.lang.String>>	checkDuplicates() Verifies the content of the mapper file and explore possible duplicate mappings (same concept for the same context and unit mapped more than once) If this happens the mapper has to make an election during the instance document generation time.
void	clear()
void	createEmptyMapperDoc(java.lang.String scheme, java.lang.String company) Creates an empty MapperDoc.
void	delContext(MapperContext mapperContext) Del context.
void	delFact(MapperFact mapperFact) Del fact.
void	delSection(MapperSection mapperSection) Del section.
void	delUnit(XBRLUnit unit) Del unit.
java.util.List<MapperFact>	getAllFactsForElement(javax.xml.namespace.QName definition) Return all facts associated with this element definition.
java.util.List<java.lang.String>	getAllMapIdentifiersForElement(javax.xml.namespace.QName definition) Return all map identifiers associated with this element definition.
java.lang.String	getCompany() Gets the company.
MapperContext	getContextById(java.lang.String key) Gets the context by id.
java.util.Collection<MapperContext>	getContexts() Gets the contexts.
java.util.Iterator<java.lang.String>	getContextsKeys() Gets the contexts keys.
MapperFact	getFactFromMapIdentifier(java.lang.String mapIdentifier) Returns the Fact associated with the mapIdentifier or null if the mapIdentifier is not associated with any Fact.
java.lang.String	getKeyForSource(XBRLDataSource source) Returns the key used for this XBRLDataSource.
java.lang.String	getMapIdentifierForElement(javax.xml.namespace.QName definition) Return the first map identifier associated to this element definition.
MapperDoc	getMapperDoc() Gets the mapper doc.
java.lang.String	getNewMapIdentifier(XMLElementDefinition element) Generates a new identifier for the element used as a parameter.
java.lang.String	getScheme() Gets the scheme.
MapperSection	getSectionForKey(java.lang.String key) Gets the MapperSection for key or null if not found.
java.util.Collection<MapperSection>	getSections() Gets all the sections.
XBRLDataSource	getSourceForKey(java.lang.String key) Returns the XBRLDataSource object associated with the specified key.
java.util.Set<java.lang.String>	getSourceKeys() Returns the set of keys for data sources for this mapper.
XBRLUnit	getUnitById(java.lang.String key) Gets the unit by id.
XBRLUnit	getUnitForKey(java.lang.String key) Returns the XBRLUnit object associated with the specified key.
java.util.Set<java.lang.String>	getUnitKeys() Returns the set of keys for units for this mapper.
abstract MapVersion	getVersion() Gets the version.
void	setCompany(java.lang.String company) Sets the company.
void	setMapperDoc(MapperDoc mapperDoc) Sets the mapper doc.
void	setScheme(java.lang.String scheme) Sets the scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapperBase

public MapperBase()

Method Detail

addFact

public void addFact(MapperFact newMapperFact)
             throws MapConfigurationFileException

Adds the fact.

Parameters:

newMapperFact - the new mapper fact

Throws:

MapConfigurationFileException - the map configuration file exception

addFactAt

public void addFactAt(MapperFact newMapperFact,
                      int pos)
               throws MapConfigurationFileException

Adds the fact at.

Parameters:

newMapperFact - the new mapper fact

pos - the pos

Throws:

MapConfigurationFileException - the map configuration file exception

delFact

public void delFact(MapperFact mapperFact)

Del fact.

Parameters:

mapperFact - the mapper fact

getVersion

public abstract MapVersion getVersion()

Gets the version.

Returns:

the version

getScheme

public java.lang.String getScheme()

Gets the scheme.

Returns:

the scheme

setScheme

public void setScheme(java.lang.String scheme)

Sets the scheme.

Parameters:

scheme - the new scheme

getCompany

public java.lang.String getCompany()

Gets the company.

Returns:

the company

setCompany

public void setCompany(java.lang.String company)

Sets the company.

Parameters:

company - the new company

createEmptyMapperDoc

public void createEmptyMapperDoc(java.lang.String scheme,
                                 java.lang.String company)

Creates an empty MapperDoc.

Parameters:

scheme - the scheme

company - the company

getMapperDoc

public MapperDoc getMapperDoc()

Gets the mapper doc.

Returns:

the mapper doc

setMapperDoc

public void setMapperDoc(MapperDoc mapperDoc)

Sets the mapper doc.

Parameters:

mapperDoc - the new mapper doc

getKeyForSource

public java.lang.String getKeyForSource(XBRLDataSource source)
                                 throws MapConfigurationFileException

Returns the key used for this XBRLDataSource. This is not efficient because sources are indexed by ID but this is not a problem because only GUIs are interested on this function and there will presumably be quite a small number of sources.

This method returns null if the source is not found.

Parameters:

source - XBRLDataSource

Returns:

String

Throws:

MapConfigurationFileException - the map configuration file exception

addMapperId

public void addMapperId(java.lang.String id)

Adds the mapper id.

Parameters:

id - the id

addSource

public java.lang.String addSource(XBRLDataSource ds)

Adds the source.

Parameters:

ds - the ds

Returns:

the new source key

addSection

public void addSection(MapperSection mapperSection)

This is called internally when a new Fact is added and the fact contains a section that is not on this file.

It is also possible calling this method for adding sections in advance

Parameters:

mapperSection - Section to be added

delSection

public void delSection(MapperSection mapperSection)

Del section.

Parameters:

mapperSection - the section

getContexts

public java.util.Collection<MapperContext> getContexts()

Gets the contexts.

Returns:

the contexts

getContextsKeys

public java.util.Iterator<java.lang.String> getContextsKeys()

Gets the contexts keys.

Returns:

the contexts keys

getContextById

public MapperContext getContextById(java.lang.String key)

Gets the context by id.

Parameters:

key - the key

Returns:

the context by id

getUnitById

public XBRLUnit getUnitById(java.lang.String key)

Gets the unit by id.

Parameters:

key - the key

Returns:

the unit by id

getSections

public java.util.Collection<MapperSection> getSections()

Gets all the sections.

Returns:

the sections

getSectionForKey

public MapperSection getSectionForKey(java.lang.String key)

Gets the MapperSection for key or null if not found.

Parameters:

key - the key

Returns:

the MapperSection for key

addUnit

public java.lang.String addUnit(XBRLUnit newUnit)

Adds the unit.

Parameters:

newUnit - the new unit

Returns:

the string

addUnit

public java.lang.String addUnit(XBRLUnit newUnit,
                                java.lang.String oldUnitId)

Adds the unit.

Parameters:

newUnit - the new unit

oldUnitId - the old unit id

Returns:

the string

addContext

public java.lang.String addContext(MapperContext newMapperContext,
                                   java.lang.String oldContextId)

Adds the context.

Parameters:

newMapperContext - the new context

oldContextId - maybe null

Returns:

the string

addContext

public java.lang.String addContext(MapperContext newMapperContext)

Adds the context.

Parameters:

newMapperContext - the new context

Returns:

the string

delContext

public void delContext(MapperContext mapperContext)

Del context.

Parameters:

mapperContext - the context

delUnit

public void delUnit(XBRLUnit unit)

Del unit.

Parameters:

unit - the unit

getNewMapIdentifier

public java.lang.String getNewMapIdentifier(XMLElementDefinition element)

Generates a new identifier for the element used as a parameter. This operation is not thread safe. The returned value may be duplicate if multiple calls to this method are made without a method to add the new generated Fact

Parameters:

element - the element

Returns:

the new map identifier

getSourceKeys

public java.util.Set<java.lang.String> getSourceKeys()

Returns the set of keys for data sources for this mapper.

Returns:

Set<String> with all data source keys

getSourceForKey

public XBRLDataSource getSourceForKey(java.lang.String key)
                               throws MapConfigurationFileException

Returns the XBRLDataSource object associated with the specified key.

Parameters:

key - string

Returns:

XBRLDataSource

Throws:

MapConfigurationFileException - the map configuration file exception

getUnitKeys

public java.util.Set<java.lang.String> getUnitKeys()

Returns the set of keys for units for this mapper.

Returns:

Set<String> with all unit keys

Since:

2.6.11

getUnitForKey

public XBRLUnit getUnitForKey(java.lang.String key)

Returns the XBRLUnit object associated with the specified key.

Parameters:

key - string

Returns:

XBRLUnit

Since:

2.6.11

getMapIdentifierForElement

public java.lang.String getMapIdentifierForElement(javax.xml.namespace.QName definition)

Return the first map identifier associated to this element definition.

Parameters:

definition - XMLElementDefinition

Returns:

String or null if not found

getAllMapIdentifiersForElement

public java.util.List<java.lang.String> getAllMapIdentifiersForElement(javax.xml.namespace.QName definition)

Return all map identifiers associated with this element definition.

Parameters:

definition - XMLElementDefinition

Returns:

Vector<String>

getAllFactsForElement

public java.util.List<MapperFact> getAllFactsForElement(javax.xml.namespace.QName definition)

Return all facts associated with this element definition.

Parameters:

definition - XMLElementDefinition

Returns:

Vector<Fact>

getFactFromMapIdentifier

public MapperFact getFactFromMapIdentifier(java.lang.String mapIdentifier)

Returns the Fact associated with the mapIdentifier or null if the mapIdentifier is not associated with any Fact.

Parameters:

mapIdentifier - string, key unique for each mapIdentifier

Returns:

the MapperFact object associated with this key

clear

public void clear()
           throws java.lang.Throwable

Throws:

java.lang.Throwable

checkDuplicates

public java.util.List<java.util.List<java.lang.String>> checkDuplicates()
                                                                 throws MapConfigurationFileException

Verifies the content of the mapper file and explore possible duplicate mappings (same concept for the same context and unit mapped more than once) If this happens the mapper has to make an election during the instance document generation time.

If two (or more) facts are mapped to income data one of the following may occurs:

• The user may want to force duplicates to be processed independently, possibly generating duplicate facts in the output instance
• The user may be interested in grouping the duplicates in a "sequence reduction" processing unit. In this case, the output of a "sequence reduction processing unit" will always be the minimum number of non duplicate facts.

Returns:

a List of List of Strings. The string matches a fact identifier. The most internal nested List contains the all fact identifiers that belongs to a duplicate group. The most external List is a List of the groups of identifiers.

Throws:

MapConfigurationFileException - the map configuration file exception

addWarning

public void addWarning(MapperWarningMessage mm)

Adds the warning.

Parameters:

mm - the mm