## Uses of Class
com.ihr.xbrl.om.instance.XBRLUnit

- Packages that use XBRLUnit
  Package | Description
  --- | ---
  com.ihr.xbrl.adins.efm.errors | Provides classes for the specific error messages for the the implementation of the Edgar Filer Manual validation add-in This package is part of the implementation of the Edgar Filer Manual
  com.ihr.xbrl.dts | Provides the classes necessary to investigate the content of a DTS.
  com.ihr.xbrl.mapper | Provides the classes necessary access to content in whatever format and create an XBRL Instance document This package contains the MapEngine and Mappers that uses a configuration file with an Instance template.
  com.ihr.xbrl.mapper.source | Provides implementations of drivers to obtain data from multiple sources in order to create an XBRL Instance Some of the drivers collects data from a web form or from an excel file.
  com.ihr.xbrl.mapper.source.worksheet | This package contains the root class for the mapper XBRL drivers that obtains information from spreadsheets, Excel and Google sheets are currently implemented.
  com.ihr.xbrl.om.errors | Provides the classes necessary to produce and process XBRL related errors There are two error categories.
  com.ihr.xbrl.om.formula | Provides the classes necessary to implement a plug in XBRL processor for validation of docuents and taxonomies according to the XBRL formula specification 1.0 At this stage the package is just created.
  com.ihr.xbrl.om.formula.aspects |
  com.ihr.xbrl.om.formula.filters |
  com.ihr.xbrl.om.instance | Provides the classes necessary to process, read and write the content of XBRL Instance documents.
  com.ihr.xbrl.om.instance.unit |
  com.ihr.xbrl.om.table.definition | Classes supporting definition nodes
  com.ihr.xbrl.om.utr | Provides classes for handling the Units Registry from XBRL International The Units Registry provides extra validation of elements based on the element data type and the unit assigned by XBRL International in the Units Registry.
  com.ihr.xbrl.pojo | Provides the classes necessary to access to the content of a DTS using POJO technology.

