com.dpslink.flash.servlet.sat

Class SatTrends

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.base.servlet.BaseServlet

com.dpslink.flash.servlet.FlashServlet

com.dpslink.flash.servlet.MainServlet

com.dpslink.flash.servlet.sat.SatTrends

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SatTrends
extends MainServlet

Writes and processes the site activity trends page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SatTrends.Context Inner class used to store servlet context information.
class	SatTrends.Result Inner class that defines a summary result record.

Nested classes/interfaces inherited from class com.dpslink.flash.servlet.FlashServlet

FlashServlet.Stack

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.flash.servlet.MainServlet

DISPLAY_MODE, SN_ADMINMODE, SN_CATEGORIES, SN_CATEGORIES_LISTONLY, SN_CATEGORIES_PATH, SN_CATEGORY, SN_CONTINUE_PAGEURL, SN_PRODUCTS, SN_PRODUCTS_INSTOCK, SN_PRODUCTS_NOSTOCK, SN_PRODUCTS_PAFILTERS, SN_PRODUCTS_PAGEHIST, SN_PRODUCTS_PAGENUM, SN_PRODUCTS_PAGEURL, SOURCE_CATALOG, SOURCE_FAVORITES, SOURCE_SEARCH, SOURCE_SHOPCART, SOURCE_SPECIAL

Fields inherited from class com.dpslink.flash.servlet.FlashServlet

SN_CART, SN_LOGON_STATUS, SN_SECPROFILE, SN_USER, SN_USERSFI

Fields inherited from class com.dpslink.base.servlet.BaseServlet

BROWSER_IE, BROWSER_NN, BROWSER_XX, RESP_NULL, RESP_REDIRECTED, RQST_AJAX, RQST_NULL

Constructor Summary

Constructors

Constructor and Description
SatTrends()

Method Summary

Modifier and Type	Method and Description
protected MainServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected boolean	editFormFields(BaseServlet.Context baseCtx) Edits the values from the html template's form fields.
private java.lang.String	formatPeriod(SatTrends.Context ctx, int trend, java.text.Format fmt, long year, long interval) Returns a trend's formatted string representation for the given time period.
protected java.lang.String	getNextURL(BaseServlet.Context baseCtx) Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.).
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
private void	getTrendAverages(SatTrends.Context ctx, int activity, long[][] totals) Computes trend averages for the activity types that represent averaged values.
private java.text.Format	getTrendFormatter(SatTrends.Context ctx, int trend) Returns the formatter used to create a string representation of the given trend's time periods.
private void	getTrendPercents(SatTrends.Context ctx, long[][] totals) Computes trend percentage-of-total for graphing purposes.
private long[][]	getTrendResults(SatTrends.Context ctx, int activity, int trend) Retrieves and returns the activity trend results for the entered criteria.
private void	getTrendTotals(SatTrends.Context ctx, long[][] totals) Computes totals for each of the trend's time periods.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
protected void	resetFormFields(BaseServlet.Context baseCtx) Resets the values for the html template's form fields.
protected void	setCookieValues(BaseServlet.Context baseCtx) Adds one or more values to the http session cookies.
protected void	setSessionValues(BaseServlet.Context baseCtx) Adds one or more values to the http session object.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
private void	setTemplateTrendInfo(SatTrends.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the trend data required by the html template.

Methods inherited from class com.dpslink.flash.servlet.MainServlet

confirmSession, getPreviousCategoryList, getPreviousCategoryPath, hasSubcategories, hasSubcategories, isOmitNoStock, isPreshopRequest, isUserHelpRequest, setTemplateCategoryPath, sortCategoryProductData, writePageImpl

Methods inherited from class com.dpslink.flash.servlet.FlashServlet

confirmCart, confirmRequest, confirmRetail, confirmWholesale, createNewCart, createNewSessionImpl, getPageTitle, getServletPath, getUser, initTemplateDataImpl, isLogonRequest, requestComplete, requiresLogon, resetCart, resetCategories, resetProducts, setDefaultUser, setSessionCart, setSFIShoppingUser, useExistingSessionImpl, writeCookie

Methods inherited from class com.dpslink.base.servlet.BaseServlet

createNewSession, determineBrowser, doGet, doPost, getCookie, getInvokerName, getInvokerName, getInvokerParams, getInvokerParams, getInvokerPath, getInvokerPath, getInvokerURL, getPageParams, getRequestURL, getServletName, getServletName, getServletParams, getServletParams, getServletPath, getServletURL, getServletURL, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, initTemplateData, isPrintable, isServerTomcat, log, qualifyURL, redirectURL, setP3PCompactPolicy, showSiteError, showSiteError, showSiteError, useExistingSession, writeCookie, writeTempCookie

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

SatTrends

public SatTrends()

Method Detail

editFormFields

protected boolean editFormFields(BaseServlet.Context baseCtx)

Edits the values from the html template's form fields. Invoked by the doPost method. Overrides editFormFields in BaseServlet.

Specified by:

editFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if all the edits are successful, otherwise false.

getNextURL

protected java.lang.String getNextURL(BaseServlet.Context baseCtx)

Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.). Invoked by the writeURL method. Overrides getNextURL in BaseServlet.

Specified by:

