com.ihr.xbrl.dts

Interface UnitsProvider

All Known Subinterfaces:

InstanceExplorerInterface

All Known Implementing Classes:

DimensionalInstanceExplorer, InstanceExplorer, InstanceExplorerAbstract

public interface UnitsProvider

Interface for classes able to suggest a unit or a set of units to be used for a particular item declaration.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
void	factChangedUnit(XBRLFactNumeric fact, XBRLUnit oldUnit, XBRLUnit newUnit) Fact changed unit.
java.util.Iterator<XBRLUnit>	getSuggestedUnits(XBRLItem itm) Returns an iterator over units that can be used for this item.

Method Detail

getSuggestedUnits

java.util.Iterator<XBRLUnit> getSuggestedUnits(XBRLItem itm)

Returns an iterator over units that can be used for this item. the resolution of the suggested units is not defined in this interface

Parameters:

itm - the itm

Returns:

Iterator<XBRLUnit>

factChangedUnit

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

Fact changed unit.

Parameters:

fact - the fact

oldUnit - the old unit

newUnit - the new unit