Package com.inet.report.chart.format

Class FixedNumberFormat

  • All Implemented Interfaces:
    ChartFormat, java.io.Serializable, java.lang.Cloneable
    public class FixedNumberFormat
extends java.text.NumberFormat
implements ChartFormat
    This is a "fixed" number format.
    There are three format styles available: number, percent and currency. The number style format shows the value as is.
    The percent style format multiplies the values with 100 and shows the percent symbol. The currency style format shows the currency symbol.
    The percent and currency symbol position is decided from locale to locale.
    Since:
    8.0
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.text.NumberFormat

        java.text.NumberFormat.Field

    • Constructor Summary

      Constructors 
      Constructor Description
      FixedNumberFormat()
      Creates a new instance of format with type FORMAT_NUMBER and default properties.
      FixedNumberFormat​(int type)
      Creates a new instance of format with default properties.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FixedNumberFormat clone()
      Overrides Cloneable
      java.lang.StringBuffer format​(double number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
      java.lang.StringBuffer format​(long number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
      Abbreviation getAbbreviation()
      Returns the abbreviation of formatted values.
      int getMinusSymbol()
      Returns the flag that control the placing and form of the minus symbol.
      protected java.lang.String getName()
      FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.
      int getNumberOfDecimalPlaces()
      Returns the number of decimal places of this number format.
      int getType()
      Returns the formating type: number, currency or percent.
      boolean isUseThousandSeparator()
      Returns the flag that controls the showing of thousands separator.
      java.lang.Number parse​(java.lang.String source, java.text.ParsePosition parsePosition)
      void readProperties​(org.w3c.dom.Element element)
      Reads the XML properties of a chart format.
      void saveProperties​(java.lang.StringBuilder buffer, int depth)
      Writes the format properties to output.
      void setAbbreviation​(Abbreviation abbreviation)
      Sets the abbreviation of formatted values.
      void setFormatingProperties​(com.inet.report.chart.format.FormatingProperties properties)
      Sets the location specific formating properties, e.g. locale, time zone, first day of week.
      void setMinusSymbol​(int minusSymbol)
      Sets the flag that control the placing and form of the minus symbol.
      void setNumberOfDecimalPlaces​(int numberOfDecimalPlaces)
      Sets the number of decimal places of this number format.
      void setUseThousandSeparator​(boolean useThousandSeparator)
      Sets the flag that controls the showing of thousands separator.

      • Methods inherited from class java.text.NumberFormat

        equals, format, format, format, getAvailableLocales, getCurrency, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, getRoundingMode, hashCode, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setCurrency, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode

      • Methods inherited from class java.text.Format

        format, formatToCharacterIterator, parseObject

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEFAULT_NUMBER_OF_DECIMAL_PLACES

        public static final int DEFAULT_NUMBER_OF_DECIMAL_PLACES
        Default number of decimal places.
        See Also:
        Constant Field Values

      • DEFAULT_USE_THOUSANDS_SEPARATOR

        public static final boolean DEFAULT_USE_THOUSANDS_SEPARATOR
        Default using of thousands separator.
        See Also:
        Constant Field Values

      • DEFAULT_ABBREVIATION

        public static final Abbreviation DEFAULT_ABBREVIATION
        The default abbreviation.

      • MINUS_SIGN_BEFORE

        public static final int MINUS_SIGN_BEFORE
        Minus symbol is placed before number.
        See Also:
        Constant Field Values

      • MINUS_SIGN_AFTER

        public static final int MINUS_SIGN_AFTER
        Minus symbol is placed after number.
        See Also:
        Constant Field Values

      • MINUS_SIGN_BRACKETS

        public static final int MINUS_SIGN_BRACKETS
        Use brackets instead of minus.
        See Also:
        Constant Field Values

      • MINUS_SIGN_SYSTEM_DEFAULT

        public static final int MINUS_SIGN_SYSTEM_DEFAULT
        Use system default pattern for negative values.
        See Also:
        Constant Field Values

      • FORMAT_NUMBER

        public static final int FORMAT_NUMBER
        The number format style
        See Also:
        Constant Field Values

      • FORMAT_PERCENT

        public static final int FORMAT_PERCENT
        The percent format style
        See Also:
        Constant Field Values

      • FORMAT_CURRENCY

        public static final int FORMAT_CURRENCY
        The currency format style
        See Also:
        Constant Field Values

    • Method Detail

      • getNumberOfDecimalPlaces

        public int getNumberOfDecimalPlaces()
        Returns the number of decimal places of this number format. The format handles a value with more digits to the right of the decimal point as set with this function by rounding up.
        Returns:
        the number of decimals.
        Since:
        8.0
        See Also:
        setNumberOfDecimalPlaces(int)

      • setNumberOfDecimalPlaces

        public void setNumberOfDecimalPlaces​(int numberOfDecimalPlaces)
        Sets the number of decimal places of this number format. The format handles a value with more digits to the right of the decimal point as set with this function by rounding up.
        Parameters:
        numberOfDecimalPlaces - the number of places
        Throws:
        java.lang.IllegalArgumentException - by negative number.
        Since:
        8.0

      • isUseThousandSeparator

        public boolean isUseThousandSeparator()
        Returns the flag that controls the showing of thousands separator.
        Returns:
        the flag.
        Since:
        8.0
        See Also:
        setUseThousandSeparator(boolean)

      • setUseThousandSeparator

        public void setUseThousandSeparator​(boolean useThousandSeparator)
        Sets the flag that controls the showing of thousands separator.
        Parameters:
        useThousandSeparator - the flag
        Since:
        8.0
        See Also:
        isUseThousandSeparator()

      • getMinusSymbol

        public int getMinusSymbol()
        Returns the flag that control the placing and form of the minus symbol.
        Returns:
        the flag.
        Since:
        8.0
        See Also:
        setMinusSymbol(int)

      • setFormatingProperties

        public void setFormatingProperties​(com.inet.report.chart.format.FormatingProperties properties)
        Sets the location specific formating properties, e.g. locale, time zone, first day of week.
        Specified by:
        setFormatingProperties in interface ChartFormat
        Parameters:
        properties - the properties object (null not permitted)

      • format

        public java.lang.StringBuffer format​(double number,
                                     java.lang.StringBuffer toAppendTo,
                                     java.text.FieldPosition pos)
        Specified by:
        format in class java.text.NumberFormat

      • format

        public java.lang.StringBuffer format​(long number,
                                     java.lang.StringBuffer toAppendTo,
                                     java.text.FieldPosition pos)
        Specified by:
        format in class java.text.NumberFormat

      • parse

        public java.lang.Number parse​(java.lang.String source,
                              java.text.ParsePosition parsePosition)
        Specified by:
        parse in class java.text.NumberFormat

      • saveProperties

        public void saveProperties​(java.lang.StringBuilder buffer,
                           int depth)
        Writes the format properties to output.
        Specified by:
        saveProperties in interface ChartFormat
        Parameters:
        buffer - the output
        depth - the depth of XML indent

      • clone

        public FixedNumberFormat clone()
        Overrides Cloneable
        Specified by:
        clone in interface ChartFormat
        Overrides:
        clone in class java.text.NumberFormat
        Returns:
        the chart format

      • getName

        protected java.lang.String getName()
        FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.
        Returns:
        the name.