com.ihr.xbrl.mapper.instance

Class MapperDoc

java.lang.Object

com.ihr.xbrl.mapper.instance.MapperDoc

public class MapperDoc
extends java.lang.Object

This class represents the root xml document in the mapper.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
MapperDoc(DTSContainer dts, MapperBase mapperBase, XMLDocumentImpl xmlDocumentImpl) Instantiates a new mapper xbrlMap document.

Method Summary

Modifier and Type	Method and Description
void	addContext(MapperContext newMapperContext) Adds a new MapperContext node.
void	addSection(MapperSection newMapperSection) Adds a new MapperSection node.
void	addSource(XBRLDataSource ds, java.net.URI uriOfConfigFile, java.lang.String key) Adds a XBRLDataSource as a MapperSource child node.
void	addUnit(XBRLUnit newUnit) Adds a new unit.
void	clear()
void	commit()
void	delContext(MapperContext mapperContext) Deletes a MapperContext node.
void	delSection(MapperSection mapperSection) Deletes a MapperSection node.
void	delUnit(XBRLUnit unit) Deletes a unit.
java.lang.String	getCompany() Gets the MapperContexts company.
DTSContainer	getContainer() Returns the DTS Container object.
MapperDataSources	getDataSources() Gets the MapperDataSources node.
MapperDts	getDts() Gets the MapperDts node.
MapperFacts	getFacts()
MapperInstance	getInstance() Obtains the MapperInstance instance.
java.lang.String	getKeyForSource(XBRLDataSource ds) Gets de source key associated from the XBRLDataSource specified.
MapperBase	getMapperBase() Gets the MapperBase.
MapperFacts	getOrCreateMapperFacts()
MapperRootNode	getRootNode()
java.lang.String	getScheme() Gets the MapperContexts scheme.
MapperSection	getSectionForKey(java.lang.String key) Gets the MapperSection for key or null if not found.
java.util.Collection<MapperSection>	getSections() Gets all MapperSection as a Collection.
XBRLDataSource	getSourceForKey(java.lang.String key) Get the XBRLDataSource from the source key specified or null if not found.
java.util.Set<java.lang.String>	getSourceKeys() Gets the set of source keys.
java.util.Iterator<MapperSource>	getSources() Gets a iterator over MapperSource child nodes.
java.net.URI	getUriOfConfigFile() Gets the uri of config file.
XMLDocumentImpl	getXMLDocumentImpl() Gets the XMLDocumentImpl.
void	setCompany(java.lang.String company) Sets the company for MapperContexts node.
void	setDataSources(MapperDataSources mapperDataSources) Sets the MapperDataSources node.
void	setDts(MapperDts mapperDts) Sets the MapperDts node.
void	setInstance(MapperInstance mapperInstance) Sets the MapperInstance node.
void	setRootNode(MapperRootNode mapperRootNode)
void	setScheme(java.lang.String scheme) Sets the scheme for MapperContexts node.
void	setUriOfConfigFile(java.net.URI uriOfConfigFile) Sets the uri of config file.
void	setXMLDocumentImpl(XMLDocumentImpl xmlDocumentImpl) Sets the XMLDocumentImpl.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapperDoc

public MapperDoc(DTSContainer dts,
                 MapperBase mapperBase,
                 XMLDocumentImpl xmlDocumentImpl)

Instantiates a new mapper xbrlMap document. If xmlDocumentImpl parameter is null, a call to setXMLDocumentImpl() is obligatory. This is the case of MapperKeyElementsInterceptor.startDocument() SAX call.

Parameters:

dts - the container

mapperBase - the MapperBase

xmlDocumentImpl - the XMLDocumentImpl or null

Method Detail

addUnit

public void addUnit(XBRLUnit newUnit)

Adds a new unit.

Parameters:

newUnit - the new unit

delUnit

public void delUnit(XBRLUnit unit)

Deletes a unit.

Parameters:

unit - to delete

getContainer

public DTSContainer getContainer()

Returns the DTS Container object.

