## Uses of Class
com.ihr.xbrl.om.formula.XBRLFormula

- Packages that use XBRLFormula
  Package | Description
  --- | ---
  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.errors |

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

    Methods in com.ihr.xbrl.om.formula that return XBRLFormula
    Modifier and Type | Method and Description
    --- | ---
    `XBRLFormula` | XBRLFormulaProcessor.`getUnderEvaluationFormula()` This method returns the formula that is being evaluated.

    Methods in com.ihr.xbrl.om.formula that return types with arguments of type XBRLFormula
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Collection<XBRLFormula>` | XBRLFormulaProcessor.`getFormulas()` Access to all formula resources loaded from the linkbases and compiled as XBRLFormula instances.

    Methods in com.ihr.xbrl.om.formula with parameters of type XBRLFormula
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLFormulaProcessor.`addFormula(XBRLFormula formula)` Adds the formula.
    `void` | XBRLFormulaProcessor.`removeFormula(XBRLFormula xbrlFormula)` Marks a formula to be removed from the formula list.

    Method parameters in com.ihr.xbrl.om.formula with type arguments of type XBRLFormula
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLFormulaProcessor.`evaluateFormulaSet(java.util.Collection<XBRLFormula> formulas, XBRLValidationReport valReport, XBRLInstance doc, ExecutionTargetType targetType)` Evaluates a collection of formulas and put the result inside the validation report passed in as parameter valReport.

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

    Methods in com.ihr.xbrl.om.formula.aspects with parameters of type XBRLFormula
    Modifier and Type | Method and Description
    --- | ---
    `void` | OpenContextComponentRuleSet.`addRule(XBRLFormula xbrlFormula, net.sf.saxon.s9api.XdmNode aspectNode, int container)` Adds the rule.

    Constructors in com.ihr.xbrl.om.formula.aspects with parameters of type XBRLFormula
    Constructor and Description
    `CommonAspectRule(net.sf.saxon.s9api.XdmNode aspectNode, XBRLFormula formula)` Instantiates a new common aspect rule.
    `ConceptAspectRule(XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new concept aspect rule.
    `DefaultAspectRule(int aspect, XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode, int type)` Instantiates a new default aspect rule.
    `DimensionCommonAspectRule(int dimensionType, XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new dimension common aspect rule.
    `DimensionExplicitRule(XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new dimension explicit rule.
    `DimensionTypedRule(XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new dimension typed rule.
    `EmptyAspectRule(net.sf.saxon.s9api.XdmNode aspectNode, XBRLFormula formula)` Instantiates a new empty aspect rule.
    `EntityIdentifierAspectRule(XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new entity identifier aspect rule.
    `FragmentsAspectRule(net.sf.saxon.s9api.XdmNode aspectNode, XBRLFormula formula, int container)` Instantiates a new fragments aspect rule.
    `PeriodAspectRule(XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new period aspect rule.
    `UnitAction(XBRLFormula formula, com.ihr.xbrl.om.formula.aspects.UnitAspectRule.UnitOperationType code, net.sf.saxon.s9api.XdmNode actionNode)` Instantiates a new unit action.
    `UnitAspectRule(XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new unit aspect rule.
    `UnitNoUnitAspectRule(XBRLFormula xbrlFormula, net.sf.saxon.s9api.XdmNode document)` Instantiates a new unit no unit aspect rule.
    `XPathAspectRule(net.sf.saxon.s9api.XdmNode aspectNode, XBRLFormula formula, int container)` Instantiates a new x path aspect rule.

  - ### Uses of XBRLFormula in com.ihr.xbrl.om.formula.errors

    Constructors in com.ihr.xbrl.om.formula.errors with parameters of type XBRLFormula
    Constructor and Description
    `XFxbrlfeDefaultAspectValueConflicts(XBRLFormula formula, int aspect)` Instantiates a new x fxbrlfe default aspect value conflicts.
    `XFxbrlfeMissingConceptRule(XBRLFormula formula)` Instantiates a new x fxbrlfe missing concept rule.
    `XFxbrlfeMissingEntityIdentifierRule(XBRLFormula formula)` Instantiates a new x fxbrlfe missing entity identifier rule.
    `XFxbrlfeMissingPeriodRule(XBRLFormula formula)` Instantiates a new x fxbrlfe missing period rule.
    `XFxbrlfeMissingSAVForExplicitDimensionRule(XBRLFormula formula)` Instantiates a new x fxbrlfe missing sav for explicit dimension rule.
    `XFxbrlfeMissingSAVForTypedDimensionRule(XBRLFormula formula)` Instantiates a new x fxbrlfe missing sav for typed dimension rule.
    `XFxbrlfeMissingUnitRule(XBRLFormula formula)` Instantiates a new x fxbrlfe missing unit rule.
    `XFxbrlfeNonSingletonOutputValue(XBRLFormula formula)` Instantiates a new x fxbrlfe non singleton output value.