com.ge.research.cmdemo.actions.mapping
Class StudentGradeDistributionMap

java.lang.Object
  com.ge.research.cmdemo.actions.mapping.StudentGradeDistributionMap

All Implemented Interfaces:

ResultSetMappingFunction

public class StudentGradeDistributionMap

extends java.lang.Object

implements ResultSetMappingFunction

Class level comments

Author:

parkns

Field Summary

protected java.lang.String	dateFormat Date format string to apply to the values of the yLabelColumn (if one exists) if the datatype of the column is a date type.
double	defaultCandleWidth The default width of the candle to be used if no custom width is specified
protected java.text.DateFormat	sdf Date format object to apply to the values of the yLabelColumn (if one exists) if the datatype of the column is a date type.

Constructor Summary

StudentGradeDistributionMap()

Method Summary

protected java.util.List	customProcess(java.sql.ResultSet rs, int yLabelCol, int xMinCol, int xMaxCol, double boxWidth, java.util.Map parameters) Creates a single dataseries from the argument ResultSet.
boolean	hasDataseriesOutput() Returns true if the return value from the ResultSetMappingFunction.process(java.sql.ResultSet, java.util.Map) method contains data suitable for constructing a dataseries.
boolean	hasTableOutput() Returns true if the return value from the ResultSetMappingFunction.process(java.sql.ResultSet, java.util.Map) method contains data suitable for constructing a table.
java.util.List[]	process(java.sql.ResultSet rs, java.util.Map parameters) Processes a ResultSet according to the parameters specified in the argument Map

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dateFormat

protected java.lang.String dateFormat

Date format string to apply to the values of the yLabelColumn (if one exists) if the datatype of the column is a date type.

sdf

protected java.text.DateFormat sdf

Date format object to apply to the values of the yLabelColumn (if one exists) if the datatype of the column is a date type.

defaultCandleWidth

public double defaultCandleWidth

The default width of the candle to be used if no custom width is specified

Constructor Detail

StudentGradeDistributionMap

public StudentGradeDistributionMap()

Method Detail

hasDataseriesOutput

public final boolean hasDataseriesOutput()

Description copied from interface: ResultSetMappingFunction

Returns true if the return value from the ResultSetMappingFunction.process(java.sql.ResultSet, java.util.Map) method contains data suitable for constructing a dataseries. The first element of the array would be a list of names of the dataseries. Each subsequent element of the returned array would represent a dataseries. The List preserves the order of the ResultSet, and each element of the List would contain Map objects. The Map would contain attribute keys such as xMin, xMax, yMin, yMax, xMinLabel, xMaxLabel, yMinLabel, yMaxLabel

Specified by:

hasDataseriesOutput in interface ResultSetMappingFunction

Returns:

true if the return value of the ResultSetMappingFunction#process(java.sql.ResultSet, java.util.Map) method contains dataseries information; false otherwise.

hasTableOutput

public final boolean hasTableOutput()

Description copied from interface: ResultSetMappingFunction

Returns true if the return value from the ResultSetMappingFunction.process(java.sql.ResultSet, java.util.Map) method contains data suitable for constructing a table. The first element of the array would be a list of column headings of the data table. Each subsequent element of the returned array would represent a table row. Within each table row would be a list representing each column of that row. Within each column would be an object array, with the zero-index element being the data for that row-column pair, and the one-index element being the decorator to apply to that row-column pair.

Specified by:

hasTableOutput in interface ResultSetMappingFunction

Returns:

true if the return value of the ResultSetMappingFunction#process(java.sql.ResultSet, java.util.Map) method contains table information; false otherwise.

process

public java.util.List[] process(java.sql.ResultSet rs,
                                java.util.Map parameters)

Description copied from interface: ResultSetMappingFunction

Processes a ResultSet according to the parameters specified in the argument Map

Specified by:

process in interface ResultSetMappingFunction

Parameters:

rs - the query data to process

parameters - the mapping parameters by which to manipulate the ResultSet data

Returns:

an array of List objects containing the mapped elements of the processed data from the ResultSet. The details of the List contents are described by the ResultSetMappingFunction.hasDataseriesOutput() and ResultSetMappingFunction.hasTableOutput() methods.

See Also:

ResultSetMappingFunction.hasDataseriesOutput(), ResultSetMappingFunction.hasTableOutput()

customProcess

protected java.util.List customProcess(java.sql.ResultSet rs,
                                       int yLabelCol,
                                       int xMinCol,
                                       int xMaxCol,
                                       double boxWidth,
                                       java.util.Map parameters)

Creates a single dataseries from the argument ResultSet. Uses the row order of the argument ResultSet as the yMin value for the dataseries. If the yLabelCol argument is greater than 0 and the ResultSet contains that column, uses the value of that column as the yMinLabel value for the dataseries. If the xMinCol argument is greater than 0 and the ResultSet contains that column, uses the value of that column as the xMin value for the dataseries. If the xMaxCol argument is greater than 0 and the ResultSet contains that column, uses the value of that column as the xMax value for the dataseries.

Parameters:

rs - the query data to process

yLabelCol - the column from which to extract yLabel values from the data

xMinCol - the column from which to extract xMin values from the data

xMaxCol - the column from which to extract xMax values from the data

parameters - the mapping parameters by which to manipulate the ResultSet data

Returns:

An array of List objects containing the mapped elements of the processed data from the ResultSet. Each element of the returned array represents a dataseries. The List preserves the order of the ResultSet, and each element of the List contains Map objects.