Returns:

DTSContainer

getDataSources

public MapperDataSources getDataSources()

Gets the MapperDataSources node.

Returns:

MapperDataSources

getDts

public MapperDts getDts()

Gets the MapperDts node.

Returns:

MapperDts

getXMLDocumentImpl

public XMLDocumentImpl getXMLDocumentImpl()

Gets the XMLDocumentImpl.

Returns:

setDts

public void setDts(MapperDts mapperDts)

Sets the MapperDts node.

Parameters:

mapperDts - the new dts

commit

public void commit()

getFacts

public MapperFacts getFacts()

getOrCreateMapperFacts

public MapperFacts getOrCreateMapperFacts()

getRootNode

public MapperRootNode getRootNode()

setRootNode

public void setRootNode(MapperRootNode mapperRootNode)

getScheme

public java.lang.String getScheme()

Gets the MapperContexts scheme.

Returns:

scheme

getCompany

public java.lang.String getCompany()

Gets the MapperContexts company.

Returns:

company

setInstance

public void setInstance(MapperInstance mapperInstance)

Sets the MapperInstance node.

Parameters:

mapperInstance - the new instance

getInstance

public MapperInstance getInstance()

Obtains the MapperInstance instance.

Returns:

MapperInstance

addSection

public void addSection(MapperSection newMapperSection)

Adds a new MapperSection node.

Parameters:

newMapperSection - the new mapper section

delSection

public void delSection(MapperSection mapperSection)

Deletes a MapperSection node.

Parameters:

mapperSection - the mapper section

addSource

public void addSource(XBRLDataSource ds,
                      java.net.URI uriOfConfigFile,
                      java.lang.String key)

Adds a XBRLDataSource as a MapperSource child node.

Parameters:

ds - the XBRLDataSource

uriOfConfigFile - the uri of config file

key - the key

setDataSources

public void setDataSources(MapperDataSources mapperDataSources)

Sets the MapperDataSources node.

Parameters:

mapperDataSources - the new data sources

setXMLDocumentImpl

public void setXMLDocumentImpl(XMLDocumentImpl xmlDocumentImpl)

Sets the XMLDocumentImpl.

Parameters:

xmlDocumentImpl -

setUriOfConfigFile

public void setUriOfConfigFile(java.net.URI uriOfConfigFile)

Sets the uri of config file.

Parameters:

uriOfConfigFile - the new uri of config file

getUriOfConfigFile

public java.net.URI getUriOfConfigFile()

Gets the uri of config file.

Returns:

URI

delContext

public void delContext(MapperContext mapperContext)

Deletes a MapperContext node.

Parameters:

mapperContext - the mapper context

addContext

public void addContext(MapperContext newMapperContext)

Adds a new MapperContext node.

Parameters:

newMapperContext - the new mapper context

getMapperBase

public MapperBase getMapperBase()

Gets the MapperBase.

Returns:

MapperBase

getSourceForKey

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

Get the XBRLDataSource from the source key specified or null if not found.

Parameters:

key - the key

Returns:

XBRLDataSource

Throws:

MapConfigurationFileException - the map configuration file exception

getKeyForSource

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

Gets de source key associated from the XBRLDataSource specified.

Parameters:

ds - the XBRLDataSource

Returns:

the source key

Throws:

MapConfigurationFileException - the map configuration file exception

getSourceKeys

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

Gets the set of source keys.

Returns:

set source keys

getSources

public java.util.Iterator<MapperSource> getSources()

Gets a iterator over MapperSource child nodes.

Returns:

MapperSource iterator

setScheme

public void setScheme(java.lang.String scheme)

Sets the scheme for MapperContexts node.

Parameters:

scheme - the new scheme

setCompany

public void setCompany(java.lang.String company)

Sets the company for MapperContexts node.

Parameters:

company - the new company

getSections

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

Gets all MapperSection as a Collection.

Returns:

MapperSection Collection

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

clear

public void clear()
           throws java.lang.Throwable

Throws:

java.lang.Throwable