com.ihr.xbrl.dts

Class FactsColumn

java.lang.Object

com.ihr.xbrl.dts.FactsColumn

public class FactsColumn
extends java.lang.Object

This is a class representing all facts in a logical column.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
FactsColumn(ColumnPeriod period) Instantiates a new facts column.

Method Summary

Modifier and Type	Method and Description
void	addContext(XBRLContext ctx, int use) Adds a context to this FactsColumn.
boolean	containsKey(FactUseItem iu) Contains key.
void	delContext(XBRLContext ctx) Del context.
java.util.Set<java.util.Map.Entry<FactUseItem,XBRLFactItem>>	entrySet() Entry set.
boolean	equals(java.lang.Object obj) Equals.
XBRLFactItem	get(java.lang.Object key) Gets the.
java.util.Collection<XBRLContext>	getContexts(boolean bIncludeEmpty) Gets the contexts.
XBRLContext	getContexts(XBRLItem.PeriodType periodType, int use) Returns the most used XBRLContext object in this column filtered by the period type and FactUse.
ColumnPeriod	getPeriod() Gets the period.
FactUseItem	getRowKey(XBRLFactItem fact) For a fact item added to this FactsColumn this method returns the assigned row key.
int	getRowNumber(XBRLFactItem fact) For a fact item added to this FactsColumn this method returns the assigned row number.
int	hashCode() Hash code.
boolean	isEmpty() Checks if is empty.
XBRLFactItem	put(FactUseItem key, XBRLFactItem value) Put.
XBRLFactItem	remove(java.lang.Object key) Removes the.
int	size() Size.
java.util.Collection<XBRLFactItem>	values() Values.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FactsColumn

public FactsColumn(ColumnPeriod period)

Instantiates a new facts column.

Parameters:

period - the period

Method Detail

getPeriod

public ColumnPeriod getPeriod()

Gets the period.

Returns:

the period

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

getContexts

public java.util.Collection<XBRLContext> getContexts(boolean bIncludeEmpty)

Gets the contexts.

Parameters:

bIncludeEmpty - the b include empty

Returns:

the contexts

getContexts

public XBRLContext getContexts(XBRLItem.PeriodType periodType,
                               int use)

Returns the most used XBRLContext object in this column filtered by the period type and FactUse.

Parameters:

periodType - int XBRLItem.DURATION or XBRLItem.INSTANT

use - constant indicating beginning of period, end of period or normal usage.

Returns:

XBRLContext

put

public XBRLFactItem put(FactUseItem key,
                        XBRLFactItem value)

Put.

Parameters:

key - the key

value - the value

Returns:

the XBRL fact item

getRowNumber

public int getRowNumber(XBRLFactItem fact)

For a fact item added to this FactsColumn this method returns the assigned row number.

Parameters:

fact - the fact

Returns:

the row number

getRowKey

public FactUseItem getRowKey(XBRLFactItem fact)

For a fact item added to this FactsColumn this method returns the assigned row key.

Parameters:

fact - the fact

Returns:

the row key

addContext

public void addContext(XBRLContext ctx,
                       int use)

Adds a context to this FactsColumn. Normally, when a fact item is associated with the FactColumn the context is added to the FactsColumn automatically. This method is for the special cases where a context is created before an item is created.

Parameters:

ctx - the ctx

use - the use

delContext

public void delContext(XBRLContext ctx)

Del context.

Parameters:

ctx - the ctx

get

public XBRLFactItem get(java.lang.Object key)

Gets the.

Parameters:

key - the key

Returns:

the XBRL fact item

remove

public XBRLFactItem remove(java.lang.Object key)

Removes the.

Parameters:

key - the key

Returns:

the XBRL fact item

containsKey

public boolean containsKey(FactUseItem iu)

Contains key.

Parameters:

iu - the iu

Returns:

true, if successful

entrySet

public java.util.Set<java.util.Map.Entry<FactUseItem,XBRLFactItem>> entrySet()

Entry set.

Returns:

the sets the

isEmpty

public boolean isEmpty()

Checks if is empty.

Returns:

true, if is empty

values

public java.util.Collection<XBRLFactItem> values()

Values.

Returns:

the collection

size

public int size()

Size.

Returns:

the int