com.ihr.xbrl.dts

Class DimensionalInstanceExplorer

java.lang.Object

com.ihr.xbrl.dts.InstanceExplorerAbstract

com.ihr.xbrl.dts.DimensionalInstanceExplorer

All Implemented Interfaces:

ContextProvider, InstanceExplorerInterface, InstanceExplorerListener, UnitsProvider

public class DimensionalInstanceExplorer
extends InstanceExplorerAbstract

This class provides methods to investigate the content of an XBRL instance document from a high level point of view so the development of tools reading the content of instance document will be much easier.

Author:

Ignacio

Field Summary

Fields inherited from class com.ihr.xbrl.dts.InstanceExplorerAbstract

ACUM_Q1Q3, ALL, DAYS, FREE, HALVES, HOURS, INSTANT, MINUTES, MONTHS, NONSTANDARD, notesOrderer, QUARTERS, QUARTERS4, sAcumQ1Q3, sDays, SECONDS, sForever, sHalves, sHours, sMinutes, sMonths, sNonstandard, sQuarters, sSeconds, sWeeks, sYears, unknownUnit, WEEKS, YEARS

Constructor Summary

Constructors

Constructor and Description
DimensionalInstanceExplorer(LangsProvider lp, HasBoySupport hb, HasDimensionsTableHeaderItem hdth, HasAccessSelectedRole instanceDocumentPane, DefaultUnitProviderInterface defaultUnitProvider) Instantiates a new dimensional instance explorer.

Method Summary

Modifier and Type	Method and Description
void	addContext(XBRLContext newContext) Adds the context.
void	addFact(XBRLFact fact) Adds the fact.
void	addFragmentMember(XMLFragmentMember frMem, java.lang.String text) Adds a member to a typed dimension Forwards messages accordingly.
void	clear() Clear.
void	delFact(XBRLFact fact, XBRLFactsList parent) Del fact.
void	factChangedContext(XBRLFactItem fact, XBRLContext oldContext, XBRLContext newContext) Fact changed context.
void	factChangedUnit(XBRLFactNumeric fact, XBRLUnit oldUnit, XBRLUnit newUnit) Fact changed unit.
XBRLFactItem	findFact(java.util.Collection<Member<?>> allMembers) Find fact.
XBRLFactItem	findFact(java.util.Collection<Member<?>> allMembers, java.util.List<InstanceExplorerEvent> evList) Find fact.
java.util.Iterator<XBRLContext>	getCompatibleContexts(XBRLFactItem fact) Gets the compatible contexts.
Dimension<?>	getDimensionFromQName(javax.xml.namespace.QName name) Gets the dimension from the "name" parameter that applies for the selected primary item.
XBRLInstance	getInstance() Gets the single instance of DimensionalInstanceExplorer.
java.util.Collection<ClsPackQNameContainer>	getItemDimensions(XMLElementDefinition item, XBRLRoleType role) Returns a collection of dimensions that are applicable for this primary item.
TypedDimensionsDomainController	getTypedDimensionsDomainController() Gets the typed dimensions domain controller.
XDTInfosetConsumer	getXDTInfosetConsumer() Access to the XDTInfosetConsumer linked with this DimensionalIntanceExplorer.
XDTProcessor	getXDTProc() Access to the XDTProcessor linked with this DimensionalInstanceExplorer.
void	resetDuplicatesDimension() Reset duplicates dimension.
void	resetTypedDimensions() Clear typed dimension members.
void	setInstance(XBRLInstance instance) Sets the instance.
void	setNewColumns(boolean value) Sets the new columns.
void	setTypedDimensionsDomainController(TypedDimensionsDomainController tddc) Sets the typed dimensions domain controller.
void	setXDTProcessors(XDTProcessor xdt, XDTInfosetConsumer xdtInfo) When the DTS change these variables must be updated too.
void	update() Update.

Methods inherited from class com.ihr.xbrl.dts.InstanceExplorerAbstract

addInstanceExplorerListener, getCompanyKeys, getFactNotes, getInstanceExplorerListeners, getNumberOfCompanies, getNumTokens, getStringOfDateStep, getStringOfPeriod, getStringOfPeriod, getSuggestedUnit, getSuggestedUnits, getVNotes, hasDataForCompany, indexOfDateStepCode, instanceEvent, intTokenToString, removeInstanceExplorerListener, sendEvent, setSuggestedUnit, stepsCodeForIndex, stringTokenToInt

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionalInstanceExplorer

public DimensionalInstanceExplorer(LangsProvider lp,
                                   HasBoySupport hb,
                                   HasDimensionsTableHeaderItem hdth,
                                   HasAccessSelectedRole instanceDocumentPane,
                                   DefaultUnitProviderInterface defaultUnitProvider)

Instantiates a new dimensional instance explorer.

Parameters:

lp - the lp

hb - the hb

hdth - the hdth

