Class ParameterValidationUtil

java.lang.Object
org.eclipse.birt.report.model.api.util.ParameterValidationUtil

public class ParameterValidationUtil extends Object
Validates the parameter value with the given data type and format pattern string. This util class can validate the parameter of the following types:
  • PARAM_TYPE_DATETIME
  • PARAM_TYPE_FLOAT
  • PARAM_TYPE_DECIMAL
  • PARAM_TYPE_BOOLEAN
  • PARAM_TYPE_STRING
  • PARAM_TYPE_INTEGER
  • PARAM_TYPE_DATE
  • PARAM_TYPE_TIME
See Also:
  • Field Details

  • Constructor Details

    • ParameterValidationUtil

      public ParameterValidationUtil()
  • Method Details

    • validate

      public static Object validate(String dataType, String format, String value, Locale locale) throws ValidationValueException
      Validates a input parameter value with the given data type, format choice string. The returned value is locale and pattern dependent. The data type and the format can be one pair of the following:

      Data Type Format Type
      Float/Decimal
      • General Number
      • Currency
      • Fixed
      • Percent
      • Scientific
      • Standard
      • pattern string, such as "###,##0", "###,##0.00 'm/s'", "###.#\';';#" and so on.
      Date time
      • General Date
      • Long Date
      • Medium Date
      • Short Date
      • Long Time
      • Medium Time
      • Short Time
      • pattern string, such as "MM/dd/yyyy hh:mm:ss a", "yyyy-MM-dd HH:mm:ss" and so on.
      String
      • Upper case
      • Lower case
      • pattern string, such as "lt!" and so on.
      Parameters:
      dataType - the data type of the value
      format - the format choice string
      value - the input value to validate
      locale - the locale information
      Returns:
      the validated value if the input value is valid for the given data type and format choice string
      Throws:
      ValidationValueException - if the input value is not valid with the given data type and format string
    • validate

      public static Object validate(String dataType, String format, String value, Locale locale, com.ibm.icu.util.TimeZone timeZone) throws ValidationValueException
      Validates a input parameter value with the given data type, format choice string. The returned value is locale and pattern dependent. The data type and the format can be one pair of the following:

      Data Type Format Type
      Float/Decimal
      • General Number
      • Currency
      • Fixed
      • Percent
      • Scientific
      • Standard
      • pattern string, such as "###,##0", "###,##0.00 'm/s'", "###.#\';';#" and so on.
      Date time
      • General Date
      • Long Date
      • Medium Date
      • Short Date
      • Long Time
      • Medium Time
      • Short Time
      • pattern string, such as "MM/dd/yyyy hh:mm:ss a", "yyyy-MM-dd HH:mm:ss" and so on.
      String
      • Upper case
      • Lower case
      • pattern string, such as "lt!" and so on.
      Parameters:
      dataType - the data type of the value
      format - the format choice string
      value - the input value to validate
      locale - the locale information
      timeZone - the time zone information
      Returns:
      the validated value if the input value is valid for the given data type and format choice string
      Throws:
      ValidationValueException - if the input value is not valid with the given data type and format string
    • validate

      public static Object validate(String dataType, String format, String value, com.ibm.icu.util.TimeZone timeZone) throws ValidationValueException
      Validates a input parameter value with the given data type, format choice string, using the default locale. The returned value is locale and pattern dependent. The data type and the format can be one pair of the following:

      Data Type Format Type
      Float/Decimal
      • General Number
      • Currency
      • Fixed
      • Percent
      • Scientific
      • Standard
      • pattern string, such as "###,##0", "###,##0.00 'm/s'", "###.#\';';#" and so on.
      Date time
      • General Date
      • Long Date
      • Medium Date
      • Short Date
      • Long Time
      • Medium Time
      • Short Time
      • pattern string, such as "MM/dd/yyyy hh:mm:ss a", "yyyy-MM-dd HH:mm:ss" and so on.
      String
      • Upper case
      • Lower case
      • pattern string, such as "lt!" and so on.
      Parameters:
      dataType - the data type of the value
      format - the format choice string
      value - the input value to validate
      timeZone - the time zone information
      Returns:
      the validated value if the input value is valid for the given data type and format choice string
      Throws:
      ValidationValueException - if the input value is not valid with the given data type and format string
    • validate

      public static Object validate(String dataType, String format, String value, com.ibm.icu.util.ULocale locale) throws ValidationValueException
      Validates a input parameter value with the given data type, format choice string. The returned value is locale and pattern dependent. The data type and the format can be one pair of the following:

      Data Type Format Type
      Float/Decimal
      • General Number
      • Currency
      • Fixed
      • Percent
      • Scientific
      • Standard
      • pattern string, such as "###,##0", "###,##0.00 'm/s'", "###.#\';';#" and so on.
      Date time
      • General Date
      • Long Date
      • Medium Date
      • Short Date
      • Long Time
      • Medium Time
      • Short Time
      • pattern string, such as "MM/dd/yyyy hh:mm:ss a", "yyyy-MM-dd HH:mm:ss" and so on.
      String
      • Upper case
      • Lower case
      • pattern string, such as "lt!" and so on.
      Parameters:
      dataType - the data type of the value
      format - the format choice string
      value - the input value to validate
      locale - the locale information
      Returns:
      the validated value if the input value is valid for the given data type and format choice string
      Throws:
      ValidationValueException - if the input value is not valid with the given data type and format string
    • validate

      public static Object validate(String dataType, String format, String value, com.ibm.icu.util.ULocale locale, com.ibm.icu.util.TimeZone timeZone) throws ValidationValueException
      Validates a input parameter value with the given data type, format choice string. The returned value is locale and pattern dependent. The data type and the format can be one pair of the following:

      Data Type Format Type
      Float/Decimal
      • General Number
      • Currency
      • Fixed
      • Percent
      • Scientific
      • Standard
      • pattern string, such as "###,##0", "###,##0.00 'm/s'", "###.#\';';#" and so on.
      Date time
      • General Date
      • Long Date
      • Medium Date
      • Short Date
      • Long Time
      • Medium Time
      • Short Time
      • pattern string, such as "MM/dd/yyyy hh:mm:ss a", "yyyy-MM-dd HH:mm:ss" and so on.
      String
      • Upper case
      • Lower case
      • pattern string, such as "lt!" and so on.
      Parameters:
      dataType - the data type of the value
      format - the format choice string
      value - the input value to validate
      locale - the locale information
      timeZone - the time zone information (only valid for DateTime type)
      Returns:
      the validated value if the input value is valid for the given data type and format choice string
      Throws:
      ValidationValueException - if the input value is not valid with the given data type and format string
    • validate

      public static Object validate(String dataType, String format, String value) throws ValidationValueException
      Validates a input parameter value with the given data type, format choice string and a default locale defined by the class(Locale.US). The returned value is pattern dependent. The data type and the format can be one pair of the following:

      Data Type Format Type
      Float/Decimal
      • General Number
      • Currency
      • Fixed
      • Percent
      • Scientific
      • Standard
      • pattern string, such as "###,##0", "###,##0.00 'm/s'", "###.#\';';#" and so on.
      Date time
      • General Date
      • Long Date
      • Medium Date
      • Short Date
      • Long Time
      • Medium Time
      • Short Time
      • pattern string, such as "MM/dd/yyyy hh:mm:ss a", "yyyy-MM-dd HH:mm:ss" and so on.
      String
      • Upper case
      • Lower case
      • pattern string, such as "lt!" and so on.
      Parameters:
      dataType - the data type of the value
      format - the format choice string
      value - the input value to validate
      Returns:
      the validated value if the input value is valid for the given data type and format choice string
      Throws:
      ValidationValueException - if the input value is not valid with the given data type and format string
    • getDisplayValue

      public static String getDisplayValue(String dataType, String format, Object value, Locale locale)
      Gets the display string for the value with the given data type, format, locale. The value must be the valid data type. That is:
      • if data type is PARAM_TYPE_DATETIME, then the value must be java.util.Date.
      • if the data type is PARAM_TYPE_FLOAT, then the value must be java.lang.Double.
      • if the data type is PARAM_TYPE_DECIMAL, then the value must be java.math.BigDecimal.
      • if the data type is PARAM_TYPE_BOOLEAN, then the value must be java.lang.Boolean.
      • if the data type is PARAM_TYPE_STRING, then the value must be java.lang.String.
      Parameters:
      dataType - the data type of the input value
      format - the format pattern to validate
      value - the input value to validate
      locale - the locale information
      Returns:
      the formatted string
    • getDisplayValue

      public static String getDisplayValue(Object value)
      Gets the display string for the value with default locale and default format, The value must be the valid data type. That is:
      • if data type is PARAM_TYPE_DATETIME, then the value must be java.util.Date.
      • if the data type is PARAM_TYPE_FLOAT, then the value must be java.lang.Double.
      • if the data type is PARAM_TYPE_DECIMAL, then the value must be java.math.BigDecimal.
      • if the data type is PARAM_TYPE_BOOLEAN, then the value must be java.lang.Boolean.
      • if the data type is PARAM_TYPE_STRING, then the value must be java.lang.String.
      Parameters:
      value - the input value to validate
      Returns:
      the formatted string
    • getDisplayValue

      public static String getDisplayValue(Object value, com.ibm.icu.util.TimeZone timeZone)
      Gets the display string for the value with default locale and default format, The value must be the valid data type. That is:
      • if data type is PARAM_TYPE_DATETIME, then the value must be java.util.Date.
      • if the data type is PARAM_TYPE_FLOAT, then the value must be java.lang.Double.
      • if the data type is PARAM_TYPE_DECIMAL, then the value must be java.math.BigDecimal.
      • if the data type is PARAM_TYPE_BOOLEAN, then the value must be java.lang.Boolean.
      • if the data type is PARAM_TYPE_STRING, then the value must be java.lang.String.
      Parameters:
      value - the input value to validate
      timeZone - the time zone to use (only for DateTime type)
      Returns:
      the formatted string
    • getDisplayValue

      public static String getDisplayValue(String dataType, String format, Object value, com.ibm.icu.util.ULocale locale)
      Gets the display string for the value with the given data type, format, locale. The value must be the valid data type. That is:
      • if data type is PARAM_TYPE_DATETIME, then the value must be java.util.Date.
      • if the data type is PARAM_TYPE_FLOAT, then the value must be java.lang.Double.
      • if the data type is PARAM_TYPE_DECIMAL, then the value must be java.math.BigDecimal.
      • if the data type is PARAM_TYPE_BOOLEAN, then the value must be java.lang.Boolean.
      • if the data type is PARAM_TYPE_STRING, then the value must be java.lang.String.
      Parameters:
      dataType - the data type of the input value
      format - the format pattern to validate
      value - the input value to validate
      locale - the locale information
      Returns:
      the formatted string
    • getDisplayValue

      public static String getDisplayValue(String dataType, String format, Object value, com.ibm.icu.util.ULocale locale, com.ibm.icu.util.TimeZone timeZone)
      Gets the display string for the value with the given data type, format, locale. The value must be the valid data type. That is:
      • if data type is PARAM_TYPE_DATETIME, then the value must be java.util.Date.
      • if the data type is PARAM_TYPE_FLOAT, then the value must be java.lang.Double.
      • if the data type is PARAM_TYPE_DECIMAL, then the value must be java.math.BigDecimal.
      • if the data type is PARAM_TYPE_BOOLEAN, then the value must be java.lang.Boolean.
      • if the data type is PARAM_TYPE_STRING, then the value must be java.lang.String.
      Parameters:
      dataType - the data type of the input value
      format - the format pattern to validate
      value - the input value to validate
      locale - the locale information
      Returns:
      the formatted string
    • getDisplayValue

      public static String getDisplayValue(String dataType, String format, Object value)
      Gets the display string for the value with the given data type, format and the default locale defined by the class(Locale.US). The value must be the valid data type. That is:
      • if data type is PARAM_TYPE_DATETIME, then the value must be java.util.Date.
      • if the data type is PARAM_TYPE_FLOAT, then the value must be java.lang.Double.
      • if the data type is PARAM_TYPE_DECIMAL, then the value must be java.math.BigDecimal.
      • if the data type is PARAM_TYPE_BOOLEAN, then the value must be java.lang.Boolean.
      • if the data type is PARAM_TYPE_STRING, then the value must be java.lang.String.
      Parameters:
      dataType - the data type of the input value
      format - the format pattern to validate
      value - the input value to validate
      Returns:
      the formatted string