- - ### Uses of XBRLUnit in com.ihr.xbrl.adins.efm.errors

    Constructors in com.ihr.xbrl.adins.efm.errors with parameters of type XBRLUnit
    Constructor and Description
    `EFMEquivalentUnits(XBRLUnit unit)` Instantiates a new EFM equivalent units.
    `EFMEquivalentUnits(XBRLUnit unit, XBRLUnit compareUnit)` Instantiates a new EFM equivalent units.

  - ### Uses of XBRLUnit in com.ihr.xbrl.dts

    Methods in com.ihr.xbrl.dts that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | InstanceExplorerInterface.`getSuggestedUnit(CompanyKey ck, XBRLItem itm)` Gets the suggested unit.
    `XBRLUnit` | InstanceExplorerAbstract.`getSuggestedUnit(CompanyKey ck, XBRLItem itm)` Returns a suggested unit for a numeric concept definition.

    Methods in com.ihr.xbrl.dts that return types with arguments of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Collection<XBRLUnit>` | InstanceExplorer.`getAllUnits(CompanyKey ck, XBRLItem item)` Returns all the units in the instance document that are used by the company indicated by the CompanyKey parameter.
    `java.util.Iterator<XBRLUnit>` | UnitsProvider.`getSuggestedUnits(XBRLItem itm)` Returns an iterator over units that can be used for this item.
    `java.util.Iterator<XBRLUnit>` | InstanceExplorerAbstract.`getSuggestedUnits(XBRLItem itm)` Implementation of the UnitsProvider interface The algorithm considers other units in this report and put first the "suggested unit" for this fact item.

    Methods in com.ihr.xbrl.dts with parameters of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `void` | EditorSourceImpl.`addUnit(XBRLUnit unit)` Adds a new value to the unit aspect.
    `void` | UnitsProvider.`factChangedUnit(XBRLFactNumeric fact, XBRLUnit oldUnit, XBRLUnit newUnit)` Fact changed unit.
    `void` | InstanceExplorer.`factChangedUnit(XBRLFactNumeric fact, XBRLUnit oldUnit, XBRLUnit newUnit)`
    `void` | DimensionalInstanceExplorer.`factChangedUnit(XBRLFactNumeric fact, XBRLUnit oldUnit, XBRLUnit newUnit)`
    `void` | InstanceExplorerAbstract.`setSuggestedUnit(XBRLItem item, CompanyKey ck, XBRLUnit unit)` Sets the suggested unit.
    `void` | InstanceBuilder.`setUnit(XBRLUnit unit)` Sets the unit.

  - ### Uses of XBRLUnit in com.ihr.xbrl.mapper

    Methods in com.ihr.xbrl.mapper that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | Fact.`getUnit()` Gets the unit.
    `XBRLUnit` | MapperFileSaveInterface.`getUnitForKey(java.lang.String key)` Access to the unit associated with a specific key.
    `XBRLUnit` | MapperBase.`getUnitForKey(java.lang.String key)` Returns the XBRLUnit object associated with the specified key.

    Methods in com.ihr.xbrl.mapper with parameters of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | MapperBase.`addUnit(XBRLUnit newUnit)` Adds the unit.

    Constructors in com.ihr.xbrl.mapper with parameters of type XBRLUnit
    Constructor and Description
    `Fact(Fact.Type type, HasFacts parent, XBRLDataSource source, MapperContext context, java.lang.String mapIdentifier, XMLElementDefinition concept, XBRLUnit unit, int multi)` Instantiates a new fact.

  - ### Uses of XBRLUnit in com.ihr.xbrl.mapper.source

    Methods in com.ihr.xbrl.mapper.source that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | XBRLFileDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | XBRLDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)` Each time a numeric concept is created this function is called to request or change the required unit.
    `XBRLUnit` | WebFormDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | VoidDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | SQLDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | JNDIDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | CSVDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`

    Methods in com.ihr.xbrl.mapper.source with parameters of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `int` | XBRLFileDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `int` | XBRLDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)` Ask the driver for the preferred serialization for the numeric data.
    `int` | WebFormDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `int` | VoidDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `int` | SQLDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `int` | JNDIDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `int` | CSVDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `java.lang.String` | XBRLFileDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `java.lang.String` | XBRLDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)` Returns the value (as string) for the data format.
    `java.lang.String` | WebFormDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `java.lang.String` | VoidDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `java.lang.String` | SQLDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `java.lang.String` | JNDIDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `java.lang.String` | CSVDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `XBRLUnit` | XBRLFileDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | XBRLDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)` Each time a numeric concept is created this function is called to request or change the required unit.
    `XBRLUnit` | WebFormDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | VoidDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | SQLDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | JNDIDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`
    `XBRLUnit` | CSVDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`

  - ### Uses of XBRLUnit in com.ihr.xbrl.mapper.source.worksheet

    Methods in com.ihr.xbrl.mapper.source.worksheet that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | AbstractWorksheetDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`

    Methods in com.ihr.xbrl.mapper.source.worksheet with parameters of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `int` | AbstractWorksheetDataSource.`getFormat(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `java.lang.String` | AbstractWorksheetDataSource.`getFormatValue(java.lang.String mapIdentifier, int index, XBRLContext context, XBRLUnit localUnit)`
    `XBRLUnit` | AbstractWorksheetDataSource.`getUnit(java.lang.String mapIdentifier, int index, XBRLContext localContext, XBRLUnit unit)`

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.errors

    Constructors in com.ihr.xbrl.om.errors with parameters of type XBRLUnit
    Constructor and Description
    `XBRLValidationExceptionISO4217UnitHasMoreUnits(XBRLUnit unit)` Instantiates a new XBRL validation exception is o4217 unit has more units.
    `XBRLValidationExceptionISO4217UnitHasWrongNamespace(XBRLUnit unit)` Instantiates a new XBRL validation exception is o4217 unit has wrong namespace.
    `XBRLValidationExceptionISO4217WrongLocalPart(XBRLUnit unit)` Instantiates a new XBRL validation exception is o4217 wrong local part.
    `XBRLValidationExceptionSharesUnitHasMoreUnits(XBRLUnit unit)` Instantiates a new XBRL validation exception shares unit has more units.
    `XBRLValidationExceptionSharesUnitHasWrongNamespace(XBRLUnit unit)` Instantiates a new XBRL validation exception shares unit has wrong namespace.
    `XBRLValidationExceptionSharesWrongLocalPart(XBRLUnit unit)` Instantiates a new XBRL validation exception shares wrong local part.

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.formula

    Methods in com.ihr.xbrl.om.formula that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | XBRLFormulaProcessor.`getUnitById(java.lang.String id, java.net.URI documentURI)` Gets the unit by id.

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.formula.aspects

    Methods in com.ihr.xbrl.om.formula.aspects that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | UnitNoUnitAspectRule.`getUnit(XPathHelper xph)`
    `XBRLUnit` | UnitAspectRule.`getUnit(XPathHelper xph)`
    `XBRLUnit` | UnitAspectInterface.`getUnit(XPathHelper xph)` Gets the unit.
    `XBRLUnit` | UnitAction.`getUnit(XPathHelper xph)`
    `XBRLUnit` | DefaultAspectRule.`getUnit(XPathHelper xph)`

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.formula.filters

    Methods in com.ihr.xbrl.om.formula.filters that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | XBRLFormulaUnitFilter.`getUnit(XBRLInstance doc)` Gets the unit.

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.instance

    Methods in com.ihr.xbrl.om.instance that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | XBRLUnit.`clone()`
    `XBRLUnit` | XBRLUnit.`clone(DTSContainer newDTS)`
    `XBRLUnit` | XBRLFactNumeric.`getUnit()` Obtains the unit of this fact.
    `XBRLUnit` | XBRLInstance.`getUnitById(java.lang.String id)` Gets the unit by id.
    `XBRLUnit` | XBRLInstance.`getUnitCompatible(XBRLUnit otherUnit)` Returns an existing unit that is u-equal to the unit passed in as the parameter.

    Methods in com.ihr.xbrl.om.instance that return types with arguments of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<XBRLUnit>` | XBRLInstance.`getUnits()` Gets the units.

    Methods in com.ihr.xbrl.om.instance with parameters of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | XBRLInstance.`addUnit(XBRLUnit unit)` Adds the unit.
    `static XBRLFactItem` | XBRLFactItem.`createItemInstance(XBRLFactsList container, XBRLContext ctx, XBRLItem xf, XBRLUnit unit)` creates an XBRLFactItem that can be either a XBRLFactNumeric or XBRLFactNonNumeric depending on the information provided in extra parameters.
    `static XBRLFact` | XBRLFact.`createItemOrTupleInstance(XBRLFactsList facts, XMLElementDefinition el, XBRLContext ctx, XBRLUnit unit)` Creates a tupleInstance of a itemInstance depending on the data type of the el parameter and extra information provided in other parameters.
    `void` | XBRLInstance.`delUnit(XBRLUnit unit)` Removes an unit from the instance document.
    `XBRLUnit` | XBRLInstance.`getUnitCompatible(XBRLUnit otherUnit)` Returns an existing unit that is u-equal to the unit passed in as the parameter.
    `void` | XBRLFactNumeric.`setUnit(XBRLUnit unit)` Sets a new unit for this fact.

    Constructors in com.ihr.xbrl.om.instance with parameters of type XBRLUnit
    Constructor and Description
    `XBRLFactNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit)` Creates a numeric fact item providing all required information and NIL value.
    `XBRLFactNumeric(XBRLFactsList container, XBRLContext context, XBRLItem item, XBRLUnit unit, XBRLNumber value)` Creates a numeric fact item providing all required information.

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.instance.unit

    Methods in com.ihr.xbrl.om.instance.unit with parameters of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `static java.lang.String` | UnitToString.`getUnitHtml(XBRLUnit unit)` Works identically as `UnitToString.getUnitString(XBRLUnit)` except that the returned string is HTML code that can be used for tooltips.
    `static java.lang.String` | UnitToString.`getUnitString(XBRLUnit unit)` This static method returns the representation character for an XBRL Unit.

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.table.definition

    Methods in com.ihr.xbrl.om.table.definition that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | UnitAspectRule.`getMember(XBRLStructuralTable table, CellHeader[] header)`
    `XBRLUnit` | UnitAspectNode.`getMember(XBRLStructuralTable table, CellHeader[] header)`
    `XBRLUnit` | UnitAction.`getMember(XBRLStructuralTable table, CellHeader[] header)`
    `XBRLUnit` | UnitAspectRule.`getUnit(XBRLStructuralTable xbrlTable)`
    `XBRLUnit` | UnitAspectInterface.`getUnit(XBRLStructuralTable xbrlTable)` Returns the calculated unit for this aspect.
    `XBRLUnit` | UnitAction.`getUnit(XBRLStructuralTable xbrlTable)`
    `XBRLUnit[]` | UnitsAspectInterface.`getUnits()` Returns the calculated unit for this aspect.
    `XBRLUnit[]` | UnitAspectNode.`getUnits()`

  - ### Uses of XBRLUnit in com.ihr.xbrl.om.utr

    Methods in com.ihr.xbrl.om.utr that return XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | UTRProcessor.`getUnit(XBRLItem itm, javax.xml.namespace.QName defaultUnit)` Returns a valid XBRLUnit for the item passed in in the first parameter.

  - ### Uses of XBRLUnit in com.ihr.xbrl.pojo

    Methods in com.ihr.xbrl.pojo with parameters of type XBRLUnit
    Modifier and Type | Method and Description
    --- | ---
    `XBRLUnit` | XBRLPojoGenerator.`generate(XBRLUnit unit)` Generate.