instanceDocumentPane - the instance document pane

defaultUnitProvider - the default unit provider

Method Detail

setXDTProcessors

public void setXDTProcessors(XDTProcessor xdt,
                             XDTInfosetConsumer xdtInfo)

When the DTS change these variables must be updated too.

Parameters:

xdt - the xdt

xdtInfo - the xdt info

setInstance

public void setInstance(XBRLInstance instance)

Sets the instance.

Parameters:

instance - the new instance

resetDuplicatesDimension

public void resetDuplicatesDimension()

Reset duplicates dimension.

resetTypedDimensions

public void resetTypedDimensions()

Clear typed dimension members.

update

public void update()

Update.

getXDTProc

public XDTProcessor getXDTProc()

Access to the XDTProcessor linked with this DimensionalInstanceExplorer.

Returns:

instance of XDTProcessor or null if none is set

getXDTInfosetConsumer

public XDTInfosetConsumer getXDTInfosetConsumer()

Access to the XDTInfosetConsumer linked with this DimensionalIntanceExplorer.

Returns:

instance od XDTInfosetConsumer or null if none is set

clear

public void clear()

Clear.

Specified by:

clear in interface InstanceExplorerInterface

Overrides:

clear in class InstanceExplorerAbstract

addContext

public void addContext(XBRLContext newContext)

Adds the context.

Parameters:

newContext - the new context

factChangedContext

public void factChangedContext(XBRLFactItem fact,
                               XBRLContext oldContext,
                               XBRLContext newContext)

Fact changed context.

Parameters:

fact - the fact

oldContext - the old context

newContext - the new context

getCompatibleContexts

public java.util.Iterator<XBRLContext> getCompatibleContexts(XBRLFactItem fact)

Gets the compatible contexts.

Parameters:

fact - the fact

Returns:

the compatible contexts

factChangedUnit

public void factChangedUnit(XBRLFactNumeric fact,
                            XBRLUnit oldUnit,
                            XBRLUnit newUnit)

Fact changed unit.

Parameters:

fact - the fact

oldUnit - the old unit

newUnit - the new unit

findFact

public XBRLFactItem findFact(java.util.Collection<Member<?>> allMembers)

Find fact.

Parameters:

allMembers - the all members

Returns:

the XBRL fact item

findFact

public XBRLFactItem findFact(java.util.Collection<Member<?>> allMembers,
                             java.util.List<InstanceExplorerEvent> evList)

Find fact.

Parameters:

allMembers - the all members

evList - the ev list

Returns:

the XBRL fact item

getItemDimensions

public java.util.Collection<ClsPackQNameContainer> getItemDimensions(XMLElementDefinition item,
                                                                     XBRLRoleType role)

Returns a collection of dimensions that are applicable for this primary item.

Parameters:

item - the item

role - the role

Returns:

the item dimensions

getDimensionFromQName

public Dimension<?> getDimensionFromQName(javax.xml.namespace.QName name)

Gets the dimension from the "name" parameter that applies for the selected primary item. The selected primary item is obtained from a call to getSelectedPrimaryItem() on the interface used to create this instance. The getSelectedPrimaryItem() method is defined in the HasDimensionsTableHeaderItem interface. Also the dimension is limited to the role returned by a call to getSelectedRole() that is defined in the HasAccessSelectedRole interface.

How this method works:

1. Obtain the selected role via the getSelectedRole() method call
2. Obtain the selected primary item from a call to getSelectedPrimaryItem()
3. process the definition linkbases and find a dimension that matches the dimension name indicated in the QName name parameter and return it

Parameters:

name - the name

Returns:

the dimension from q name

See Also:

HasDimensionsTableHeaderItem, HasAccessSelectedRole

addFact

public void addFact(XBRLFact fact)

Adds the fact.

Parameters:

fact - the fact

delFact

public void delFact(XBRLFact fact,
                    XBRLFactsList parent)

Del fact.

Parameters:

fact - the fact

parent - the parent

addFragmentMember

public void addFragmentMember(XMLFragmentMember frMem,
                              java.lang.String text)

Adds a member to a typed dimension Forwards messages accordingly.

Parameters:

frMem - the fr mem

text - String text representation for fm or null

getInstance

public XBRLInstance getInstance()

Gets the single instance of DimensionalInstanceExplorer.

Returns:

single instance of DimensionalInstanceExplorer

setNewColumns

public void setNewColumns(boolean value)

Sets the new columns.

Parameters:

value - the new new columns

setTypedDimensionsDomainController

public void setTypedDimensionsDomainController(TypedDimensionsDomainController tddc)

Sets the typed dimensions domain controller.

Parameters:

tddc - the new typed dimensions domain controller

getTypedDimensionsDomainController

public TypedDimensionsDomainController getTypedDimensionsDomainController()

Gets the typed dimensions domain controller.

Returns:

the typed dimensions domain controller