Package org.netxms.client.datacollection

Class DataFormatter

java.lang.Object
org.netxms.client.datacollection.DataFormatter
public class DataFormatter extends Object
Data formatter

  • Constructor Details

    • DataFormatter

      public DataFormatter()
      Create new data formatter

    • DataFormatter

      public DataFormatter(DataSeries series)
      Create new data formatter
      Parameters:
      series - data series

    • DataFormatter

      public DataFormatter(DciValue dciValue)
      Parameters:
      dciValue -

  • Method Details

    • setFormatString

      public DataFormatter setFormatString(String formatString)
      Set format string
      Parameters:
      formatString - the formatString to set
      Returns:
      this

    • setDataType

      public DataFormatter setDataType(DataType dataType)
      Set data type
      Parameters:
      dataType - the dataType to set
      Returns:
      this

    • setMeasurementUnit

      public DataFormatter setMeasurementUnit(MeasurementUnit unit)
      Set measurement unit
      Parameters:
      unit - the unit to set
      Returns:
      this

    • setMultiplierPower

      public DataFormatter setMultiplierPower(int multiplierPower)
      Set multiplier power
      Parameters:
      multiplierPower - the multiplierPower to set
      Returns:
      this

    • setUseMultipliers

      public DataFormatter setUseMultipliers(int useMultipliers)
      Set multiplier usage flag. Value DciValue.MULTIPLIERS_NO suppresses multipliers even if they are requested by format string.
      Parameters:
      useMultipliers - the useMultipliers to set
      Returns:
      this

    • setDefaultForMultipliers

      public DataFormatter setDefaultForMultipliers(boolean useMultipliersByDefault)
      Set default for multipliers
      Parameters:
      useMultipliersByDefault - the useMultipliersByDefault to set
      Returns:
      this

    • setDefaultFormatString

      public DataFormatter setDefaultFormatString(String withoutMultipliers, String withMultipliers)
      Set default format strings
      Parameters:
      withoutMultipliers - default format string without multipliers
      withMultipliers - default format string with multipliers
      Returns:
      this

    • setMappingTable

      public DataFormatter setMappingTable(MappingTable mappingTable)
      Set mapping table to translate raw values into display strings. When set and a lookup hits, the mapped value is returned as-is and the rest of the format pipeline is bypassed.
      Parameters:
      mappingTable - mapping table to use, or null to disable mapping
      Returns:
      this

    • format

      public String format(String value, TimeFormatter timeFormatter)
      Format value
      Parameters:
      value - The value
      timeFormatter - Date and time formatter
      Returns:
      The formatted value

    • roundDecimalValue

      public static String roundDecimalValue(double value, double step, int maxPrecision)
      Get rounded value for chart labels
      Parameters:
      value - to round
      step - of label
      maxPrecision - desired precision
      Returns:
      rounded value

    • roundDecimalValue

      public static String roundDecimalValue(double value, double step, int maxPrecision, MeasurementUnit unit)
      Get rounded value for chart labels
      Parameters:
      value - to round
      step - of label
      maxPrecision - desired precision
      unit - measurement unit (used to select binary or decimal multipliers)
      Returns:
      rounded value

    • parseNumberWithSuffix

      public static double parseNumberWithSuffix(String text) throws NumberFormatException
      Parse number with optional multiplier suffix. Supported suffixes are K, M, G, T, and P (case insensitive), optionally followed by "i" for binary multipliers (Ki = 1024, Mi = 1048576, and so on). Space between number and suffix is allowed.
      Parameters:
      text - text to parse
      Returns:
      parsed value
      Throws:
      NumberFormatException - if given text does not represent valid number

    • formatNumberWithSuffix

      public static String formatNumberWithSuffix(double value)
      Format number for editing, using multiplier suffix if it can be done without precision loss. Produced text can be read back by parseNumberWithSuffix.
      Parameters:
      value - value to format
      Returns:
      formatted value