XBRLNumber

```
public interface XBRLNumber
```
The Interface XBRLNumber. There are two classes implementing this interface. one for fractionItemType and the other for regular values but starting with version 3.0 the two implementations are inner classes of the XBRLFactNumeric class and cannot be used directly. The interface has been enriched to provide all required functionality.

Author:

Ignacio

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class XBRLNumber.ExactitudeMode
The Enum ExactitudeMode.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`XBRLNumber.ExactitudeMode` The Enum ExactitudeMode.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.text.DecimalFormat`	`bf` The bf.
`static int`	`INF` The Constant INF: This is used to represent either `decimals="INF"` or `precision="INF"` using an integer value to be returned by the `getDecimalsRealOrInferred()` or the `getPrecisionRealOrInferred()` function.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear.
`XBRLNumber`	`clone()` Clone.
`boolean`	`eq(XBRLNumber vb)` Eq.
`boolean`	`equals(XBRLNumber other)` returns the result of comparing the values of the fields for that are part of the XBRLNumeric value.
`java.math.BigDecimal`	`getBigDecimal()` If this XBRLNumber is a numeric value, this method returns a BigDecimal of the value.
`int`	`getDecimalsRealOrInferred()` Returns the accuracy of a fact as if it was reported using the `decimals` attribute.
`java.lang.String`	`getFinancialString()` Returns a string representation of the number that satisfies common understanding by financial users, this method is used while formatting the values in the error messages, and might be used in other places.
`java.lang.String`	`getFriendlyName(int flags, LabelsProvider lp)` Gets the friendly name.
`int`	`getPrecisionRealOrInferred()` Returns the accuracy of a fact as if it was reported using the `precision` attribute.
`java.lang.Number`	`getValue()` Access to the surrounding number value this object is encapsulating.
`int`	`hashCode()` Hash code.
`boolean`	`isBlank()` true if this XBRLNumericValue has no value assigned .
`boolean`	`isFraction()` Checks if is fraction.
`boolean`	`isNumber()` Checks if is number.
`boolean`	`isSameValue(XBRLNumber newVal)` This compares this number representation with newVal number representation.
`XBRLNumber`	`multiply(double weight)` Multiply.
`boolean`	`ne(XBRLNumber sumItem)` Ne.
`XBRLNumber`	`plus(XBRLNumber sum)` Plus.
`XBRLNumber`	`round()` applies round to defined decimals or precision attribute value and returns a new XBRLNumber.
`XBRLNumber`	`roundTo(int precisionOrDecimals)` Rounds the number to the specified value in the `precisionOrDecimals` parameter.

- Field Detail
  - INF
```
static final int INF
```
    The Constant INF: This is used to represent either decimals="INF" or precision="INF" using an integer value to be returned by the getDecimalsRealOrInferred() or the getPrecisionRealOrInferred() function.
    When a fact value is represented with either decimals="INF" or precision="INF" the lexical representation of the fact value corresponds exactly with what is written in the xml element and no rounding has to be executed on that number.
    
    See Also:
    
    getDecimalsRealOrInferred(), getPrecisionRealOrInferred(), Constant Field Values
  - bf
```
static final java.text.DecimalFormat bf
```
    The bf.
- Method Detail
  - isBlank
```
boolean isBlank()
```
    true if this XBRLNumericValue has no value assigned .
    
    Returns:
    
    the bBlank
  - getDecimalsRealOrInferred
```
int getDecimalsRealOrInferred()
```
    Returns the accuracy of a fact as if it was reported using the decimals attribute. If the real representation of the accuracy is decimals then this method returns the value of the decimals attribute. Otherwise, the precision is converted to the equivalent (nearest) decimals attribute and it is returned.
    If the decimals or precision attribute is "INF" this method returns the INF constant that shall not be compared against any other value that is not INF
    
    Returns:
    
    int value of the real of inferred accuracy as indicated by the decimals attribute or the constant INF
    See Also: INF
  getPrecisionRealOrInferred int getPrecisionRealOrInferred() Returns the accuracy of a fact as if it was reported using the precision attribute. If the real representation of the accuracy is precision then this method returns the value of the precision attribute. Otherwise, the decimals is converted to the equivalent (nearest) precision attribute and it is returned. If the precision or decimals attribute is "INF" this method returns the INF constant that shall not be compared against any other value that is not INF Returns: int value of the real of inferred accuracy as indicated by the precision attribute or the constant INF See Also: INF hashCode int hashCode() Hash code. Overrides: hashCode in class java.lang.Object Returns: the int clone XBRLNumber clone() Clone. Returns: the XBRL number eq boolean eq(XBRLNumber vb) Eq. Parameters: vb - the vb Returns: true, if successful multiply XBRLNumber multiply(double weight) Multiply. Parameters: weight - the weight Returns: the XBRL number plus XBRLNumber plus(XBRLNumber sum) Plus. Parameters: sum - the sum Returns: the XBRL number ne boolean ne(XBRLNumber sumItem) Ne. Parameters: sumItem - the sum item Returns: true, if successful getFriendlyName java.lang.String getFriendlyName(int flags, LabelsProvider lp) Gets the friendly name. Parameters: flags - XMLFragment.HIDE_COMMON_ACCURACY can be used to remove suffixes lp - (can be null, it is not used) Returns: the friendly name isSameValue boolean isSameValue(XBRLNumber newVal) This compares this number representation with newVal number representation. The equals method compares the rounded number but this function compares just the represented number. In some circumstances (such as when the value is updated) it is required to compare this value representation with a new value representation and force value update even if the value is "equal" in XBRL terms Parameters: newVal - the new val Returns: true, if is same value clear void clear() Clear. isFraction boolean isFraction() Checks if is fraction. Returns: true if this XBRLNumber corresponds with a fraction item type that contains a numerator and a denominator. Note fractions do not contains precision or decimals isNumber boolean isNumber() Checks if is number. Returns: true if this XBRLNumber corresponds with a number reported with decimals or precision roundTo XBRLNumber roundTo(int precisionOrDecimals) Rounds the number to the specified value in the precisionOrDecimals parameter. This method raises a UnsupportedOperationException exception if the method is applied to a fraction number Parameters: precisionOrDecimals - the precision or decimals Returns: a new XBRLNumber rounded See Also: isNumber(), isFraction() round XBRLNumber round() applies round to defined decimals or precision attribute value and returns a new XBRLNumber. This is equivalent to call roungTo(getPrecisionOrDecimals()) in numeric values. Raises an UnsupportedOperationException on fraction values Returns: a new XBRLNumber rounded See Also: isNumber(), isFraction(), roundTo(int) getFinancialString java.lang.String getFinancialString() Returns a string representation of the number that satisfies common understanding by financial users, this method is used while formatting the values in the error messages, and might be used in other places. For XBRLNumericValue this returns a number that satisfies the pattern #,##0.####;(#,##0.####) For XBRLFractionValue this returns the numerator and denominator parts using the previous pattern and separated by a '/' character Returns: String representation of the XBRLNumber getBigDecimal java.math.BigDecimal getBigDecimal() If this XBRLNumber is a numeric value, this method returns a BigDecimal of the value. If this XBRLNumber is a fraction value, this method raises an UnsupportedOperationException Returns: the big decimal getValue java.lang.Number getValue() Access to the surrounding number value this object is encapsulating. Return null if the value is nil and the fact is assigned and isNil() returns true otherwise this returns the value, that also may be null. Returns: Number equals boolean equals(XBRLNumber other) returns the result of comparing the values of the fields for that are part of the XBRLNumeric value. This evaluation is stronger than the eq method. in other words two XBRLNumber might satisfy eq and not satisfy equals Parameters: other - the other Returns: boolean

Interface XBRLNumber

Nested Class Summary

Field Summary

Method Summary

Field Detail

INF

bf

Method Detail

isBlank

getDecimalsRealOrInferred

getPrecisionRealOrInferred

hashCode

clone

eq

multiply

plus

ne

getFriendlyName

isSameValue

clear

isFraction

isNumber

roundTo

round

getFinancialString

getBigDecimal

getValue

equals