com.dpslink.flash.servlet

Class Products

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

com.dpslink.flash.servlet.Home

com.dpslink.flash.servlet.Products

All Implemented Interfaces:

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

Direct Known Subclasses:

ProductSearchResults, ProductSpecial

public class Products
extends Home

Writes and processes the store's product grid and list pages.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Products.Context Inner class used to store servlet context information.
class	Products.SelectableFilter Inner class used to define a selectable product attribute filter.

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.
static java.lang.String	SN_COMPARE_LIST The session's key for the list of products to compare.
protected static java.lang.String	SN_PRODUCTS_ATTFILTERS The session's key for the catalog's current list of selected attribute filters.
protected static java.lang.String	SN_PRODUCTS_INFILTERS The session's key for the catalog's current list of filtered products.
protected static java.lang.String	SN_PRODUCTS_PAGESTYLE The session's key for the catalog's current page number.
protected static java.lang.String	SN_PRODUCTS_PRCFILTERS The session's key for the catalog's current entered price filters.
protected static java.lang.String	SN_PRODUCTS_SELNOSTOCK The session's key for the catalog's current omit no stock flag.

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

MINIMUM_ROWS

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

Method Summary

Modifier and Type	Method and Description
protected boolean	addToCompares(Products.Context ctx, java.util.ArrayList<Product> products) Adds the given collection of products to the collection of products to compare.
protected Home.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.
protected boolean	getCompareProducts(Products.Context ctx, java.util.ArrayList<Product> products) Retrieves products that the user selected for comparison and places them into the given collection for products.
protected boolean	getManyProducts(Products.Context ctx, java.util.ArrayList<Product> products, java.util.ArrayList<java.lang.Integer> quantities) Retrieves the "Add To Cart" or "Add To Favorites" products and quantities and places the values into the given collections for products and quantities.
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 boolean	getOneProduct(Products.Context ctx, java.util.ArrayList<Product> products, java.util.ArrayList<java.lang.Integer> quantities) Retrieves the "Buy Now" product and quantity and places the values into the given collections for products and quantities.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
protected boolean	isPrintable(BaseServlet.Context baseCtx) Answers if the servlet allows for a printable version to be displayed.
protected boolean	isProductFilteringActive(Products.Context ctx) Answers if product filtering of attributes or pricing is active based on isProductFilteringAttrsActive and isProductFilteringPriceActive.
protected boolean	isProductFilteringAttrsActive(Products.Context ctx) Answers if product filtering of attributes is active based on properties (ProductSearch.Show.Attributes)and the current page source code (catalog, search, special, etc.).
protected boolean	isProductFilteringPriceActive(Products.Context ctx) Answers if product filtering of pricing is active based on shopping user security profile (getShowNoPrices) and the current page source code (catalog, search, special, etc.).
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	setProductList(Products.Context ctx) Sets the current list of products based on the current omit no stock flag.
protected void	setProductList(Products.Context ctx, java.lang.String snProdKey, java.lang.String snStockKey, java.lang.String snAttrKey, boolean realtime) Sets the current list of products based on the current omit no stock flag.
protected void	setProductListFiltered(Products.Context ctx, java.lang.String snAttrKey) Sets the current list of products based on the current selected and entered filters.
protected void	setProductListFilteredAttrs(Products.Context ctx, java.util.ArrayList<java.lang.String[]> searchattrs) Sets the current list of products based on the current set of selected attribute filters.
protected void	setProductListFilteredPrice(Products.Context ctx, java.lang.String[] prcfilters) Sets the current list of products based on the current entered price filters.
protected void	setRealtimeInfo(Products.Context ctx, int begindex, int endindex) Sets the realtime data for a given set of products within the current list of products.
protected void	setRealtimeInfo(Products.Context ctx, int begindex, int endindex, java.lang.String snPgHstKey) Sets the realtime data for a given set of products within the current list of products.
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(Products.Context ctx, java.lang.String errName) Sets the html template error fields for the given error name.
protected void	setTemplateFavorites(Products.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the favorites data required by the html template.
protected void	setTemplateFilters(Products.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the selectable attribute filters and entered price filters data required by the html template.
protected void	setTemplateHeader(Products.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the page header data required by the html template.
protected void	setTemplateListName(Products.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the list name data required by the html template.
protected void	setTemplateProducts(Products.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the product data required by the html template.
protected void	setTemplateRelatedProducts(Products.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the related products data required by the html template.
protected void	setTemplateSubcategories(Products.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the subcategory data required by the html template.

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

setTemplateMode0, setTemplateMode1, setTemplateMode2, setTemplateSubcategories

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

setTemplatePagingBegIndex, setTemplatePagingEndIndex, setTemplatePagingLinks

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

SN_COMPARE_LIST

public static final java.lang.String SN_COMPARE_LIST

The session's key for the list of products to compare.

See Also:

Constant Field Values

SN_PRODUCTS_INFILTERS

protected static final java.lang.String SN_PRODUCTS_INFILTERS

The session's key for the catalog's current list of filtered products.

See Also:

Constant Field Values

SN_PRODUCTS_PAGESTYLE

protected static final java.lang.String SN_PRODUCTS_PAGESTYLE

The session's key for the catalog's current page number.

See Also:

Constant Field Values

SN_PRODUCTS_ATTFILTERS

protected static final java.lang.String SN_PRODUCTS_ATTFILTERS

The session's key for the catalog's current list of selected attribute filters.

See Also:

Constant Field Values

SN_PRODUCTS_PRCFILTERS

protected static final java.lang.String SN_PRODUCTS_PRCFILTERS

The session's key for the catalog's current entered price filters.

See Also:

Constant Field Values

SN_PRODUCTS_SELNOSTOCK

protected static final java.lang.String SN_PRODUCTS_SELNOSTOCK

The session's key for the catalog's current omit no stock flag.

See Also:

Constant Field Values

Constructor Detail

Products

public Products()

Method Detail

isPrintable

protected boolean isPrintable(BaseServlet.Context baseCtx)

Answers if the servlet allows for a printable version to be displayed. Overrides isPrintable in BaseServlet.

Overrides:

isPrintable in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if the servlet allows a printable version to be displayed.

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.

Overrides:

editFormFields in class Home

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.

Overrides:

getNextURL in class Home

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.

Overrides:

getTemplateName in class Home

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.

Overrides:

readParameters in class Home

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.

Overrides:

resetFormFields in class Home

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.

Overrides:

setCookieValues in class Home

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.

Overrides:

setSessionValues in class Home

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.

Overrides:

setTemplateData in class Home

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateError

protected boolean setTemplateError(Products.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.

setTemplateHeader

protected void setTemplateHeader(Products.Context ctx)

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

Parameters:

ctx - (Context) The current servlet context.

setTemplateListName

protected void setTemplateListName(Products.Context ctx)

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

Parameters:

ctx - (Context) The current servlet context.

setTemplateProducts

protected void setTemplateProducts(Products.Context ctx)

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

Parameters:

ctx - (Context) The current servlet context.

setTemplateFavorites

protected void setTemplateFavorites(Products.Context ctx)

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

Parameters:

ctx - (Context) The current servlet context.

setTemplateFilters

protected void setTemplateFilters(Products.Context ctx)

Invoked by this class' implementation of setTemplateData to retrieve and set the selectable attribute filters and entered price filters data required by the html template.

Parameters:

ctx - (Context) The current servlet context.

setTemplateRelatedProducts

protected void setTemplateRelatedProducts(Products.Context ctx)

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

Parameters:

ctx - (Context) The servlet's current context.

setTemplateSubcategories

protected void setTemplateSubcategories(Products.Context ctx)

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

Parameters:

ctx - (Context) The current servlet context.

addToCompares

protected boolean addToCompares(Products.Context ctx,
                                java.util.ArrayList<Product> products)

Adds the given collection of products to the collection of products to compare.

Parameters:

ctx - (Context) The current servlet context.

products - (ArrayList) The collection of products to add.

Returns:

boolean - true if the products are successfully added, otherwise false.

getCompareProducts

protected boolean getCompareProducts(Products.Context ctx,
                                     java.util.ArrayList<Product> products)

Retrieves products that the user selected for comparison and places them into the given collection for products.

Parameters:

ctx - (Context) The current servlet context.

products - (ArrayList) The collection of products to add to.

Returns:

boolean - true if the products are successfully retrieved, otherwise false.

getOneProduct

protected boolean getOneProduct(Products.Context ctx,
                                java.util.ArrayList<Product> products,
                                java.util.ArrayList<java.lang.Integer> quantities)

Retrieves the "Buy Now" product and quantity and places the values into the given collections for products and quantities.

Parameters:

ctx - (Context) The current servlet context.

products - (ArrayList) The collection of products to add to.

quantities - (ArrayList) The collection of quantities to add to.

Returns:

boolean - true if the product and quantity are successfully retrieved, otherwise false.

getManyProducts

protected boolean getManyProducts(Products.Context ctx,
                                  java.util.ArrayList<Product> products,
                                  java.util.ArrayList<java.lang.Integer> quantities)

Retrieves the "Add To Cart" or "Add To Favorites" products and quantities and places the values into the given collections for products and quantities.

Parameters:

ctx - (Context) The current servlet context.

products - (ArrayList) The collection of products to add to.

quantities - (ArrayList) The collection of quantities to add to.

Returns:

boolean - true if the products and quantities are successfully retrieved, otherwise false.

isProductFilteringActive

protected boolean isProductFilteringActive(Products.Context ctx)

Answers if product filtering of attributes or pricing is active based on isProductFilteringAttrsActive and isProductFilteringPriceActive.

Parameters:

ctx - (Context) The current servlet context.

isProductFilteringAttrsActive

protected boolean isProductFilteringAttrsActive(Products.Context ctx)

Answers if product filtering of attributes is active based on properties (ProductSearch.Show.Attributes)and the current page source code (catalog, search, special, etc.).

Parameters:

ctx - (Context) The current servlet context.

isProductFilteringPriceActive

protected boolean isProductFilteringPriceActive(Products.Context ctx)

Answers if product filtering of pricing is active based on shopping user security profile (getShowNoPrices) and the current page source code (catalog, search, special, etc.).

Parameters:

ctx - (Context) The current servlet context.

setProductList

protected void setProductList(Products.Context ctx)

Sets the current list of products based on the current omit no stock flag. The result is placed in the ctx.products context variable.

Parameters:

ctx - (Context) The current servlet context.

setProductList

protected void setProductList(Products.Context ctx,
                              java.lang.String snProdKey,
                              java.lang.String snStockKey,
                              java.lang.String snAttrKey,
                              boolean realtime)

Sets the current list of products based on the current omit no stock flag. The result is placed in the ctx.products context variable.

Parameters:

ctx - (Context) The current servlet context.

snProdKey - (String) The session key for the current list of products.

snStockKey - (String) The session key for the current list of products with stock.

snAttrKey - (String) The session key for the current list of product attribute filters.

realtime - (boolean) true if realtime info should be retrieved to obtain the list of products with stock, otherwise false.

setProductListFiltered

protected void setProductListFiltered(Products.Context ctx,
                                      java.lang.String snAttrKey)

Sets the current list of products based on the current selected and entered filters. The result is placed in the ctx.products context variable.

Parameters:

ctx - (Context) The current servlet context.

snAttrKey - (String) The session key for the current list of product attribute filters.

setProductListFilteredAttrs

protected void setProductListFilteredAttrs(Products.Context ctx,
                                           java.util.ArrayList<java.lang.String[]> searchattrs)

Sets the current list of products based on the current set of selected attribute filters. The result is placed in the ctx.products context variable.

Parameters:

ctx - (Context) The current servlet context.

searchattrs - (ArrayList) The collection of search attributes that will be sent to the configured product search interface. product attribute filters.

setProductListFilteredPrice

protected void setProductListFilteredPrice(Products.Context ctx,
                                           java.lang.String[] prcfilters)

Sets the current list of products based on the current entered price filters. The result is placed in the ctx.products context variable.

Parameters:

ctx - (Context) The current servlet context.

prcfilters - (String[]) The current price filters where the 1st element is low price and the 2nd element is high price.

setRealtimeInfo

protected void setRealtimeInfo(Products.Context ctx,
                               int begindex,
                               int endindex)

Sets the realtime data for a given set of products within the current list of products. Tracks what pages have already been displayed and only makes requests for realtime data if page has not already been displayed.

Parameters:

ctx - (Context) The current servlet context.

begindex - (int) The index of the first product within the list for which realtime data is desired.

endindex - (int) The index of the last product within the list for which realtime data is desired.

setRealtimeInfo

protected void setRealtimeInfo(Products.Context ctx,
                               int begindex,
                               int endindex,
                               java.lang.String snPgHstKey)

Sets the realtime data for a given set of products within the current list of products. Tracks what pages have already been displayed and only makes requests for realtime data if page has not already been displayed.

Parameters:

ctx - (Context) The current servlet context.

begindex - (int) The index of the first product within the list for which realtime data is desired.

endindex - (int) The index of the last product within the list for which realtime data is desired.

snPgHstKey - (String) The session key for the current page history.

createContext

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

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

Overrides:

createContext in class Home

Parameters:

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

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

Returns:

Context - The servlet context.