|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.tools.reporting.reports.ReportDataBean
The ReportDataBean class extends the SmartDataBeanImpl class to create a report. ReportDataBean is used on the JSP displaying the report data. ReportDataBean will be populated by the use of DataBeanManager.
Field Summary | |
protected java.util.Vector |
_columnTitles
Vector containing the keys for the Hashtable representing the rows of the report. |
protected java.util.Vector |
_columnTitlesName
Vector containing the colum names. |
protected java.util.Hashtable |
_env
Variable for the hashtable containing the input parameters to construct the SQL query to generate the report. |
protected int |
_errorCode
Numeric value indicating if the report ran successfully or not. |
protected java.util.Locale |
_locale
Variable for the locale used. |
protected java.lang.String |
_messageValue
Variable for the key of _messageValue. |
protected int |
_numberOfColumns
Variable for the number of columns in the report. |
protected int |
_numberOfRows
Variable for the number of rows in the report. |
protected TypedProperty |
_queryParameters
Not used. |
protected java.util.Vector |
_reportData
Vector containing the data generated by the report. |
protected java.lang.String |
_sqlId
Parameter for the SQL id used for this report. |
protected java.lang.String |
_title
Variable used for the title of the report. |
protected java.lang.Object |
_userDefinedParameters
Variable for the user defined parameters from the XML file defining the report. |
protected java.util.Hashtable |
_xml
Not used. |
static java.lang.String |
COPYRIGHT
Copyright |
Fields inherited from class com.ibm.commerce.beans.SmartDataBeanImpl |
commandContext |
Fields inherited from class com.ibm.commerce.beans.InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans.DataBean |
emptyString |
Constructor Summary | |
ReportDataBean()
Constructs a ReportDataBean object. |
Method Summary | |
protected java.util.Hashtable |
constructEnv()
Method used to construct the hashtable used to generate the report. |
java.lang.String |
getColumnTitles(int i)
Getter for an element of the Vector _columnTitles. |
java.util.Vector |
getColumnTitlesName()
Getter for _columnTitlesName. |
java.lang.String |
getColumnTitlesName(int i)
Getter for a specific element of the Vector _columnTitlesName. |
java.util.Hashtable |
getEnv()
Getter for _env. |
int |
getErrorCode()
Getter for _errorCode. |
java.lang.String |
getMessageValue()
Getter for _messageValue. |
int |
getNumberOfColumns()
Getter for _numberOfColumns. |
int |
getNumberOfRows()
Getter for _numberOfRows. |
java.util.Vector |
getReportData()
Getter for _reportData. |
java.util.Hashtable |
getRow(int i)
Getter for a specific element (row of the report) of the Vector _reportData. |
java.lang.String |
getSqlId()
Getter for _sqlId. |
java.lang.String |
getTitleName()
Getter for _title. |
java.lang.Object |
getUserDefinedParameters()
Getter for _userDefinedParameters. |
java.lang.String |
getValue(int i,
int j)
Getter for a value from _reportData. |
java.lang.String |
getValue(int i,
java.lang.String key)
Getter for a value from _reportData. |
protected void |
initialize()
Used to initialize the following variables: _numberOfColumns, _numberOfRows and _reportData. |
protected java.util.Vector |
keyListToVector(java.lang.String keyList)
This method will transform a string into a vector of keys. |
void |
populate()
Method used to populate the ReportDataBean. |
void |
setEnv(java.util.Hashtable env)
Setter for _env. |
void |
setLocale(java.util.Locale locale)
Setter for _locale. |
void |
setParameters(TypedProperty queryParameters)
Setter for _queryParameters. |
void |
setSqlId(java.lang.String sqlId)
Setter for _sqlId. |
void |
setXML(java.util.Hashtable xml)
Setter for _xml. |
Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl |
fulfills, getCommandContext, getResources, setCommandContext |
Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl |
getRequestProperties, setRequestProperties |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.beans.InputDataBean |
getRequestProperties, setRequestProperties |
Field Detail |
protected java.util.Vector _columnTitles
protected java.util.Vector _columnTitlesName
protected java.util.Hashtable _env
protected int _errorCode
protected java.util.Locale _locale
protected java.lang.String _messageValue
protected int _numberOfColumns
protected int _numberOfRows
protected TypedProperty _queryParameters
protected java.util.Vector _reportData
protected java.lang.String _sqlId
protected java.lang.String _title
protected java.lang.Object _userDefinedParameters
protected java.util.Hashtable _xml
public static final java.lang.String COPYRIGHT
Constructor Detail |
public ReportDataBean()
Method Detail |
protected java.util.Hashtable constructEnv()
ECSystemException
- ParameterNotFoundException
- public java.lang.String getColumnTitles(int i)
public java.util.Vector getColumnTitlesName()
public java.lang.String getColumnTitlesName(int i)
public java.util.Hashtable getEnv()
public int getErrorCode()
public java.lang.String getMessageValue()
public int getNumberOfColumns()
public int getNumberOfRows()
public java.util.Vector getReportData()
public java.util.Hashtable getRow(int i)
i
- The row (i+1) in the report.public java.lang.String getSqlId()
public java.lang.String getTitleName()
public java.lang.Object getUserDefinedParameters()
public java.lang.String getValue(int i, int j)
i
- The row (i+1) of the report.j
- The position of the column key in the vector _columnTitles.public java.lang.String getValue(int i, java.lang.String key)
i
- The row (i+1) of the report.key
- The column key in the vector _columnTitles.protected void initialize()
protected java.util.Vector keyListToVector(java.lang.String keyList)
keyList
- The string of keys separated by comma to transform into a vector of keys.public void populate() throws java.lang.Exception
populate
in class SmartDataBeanImpl
public void setEnv(java.util.Hashtable env)
env
- The hashtable for the parameters used to create the SQL query.public void setLocale(java.util.Locale locale)
locale
- The locale to be used for display.public void setParameters(TypedProperty queryParameters)
public void setSqlId(java.lang.String sqlId)
sqlId
- The SQL id used to identify which SQL query to be used.public void setXML(java.util.Hashtable xml)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |