com.dpslink.flash.servlet

Class OrderToExcel

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.OrderToExcel

All Implemented Interfaces:

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

public class OrderToExcel
extends MainServlet

Writes and processes the store's order history create and download Excel spreadsheet page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	OrderToExcel.Context Inner class used to store servlet context information.

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
OrderToExcel()

Method Summary

Modifier and Type	Method and Description
private java.util.Date	convertDate(java.lang.String date) Returns a date object for a date string.
private java.lang.String	convertItemName(java.lang.String name) Returns a revised copy of an item's description.
private double	convertNumber(java.lang.String number) Returns a double for a number string.
protected MainServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
private void	createNewSheet(OrderToExcel.Context ctx) Creates a new sheet within the current spreadsheet and sets the new sheet's column headers.
protected boolean	doMultipleOrders(OrderToExcel.Context ctx, java.util.ArrayList<Order> orders) Handles Excel spreadsheet creation for multiple orders.
protected boolean	doSingleOrder(OrderToExcel.Context ctx, Order order) Handles Excel spreadsheet creation for a single order.
private boolean	doSingleOrderDetail(OrderToExcel.Context ctx, Order order, java.util.ArrayList<OrderDetail> lineitems) Handles Excel spreadsheet creation for a single order's detail.
private boolean	doSingleOrderHeader(OrderToExcel.Context ctx, Order order) Handles Excel spreadsheet creation for a single order's header.
protected boolean	editFormFields(BaseServlet.Context baseCtx) Edits the values from the html template's form fields.
private java.lang.String	getCustomerName(OrderToExcel.Context ctx, java.lang.String custid) Retrieves and returns a customer's name.
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.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
protected boolean	requiresLogon(BaseServlet.Context baseCtx) Answers if the servlet requires a valid non-default user to log on in order to continue processing.
protected void	resetFormFields(BaseServlet.Context baseCtx) Resets the values for the html template's form fields.
private void	setColumnValue(OrderToExcel.Context ctx, int colidx, java.util.Date value) Sets a spreadsheet column's value to a date.
private void	setColumnValue(OrderToExcel.Context ctx, int colidx, double value) Sets a spreadsheet column's value to a double.
private void	setColumnValue(OrderToExcel.Context ctx, int colidx, java.lang.String value) Sets a spreadsheet column's value to a string.
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.
protected boolean	setTemplateError(OrderToExcel.Context ctx, java.lang.String errName) Sets the html template error fields for the given error name.
private void	setTemplateSelections(OrderToExcel.Context ctx) Sets the html template selected column field names.

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, 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

OrderToExcel

public OrderToExcel()

Method Detail

requiresLogon

protected boolean requiresLogon(BaseServlet.Context baseCtx)

Answers if the servlet requires a valid non-default user to log on in order to continue processing. The default is false for public shopping functions and true for admin, SAT and SFI/CSR functions. This method should be overridden by a subclass if the subclass requires something different than the default. Overrides requiresLogon in FlashServlet.

Overrides:

requiresLogon in class FlashServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if the servlet requires a non-default user to log on, otherwise false.

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.

setTemplateError

protected boolean setTemplateError(OrderToExcel.Context ctx,
                                   java.lang.String errName)

Sets the html template error fields for the given error name.

Parameters:

ctx - (Context) The current servlet context..

errName - (String) The name of error that is to be set, used to determine which message (or messages) to retrieve from the message properties.

Returns:

boolean - Always returns false.

setTemplateSelections

private void setTemplateSelections(OrderToExcel.Context ctx)

Sets the html template selected column field names.

Parameters:

ctx - (Context) The current servlet context..

doSingleOrder

protected boolean doSingleOrder(OrderToExcel.Context ctx,
                                Order order)
                         throws java.lang.Exception

Handles Excel spreadsheet creation for a single order.

Parameters:

ctx - (Context) The current servlet context..

order - (Order) The order to process.

Returns:

boolean - true if processing is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during processing.

doSingleOrderDetail

private boolean doSingleOrderDetail(OrderToExcel.Context ctx,
                                    Order order,
                                    java.util.ArrayList<OrderDetail> lineitems)
                             throws java.lang.Exception

Handles Excel spreadsheet creation for a single order's detail.

Parameters:

ctx - (Context) The current servlet context..

order - (Order) The order to process.

lineitems - (ArrayList) The line items to process.

Returns:

boolean - true if processing is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during processing.

doSingleOrderHeader

private boolean doSingleOrderHeader(OrderToExcel.Context ctx,
                                    Order order)
                             throws java.lang.Exception

Handles Excel spreadsheet creation for a single order's header.

Parameters:

ctx - (Context) The current servlet context..

order - (Order) The order to process.

Returns:

boolean - true if processing is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during processing.

doMultipleOrders

protected boolean doMultipleOrders(OrderToExcel.Context ctx,
                                   java.util.ArrayList<Order> orders)
                            throws java.lang.Exception

Handles Excel spreadsheet creation for multiple orders.

Parameters:

ctx - (Context) The current servlet context..

orders - (ArrayList) The orders to process.

Returns:

boolean - true if processing is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during processing.

convertDate

private java.util.Date convertDate(java.lang.String date)

Returns a date object for a date string.

Parameters:

date - (String) The date to convert. The date is assumed to contain slashes with a month, day and year format and either a 2 digit year or a 4 digit year.

Returns:

java.util.Date - The converted date.

convertItemName

private java.lang.String convertItemName(java.lang.String name)

Returns a revised copy of an item's description. Removes html <br> from the given description.

Parameters:

name - (String) The item description to convert.

Returns:

String - The converted description.

convertNumber

private double convertNumber(java.lang.String number)

Returns a double for a number string.

Parameters:

number - (String) The number to convert.

Returns:

double - The converted number.

createNewSheet

private void createNewSheet(OrderToExcel.Context ctx)
                     throws java.lang.Exception

Creates a new sheet within the current spreadsheet and sets the new sheet's column headers.

Parameters:

ctx - (Context) The current servlet context..

Throws:

java.lang.Exception - - if an error occurs during processing.

getCustomerName

private java.lang.String getCustomerName(OrderToExcel.Context ctx,
                                         java.lang.String custid)

Retrieves and returns a customer's name.

Parameters:

ctx - (Context) The current servlet context..

custid - (String) The id of the customer to retrieve.

Returns:

String - The customer's name.

setColumnValue

private void setColumnValue(OrderToExcel.Context ctx,
                            int colidx,
                            java.util.Date value)
                     throws java.lang.Exception

Sets a spreadsheet column's value to a date.

Parameters:

ctx - (Context) The current servlet context..

colidx - (int) The index of the column to set (zero based).

value - (java.util.Date) The value to set.

Throws:

java.lang.Exception - - if an error occurs during processing.

setColumnValue

private void setColumnValue(OrderToExcel.Context ctx,
                            int colidx,
                            double value)
                     throws java.lang.Exception

Sets a spreadsheet column's value to a double.

Parameters:

ctx - (Context) The current servlet context..

colidx - (int) The index of the column to set (zero based).

value - (double) The value to set.

Throws:

java.lang.Exception - - if an error occurs during processing.

setColumnValue

private void setColumnValue(OrderToExcel.Context ctx,
                            int colidx,
                            java.lang.String value)
                     throws java.lang.Exception

Sets a spreadsheet column's value to a string.

Parameters:

ctx - (Context) The current servlet context..

colidx - (int) The index of the column to set (zero based).

value - (String) The value to set.

Throws:

java.lang.Exception - - if an error occurs during processing.

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.