com.ibm.commerce.store.util

Class ReportDisplayHelper

  • java.lang.Object
    • com.ibm.commerce.store.util.ReportDisplayHelper


  • public class ReportDisplayHelper
    extends java.lang.Object

    This helper class is used for getting friendly displayable strings from the ReportDataBean.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static java.lang.String getColumnName(java.util.ResourceBundle reportsRB, java.util.Hashtable columnAttributes)
      Get the NL column name of the current column.
      static java.lang.String getEnvAttribute(com.ibm.commerce.tools.reporting.reports.ReportDataBean reportDB, java.lang.String key)
      Get the environment attribute.
      static java.lang.String getFormattedDate(java.lang.String value, java.util.Locale locale)
      Get the formatted date.
      static java.util.Vector getReportColumnAttributes(com.ibm.commerce.tools.reporting.reports.ReportDataBean reportDB)
      Get all column attributes of the report.
      static java.lang.String retrieveColumnEntryString(int iRowNumber, java.util.Hashtable columnAttributes, java.util.Hashtable reportsRB, com.ibm.commerce.tools.reporting.reports.ReportDataBean reportDB, com.ibm.commerce.common.objects.StoreAccessBean storeAB, java.lang.Integer languageId, java.util.Locale locale, java.lang.String currency)
      Retrieve the data in the particular entry of the report data bean
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ReportDisplayHelper

        public ReportDisplayHelper()
    • Method Detail

      • getColumnName

        public static java.lang.String getColumnName(java.util.ResourceBundle reportsRB,
                                                     java.util.Hashtable columnAttributes)

        Get the NL column name of the current column.

        Parameters:
        reportsRB - ResourceBundle The resource bundle with the NL mappings
        columnAttributes - Hashtable The report's current column attributes
        Returns:
        String The NL column name
      • getEnvAttribute

        public static java.lang.String getEnvAttribute(com.ibm.commerce.tools.reporting.reports.ReportDataBean reportDB,
                                                       java.lang.String key)

        Get the environment attribute.

        Parameters:
        reportDB - ReportDataBean The report data bean
        key - String The key of the attribute
        Returns:
        String The environment attribute
      • getFormattedDate

        public static java.lang.String getFormattedDate(java.lang.String value,
                                                        java.util.Locale locale)

        Get the formatted date.

        Parameters:
        value - String The value that neeeds to be formatted
        locale - Locale The locale to format the value as
        Returns:
        String The NL formatted date
      • getReportColumnAttributes

        public static java.util.Vector getReportColumnAttributes(com.ibm.commerce.tools.reporting.reports.ReportDataBean reportDB)

        Get all column attributes of the report.

        Parameters:
        reportDB - ReportDataBean The report data bean
        Returns:
        Vector All column attributes
      • retrieveColumnEntryString

        public static java.lang.String retrieveColumnEntryString(int iRowNumber,
                                                                 java.util.Hashtable columnAttributes,
                                                                 java.util.Hashtable reportsRB,
                                                                 com.ibm.commerce.tools.reporting.reports.ReportDataBean reportDB,
                                                                 com.ibm.commerce.common.objects.StoreAccessBean storeAB,
                                                                 java.lang.Integer languageId,
                                                                 java.util.Locale locale,
                                                                 java.lang.String currency)

        Retrieve the data in the particular entry of the report data bean

        Parameters:
        rowIndex - int The index of the report's row being displayed
        columnAttributes - Hashtable The report's current column attributes
        reportsRB - Hashtable The NL properties hashtable
        reportDB - ReportDataBean The report data bean
        storeAB - StoreAccessBean The store access bean
        languageId - Integer The language id
        locale - Locale The locale to format the value as
        defaultCurrency - String A default currency in case the report column attribute does not specify currency
        Returns:
        String The displayable string for the entry of the report