com.ihr.xbrl.dts

Class InstanceExplorer

java.lang.Object

com.ihr.xbrl.dts.InstanceExplorerAbstract

com.ihr.xbrl.dts.InstanceExplorer

All Implemented Interfaces:

ContextProvider, InstanceExplorerInterface, InstanceExplorerListener, UnitsProvider

public class InstanceExplorer
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
InstanceExplorer(LangsProvider lp, HasBoySupport hb, NegatedSupport ns, DefaultUnitProviderInterface defaultUnitProvider) Instantiates a new instance explorer.

Method Summary

Modifier and Type	Method and Description
void	addColumn(CompanyKey ck, ColumnPeriod col) Adds the column.
void	addContext(XBRLContext newContext) Adds the context.
void	addFact(XBRLFact fact) Receives notification a fact has been added to the instance being explored.
void	clear() Clear.
void	delColumn(CompanyKey ck, ColumnPeriod col) Del column.
void	delContext(XBRLContext ctx) Removing a context requires removing all facts using the context.
void	delFact(XBRLFact fact, XBRLFactsList parent) Announces a fact has been removed from the instance being explored.
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> lstEvents) Find fact.
static java.util.GregorianCalendar	gcCloneAndAdd(java.util.GregorianCalendar initial, int dateStep, boolean bSignIsPlus) Helper method to calculate the date end as a copy of the initial date and an amount of time since then.
java.util.Collection<XBRLContext>	getAllContexts(CompanyKey ck, XBRLItem.PeriodType periodType) Access to a collection of all contexts that are associated with factColumns in this InstanceExplorer.
java.util.Collection<XBRLUnit>	getAllUnits(CompanyKey ck, XBRLItem item) Returns all the units in the instance document that are used by the company indicated by the CompanyKey parameter.
ColumnPeriod	getColumn(CompanyKey ck, int index) Gets the column.
java.util.Iterator<ColumnPeriod>	getColumnKeysIterator(CompanyKey ck) Gets the column keys iterator.
int[]	getColumnsCount(CompanyKey ck, java.util.Collection<FactUse> concepts, boolean bSkipEmptyColumns) Returns an array of indexes of columns with data for the list of concepts in the concepts parameter.
java.util.Iterator<XBRLContext>	getCompatibleContexts(XBRLFactItem fact) Gets the compatible contexts.
int	getDateStepForFact(XBRLFactItem item, int dateStep) Prepares a dateStep depending on the contextual information of the fact.
java.util.Iterator<java.lang.String>	getDateStepIterator(CompanyKey ck) Gets the date step iterator.
int	getDateStepNumKeys(CompanyKey ck) Gets the date step num keys.
FactsColumn[]	getFactsColumn(CompanyKey ck, ColumnPeriod period, boolean bIncludeRelated) This is never null.
XBRLInstance	getInstance() Gets the single instance of InstanceExplorer.
int	getMaxGranularityCode() Gets the max granularity code.
java.util.List<XBRLContext>	getVectorForKey(CompanyKey ck, java.lang.String keyContexts) Access to a Vector of XBRLContexts .
void	instanceEvent(InstanceExplorerEvent e) Instance event.
static java.lang.String	instanceModeToString(HandleDateStep.InstantMode instantMode) Instance mode to string.
static XBRLPeriod	make(XBRLItem.PeriodType periodType, int dateStep, DTSContainer dts) Creates a period of a specified period type (Instant or Duration) and sets the values according to the dateStep value.
void	processContexts(java.util.Iterator<XBRLContext> contexts) Process contexts.
void	setInstance(XBRLInstance instance) Sets the instance.
void	setNewColumns(boolean value) Sets the new columns.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceExplorer

public InstanceExplorer(LangsProvider lp,
                        HasBoySupport hb,
                        NegatedSupport ns,
                        DefaultUnitProviderInterface defaultUnitProvider)

Instantiates a new instance explorer.

Parameters:

lp - the lp

hb - the hb

ns - the ns

defaultUnitProvider - the default unit provider

Method Detail

getMaxGranularityCode

public int getMaxGranularityCode()

Gets the max granularity code.

Returns:

the max granularity code

setInstance

public void setInstance(XBRLInstance instance)

Sets the instance.

Parameters:

instance - the new instance

getVectorForKey

public java.util.List<XBRLContext> getVectorForKey(CompanyKey ck,
                                                   java.lang.String keyContexts)

Access to a Vector of XBRLContexts .

Parameters:

ck - the ck

keyContexts - the key contexts

Returns:

Vector<XBRLContext>

getFactsColumn

public FactsColumn[] getFactsColumn(CompanyKey ck,
                                    ColumnPeriod period,
                                    boolean bIncludeRelated)

This is never null. A new Facts Column is created if none is found

Parameters:

ck - the ck

period - the period

bIncludeRelated - the b include related

Returns:

FactsColumn

getDateStepIterator

public java.util.Iterator<java.lang.String> getDateStepIterator(CompanyKey ck)

Gets the date step iterator.

Parameters:

ck - the ck

Returns:

Iterator<String>

getColumnKeysIterator

public java.util.Iterator<ColumnPeriod> getColumnKeysIterator(CompanyKey ck)

Gets the column keys iterator.

Parameters:

ck - the ck

Returns:

the column keys iterator

getDateStepNumKeys

public int getDateStepNumKeys(CompanyKey ck)

Gets the date step num keys.