getNextURL in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The URL.

getTemplateName

protected java.lang.String getTemplateName(BaseServlet.Context baseCtx)

Returns the name of the html template file used by the servlet. Invoked by the writePage method. Overrides getTemplateName in BaseServlet.

Specified by:

getTemplateName in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The html template's name.

readParameters

protected void readParameters(BaseServlet.Context baseCtx,
                              boolean post)

Reads the parameters passed to the servlet via the http request object. Invoked by the doGet and doPost method. Overrides readParameters in BaseServlet.

Specified by:

readParameters in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

post - (boolean) true if the method is invoked from doPost, otherwise false.

resetFormFields

protected void resetFormFields(BaseServlet.Context baseCtx)

Resets the values for the html template's form fields. Invoked by the doGet and doPost methods. Overrides resetFormFields in BaseServlet.

Specified by:

resetFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setCookieValues

protected void setCookieValues(BaseServlet.Context baseCtx)
                        throws java.io.IOException

Adds one or more values to the http session cookies. Invoked by the writeURL method. Calls should be made to writeCookie for each cookie that needs to be set. Overrides setCookieValues in BaseServlet.

Specified by:

setCookieValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

setSessionValues

protected void setSessionValues(BaseServlet.Context baseCtx)

Adds one or more values to the http session object. Invoked by the writeURL method. Overrides setSessionValues in BaseServlet.

Specified by:

setSessionValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateData

protected void setTemplateData(BaseServlet.Context baseCtx)

Sets the various data required by the html template. Invoked by the writePage method. Overrides setTemplateData in BaseServlet.

Specified by:

setTemplateData in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateTrendInfo

private void setTemplateTrendInfo(SatTrends.Context ctx)
                           throws java.lang.Exception

Invoked by this class' implementation of setTemplateData to retrieve and set the trend data required by the html template.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.lang.Exception - - if an error occurs while setting the template's results info.

getTrendResults

private long[][] getTrendResults(SatTrends.Context ctx,
                                 int activity,
                                 int trend)
                          throws java.lang.Exception

Retrieves and returns the activity trend results for the entered criteria.

Parameters:

ctx - (Context) The current servlet context.

activity - (int) The entered activity type.

trend - (int) The entered trend type.

Returns:

long[][] - A 2D array (rows and columns) of the computed trend results by time period.

Throws:

java.lang.Exception - - if an error occurs while retrieving the activity trend results.

getTrendTotals

private void getTrendTotals(SatTrends.Context ctx,
                            long[][] totals)
                     throws java.lang.Exception

Computes totals for each of the trend's time periods.

Parameters:

ctx - (Context) The current servlet context.

totals - (long[][]) A 2D array (rows and columns) of the retrieved trend totals. array of totals.

Throws:

java.lang.Exception - - if an error occurs while computing the trend time period totals.

getTrendAverages

private void getTrendAverages(SatTrends.Context ctx,
                              int activity,
                              long[][] totals)
                       throws java.lang.Exception

Computes trend averages for the activity types that represent averaged values.

Parameters:

ctx - (Context) The current servlet context.

activity - (int) The entered activity type.

totals - (long[][]) A 2D array (rows and columns) of the retrieved trend totals. array of totals.

Throws:

java.lang.Exception - - if an error occurs while averaging the activity trend totals.

getTrendPercents

private void getTrendPercents(SatTrends.Context ctx,
                              long[][] totals)
                       throws java.lang.Exception

Computes trend percentage-of-total for graphing purposes. The resulting percentages determine the length of each value's respective graph bar.

Parameters:

ctx - (Context) The current servlet context.

totals - (long[][]) A 2D array (rows and columns) of the retrieved trend totals. 2D array of totals.

Throws:

java.lang.Exception - - if an error occurs while computing the activity trend percentages.

getTrendFormatter

private java.text.Format getTrendFormatter(SatTrends.Context ctx,
                                           int trend)
                                    throws java.lang.Exception

Returns the formatter used to create a string representation of the given trend's time periods.

Parameters:

ctx - (Context) The current servlet context.

trend - (int) The entered trend type.

Returns:

Format - A date or number format object for formatting the given trend's time period values.

Throws:

java.lang.Exception - - if an error occurs while creating the trend's formatter.

formatPeriod

private java.lang.String formatPeriod(SatTrends.Context ctx,
                                      int trend,
                                      java.text.Format fmt,
                                      long year,
                                      long interval)
                               throws java.lang.Exception

Returns a trend's formatted string representation for the given time period.

Parameters:

ctx - (Context) The current servlet context.

trend - (int) The entered trend type.

fmt - (Format) The date or number formatter for creating each time period's string representation.

year - (long) The time period's year. Will be zero (0) when year does not apply.

interval - (long) The time period's interval, such as date, day of week number, hour of day number, week number, etc.

Returns:

String - A string representation of the given time period, formatted according to the trend's format style.

Throws:

java.lang.Exception - - if an error occurs while formatting the trend's time period.

createContext

protected MainServlet.Context createContext(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)

Creates the servlet context inner class. Overrides createContext in MainServlet. Invoked by doPost and doGet methods.

Overrides:

createContext in class MainServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Returns:

Context - The servlet context.