com.ihr.xbrl.dts
Class FactUseItem

java.lang.Object
  com.ihr.xbrl.dts.FactUse
      com.ihr.xbrl.dts.FactUseItem

public class FactUseItem
extends FactUse

This is a concept item and the use of that concept item together. The use of the item may be for the beginning of a period, for the end of a period or normal use if there is no indication

Author:

Ignacio

Field Summary

static int	BEGINNING This constant indicates that the concept item is used at the beginning of this period
static int	END This constant indicates that the concept item is used at the end of this period
static int	NEGATED Flag indicating this item is negated

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

NORMAL

Constructor Summary

FactUseItem(XBRLFactsList parent, XBRLItem item, int use, int index, boolean bNegated, RowKey key)

Method Summary

boolean	equals(java.lang.Object obj)
int	getIndex() Access to the index that indicates the nTh use of the same fact item.
XBRLItem	getItem() Access to the item of this item use tuple
int	getUse() Access to the information about the item use The uses can be BEGINNING, END or FactUse.NORMAL
static int	getUseFromRole(XBRLRoleType role) The return value is one of, FactUse.NORMAL, FactUseItem.BEGINNING or FactUseItem.END
int	hashCode()
boolean	isNegated() If this Fact Use is negated this method returns true

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

getParent, getRowKey

Methods inherited from class java.lang.Object

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

Field Detail

BEGINNING

public static final int BEGINNING

This constant indicates that the concept item is used at the beginning of this period

See Also:

Constant Field Values

END

public static final int END

This constant indicates that the concept item is used at the end of this period

See Also:

Constant Field Values

NEGATED

public static final int NEGATED

Flag indicating this item is negated

See Also:

Constant Field Values

Constructor Detail

FactUseItem

public FactUseItem(XBRLFactsList parent,
                   XBRLItem item,
                   int use,
                   int index,
                   boolean bNegated,
                   RowKey key)

Method Detail

getUse

public int getUse()

Access to the information about the item use The uses can be BEGINNING, END or FactUse.NORMAL

Returns:

the use

isNegated

public boolean isNegated()

If this Fact Use is negated this method returns true

Returns:

boolean

getIndex

public int getIndex()

Access to the index that indicates the nTh use of the same fact item.

Returns:

integer. -1 if no index or no information.

getItem

public XBRLItem getItem()

Description copied from class: FactUse

Access to the item of this item use tuple

Overrides:

getItem in class FactUse

Returns:

the item

hashCode

public int hashCode()

Overrides:

hashCode in class FactUse

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class FactUse

getUseFromRole

public static int getUseFromRole(XBRLRoleType role)

The return value is one of, FactUse.NORMAL, FactUseItem.BEGINNING or FactUseItem.END

Parameters:

prefLabelRole -

Returns:

constant integer