Parameters:

ck - the ck

Returns:

the date step num keys

getColumnsCount

public int[] getColumnsCount(CompanyKey ck,
                             java.util.Collection<FactUse> concepts,
                             boolean bSkipEmptyColumns)

Returns an array of indexes of columns with data for the list of concepts in the concepts parameter.

If the concepts parameter is null, the returned array contains all columns, one index per column

The number of elements in the array is the number of columns

If there is no data for the company the function returns an empty array

Parameters:

ck - company key

concepts - is a Collection of concepts to filter. if null all concepts are selected.

bSkipEmptyColumns - the b skip empty columns

Returns:

array of integers

getColumn

public ColumnPeriod getColumn(CompanyKey ck,
                              int index)

Gets the column.

Parameters:

ck - the ck

index - the index

Returns:

the column

gcCloneAndAdd

public static java.util.GregorianCalendar gcCloneAndAdd(java.util.GregorianCalendar initial,
                                                        int dateStep,
                                                        boolean bSignIsPlus)

Helper method to calculate the date end as a copy of the initial date and an amount of time since then.

Parameters:

initial - GregorianCalendar

dateStep - constant indicating the period duration. This constant corresponds with GregorianCalendar defined fields extended by constants defined in InstanceExplorerAbstract class

bSignIsPlus - boolean true means positive period false means negative period

Returns:

GregorianCalendar

instanceModeToString

public static java.lang.String instanceModeToString(HandleDateStep.InstantMode instantMode)

Instance mode to string.

Parameters:

instantMode - the instant mode

Returns:

the string

processContexts

public void processContexts(java.util.Iterator<XBRLContext> contexts)

Process contexts.

Parameters:

contexts - the contexts

getAllContexts

public java.util.Collection<XBRLContext> getAllContexts(CompanyKey ck,
                                                        XBRLItem.PeriodType periodType)

Access to a collection of all contexts that are associated with factColumns in this InstanceExplorer. And are of the specified context type.

The returned collection is ordered from the lowest date to the highest date.

If periodType is XBRLItem.UNDEFINED_PERIOD_TYPE then all context are included

Parameters:

ck - the ck

periodType - the period type

Returns:

Collection<XBRLContext>

getCompatibleContexts

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

Gets the compatible contexts.

Parameters:

fact - the fact

Returns:

the compatible contexts

addContext

public void addContext(XBRLContext newContext)

Adds the context.

Parameters:

newContext - the new context

delContext

public void delContext(XBRLContext ctx)

Removing a context requires removing all facts using the context.

This process is independent from removing the context from the instance document

Parameters:

ctx - the ctx

addFact

public void addFact(XBRLFact fact)

Receives notification a fact has been added to the instance being explored.

Parameters:

fact - the fact

delFact

public void delFact(XBRLFact fact,
                    XBRLFactsList parent)

Announces 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 - the fact

parent - the parent

delColumn

public void delColumn(CompanyKey ck,
                      ColumnPeriod col)

Del column.

Parameters:

ck - the ck

col - the col

addColumn

public void addColumn(CompanyKey ck,
                      ColumnPeriod col)

Adds the column.

Parameters:

ck - the ck

col - the col

getAllUnits

public java.util.Collection<XBRLUnit> getAllUnits(CompanyKey ck,
                                                  XBRLItem item)

Returns all the units in the instance document that are used by the company indicated by the CompanyKey parameter. The first element in the collection will be the "preferred" unit for the item indicated in the item parameter. If item is null then the order will be random.

Parameters:

ck - the ck

item - the item

Returns:

Collection<XBRLUnit>

make

public static XBRLPeriod make(XBRLItem.PeriodType periodType,
                              int dateStep,
                              DTSContainer dts)

Creates a period of a specified period type (Instant or Duration) and sets the values according to the dateStep value.

For instant periods bigger than days the instant time is set to 24 hours before of the lowest time where today's date is in the dateStep period

For instant periods lower than days the instant time is set to the time of the lowest time where today's date is in the dateStep period. Minutes, seconds are set to 0 to indicate the non required precision.

For periods, the start date and end date is indicating the beginning and ending period time under the range specified by dateStep

Parameters:

periodType - the period type

dateStep - the date step

dts - DTSContainer

Returns:

XBRLPeriod

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

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

getDateStepForFact

public int getDateStepForFact(XBRLFactItem item,
                              int dateStep)

Prepares a dateStep depending on the contextual information of the fact. If the fact is instant, the date step received in the dateStep parameter is returned

Parameters:

item - the XBRLFactItem

dateStep - suggested value for date step

Returns:

int representing the dateStep

clear

public void clear()

Clear.

Specified by:

clear in interface InstanceExplorerInterface

Overrides:

clear in class InstanceExplorerAbstract

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> lstEvents)

Find fact.

Parameters:

allMembers - the all members

lstEvents - the lst events

Returns:

the XBRL fact item

instanceEvent

public void instanceEvent(InstanceExplorerEvent e)

Instance event.

Specified by:

instanceEvent in interface InstanceExplorerListener

Overrides:

instanceEvent in class InstanceExplorerAbstract

Parameters:

e - the e

getInstance

public XBRLInstance getInstance()

Gets the single instance of InstanceExplorer.

Returns:

single instance of InstanceExplorer

setNewColumns

public void setNewColumns(boolean value)

Sets the new columns.

Parameters:

value - the new new columns