com.ihr.xbrl.dts
Interface InstanceExplorerInterface

All Superinterfaces:

ContextProvider, InstanceExplorerListener, UnitsProvider

All Known Implementing Classes:

DimensionalInstanceExplorer, InstanceExplorer, InstanceExplorerAbstract

public interface InstanceExplorerInterface
extends ContextProvider, UnitsProvider, InstanceExplorerListener

Author:

Ignacio

Method Summary

void	addFact(XBRLFact fact) Received notification that a fact has been added
void	clear()
void	delFact(XBRLFact fact, XBRLFactsList parent) Receives notification that a fact has been removed from the instance being explored.
XBRLFactItem	findFact(java.util.ArrayList<Member<?>> allMembers) if the allMembers contains LineTitleMember elements, we need to resolve the hierarchy resolution before calling this method.
java.util.Iterator<CompanyKey>	getCompanyKeys()
XBRLUnit	getSuggestedUnit(CompanyKey ck, XBRLItem itm)
boolean	hasDataForCompany(CompanyKey company)
void	setInstance(XBRLInstance instance)

Methods inherited from interface com.ihr.xbrl.dts.ContextProvider

addContext, factChangedContext, getCompatibleContexts

Methods inherited from interface com.ihr.xbrl.dts.UnitsProvider

factChangedUnit, getSuggestedUnits

Methods inherited from interface com.ihr.xbrl.dts.InstanceExplorerListener

instanceEvent

Method Detail

setInstance

void setInstance(XBRLInstance instance)

Parameters:

instance -

findFact

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

if the allMembers contains LineTitleMember elements, we need to resolve the hierarchy resolution before calling this method. In other words, this method no longer supports LineTitleMember as members of the ArrayList

Parameters:

allMembers -

Returns:

getSuggestedUnit

XBRLUnit getSuggestedUnit(CompanyKey ck,
                          XBRLItem itm)

Parameters:

ck -

itm -

Returns:

addFact

void addFact(XBRLFact fact)

Received notification that a fact has been added

Parameters:

fact -

delFact

void delFact(XBRLFact fact,
             XBRLFactsList parent)

Receives notification that a fact has been removed from the instance being explored.

Note: after removing a fact from its container the fact parent is set to null.

The fact has to be removed from the parent container prior to call this method and this is the reason this method has a second parameter that indicated what the parent container was.

Parameters:

fact -

parent -

clear

void clear()

hasDataForCompany

boolean hasDataForCompany(CompanyKey company)

Parameters:

selectedCompany -

Returns:

getCompanyKeys

java.util.Iterator<CompanyKey> getCompanyKeys()

Returns: