org.sweble.wikitext.engine.ext.convert

Class NumberFormater

java.lang.Object

org.sweble.wikitext.engine.ext.convert.NumberFormater

public final class NumberFormater
extends Object

Method Summary

Modifier and Type	Method and Description
static String	asSubscriptNumber(String numStr) Replaces all digit characters and the minus-sing with the corresponding Unicode subscript symbols.
static String	asSuperscriptNumber(String numStr) Replaces all digit characters and the minus-sing with the corresponding Unicode superscript symbols.
protected static String	formatNumberDefault(double convertedValue, int sigFig) Formats the given value like Wikipedia does on default.
static String	formatNumberRounded(double convertedValue, int digitsAfterFloatingPoint) Rounds and formats a value to the given count of digits after the floating point.
static String	formatRegular(BigDecimal number)
static String	formatRegular(double number)
static String	formatScientific(double number)
protected static boolean	isNumberValid(String numberStr) Checks if the given number string is probably a valid value.
protected static double	parseNumber(String numberStr) Tries to parse a number-string into a valid double value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

formatScientific

public static String formatScientific(double number)

formatRegular

public static String formatRegular(double number)

formatRegular

public static String formatRegular(BigDecimal number)

formatNumberRounded

public static String formatNumberRounded(double convertedValue,
                                         int digitsAfterFloatingPoint)

Rounds and formats a value to the given count of digits after the floating point.

Parameters:

convertedValue - The value to format.

digitsAfterFloatingPoint - Digits behind the floating point [0..16].

Returns:

The formated value as String.

formatNumberDefault

protected static String formatNumberDefault(double convertedValue,
                                            int sigFig)

Formats the given value like Wikipedia does on default. This includes the conversion to scientific notation, adding of thousand separators and rounding on various scales (depending on the amount of digits).

Parameters:

convertedValue - The value to format.

sigFig - The count of significant figures to round.

Returns:

The formated value as string.

isNumberValid

protected static boolean isNumberValid(String numberStr)

Checks if the given number string is probably a valid value. Since the check is only made on appearing characters, there might be the chance, that a wrong used number syntax let a conversion with parseNumber() fail anyway.

Parameters:

numberStr - The number as string to check.

Returns:

True if the string is most likely a valid value, otherwise false.

See Also:

parseNumber()

parseNumber

protected static double parseNumber(String numberStr)
                             throws NumberFormatException

Tries to parse a number-string into a valid double value. The following notations are supported: "12" = 12 "1,234" = 1234 "12.3e-15" = 1.23e-14 Fractions: "1/2" = 0.5 "1⁄3" = 0.33333333 "2+1⁄2" = 2.5 "-2-1⁄2" = -2.5 "1//2" = 0.5

Parameters:

numberStr - The number as string to convert.

Returns:

The parsed number as double value.

Throws:

NumberFormatException

See Also:

https://en.wikipedia.org/wiki/Template:Convert/doc#Numbers

asSuperscriptNumber

public static String asSuperscriptNumber(String numStr)

Replaces all digit characters and the minus-sing with the corresponding Unicode superscript symbols.

Parameters:

numStr - The String containing the numbers.

Returns:

The number string with the substituted characters.

asSubscriptNumber

public static String asSubscriptNumber(String numStr)

Replaces all digit characters and the minus-sing with the corresponding Unicode subscript symbols.

Parameters:

numStr - The String containing the numbers.

Returns:

The number string with the substituted characters.