com.dpslink.flash.servlet

Class ProductSearch

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

All Implemented Interfaces:

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

public class ProductSearch
extends MainServlet

Writes and processes the store's product search page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ProductSearch.Context Inner class used to store servlet context information.
class	ProductSearch.SelectableAttribute Inner class used to define a selectable attribute.

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.
protected static java.lang.String	SN_PSSEARCH_ATTR The session's key for the product search's current search attributes.
protected static java.lang.String	SN_PSSEARCH_WORD The session's key for the product search's current search word.

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

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.
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.).
static java.util.ArrayList<ProductSearch.SelectableAttribute>	getSearchAttributes(FlashServletContext ctx) Returns the set of selectable attributes that were used to generate the current search results.
static ProductSearchInterface	getSearchInterface(FlashServletContext ctx) Returns an instance of the configured product search interface per the "Product.Search.class" property value.
static java.lang.String	getSearchWord(FlashServletContext ctx) Returns the search word that was used to generate the current search results.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
static boolean	isSearch3Interface(FlashServletContext ctx) Answers if the configured product search interface is an instance of or a subclasss of product search 3.
static boolean	isSearchRealtimeInfoSet(FlashServletContext ctx) Answers if realtime pricing and availablity was retrieved for the current list of products when the search was performed.
static boolean	isShowAttributes(FlashServletContext ctx) Answers if product attributes are configured to be shown on the search page per the ProductSearch.Show.Attributes properties value.
protected void	limitSearchResults(ProductSearch.Context ctx) Limits the size of the search results to the configured maximum allowed and if necessary also retrieves products with stock.
protected void	logSearchRequest(ProductSearch.Context ctx, java.util.ArrayList<java.lang.String[]> searchAttrs) Logs the search request to the database.
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	setTemplateAttributes(ProductSearch.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the product data required by the html template.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
protected boolean	setTemplateError(ProductSearch.Context ctx, java.lang.String errName) Sets the html template error fields for the given error name.

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

SN_PSSEARCH_WORD

protected static final java.lang.String SN_PSSEARCH_WORD

The session's key for the product search's current search word.

See Also:

Constant Field Values

SN_PSSEARCH_ATTR

protected static final java.lang.String SN_PSSEARCH_ATTR

The session's key for the product search's current search attributes.

See Also:

Constant Field Values

Constructor Detail

ProductSearch

public ProductSearch()

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.

setTemplateAttributes

protected void setTemplateAttributes(ProductSearch.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.

setTemplateError

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

limitSearchResults

protected void limitSearchResults(ProductSearch.Context ctx)

Limits the size of the search results to the configured maximum allowed and if necessary also retrieves products with stock.

Parameters:

ctx - (Context) The current servlet context.

logSearchRequest

protected void logSearchRequest(ProductSearch.Context ctx,
                                java.util.ArrayList<java.lang.String[]> searchAttrs)

Logs the search request to the database.

Parameters:

ctx - (Context) The current servlet context.

getSearchAttributes

public static java.util.ArrayList<ProductSearch.SelectableAttribute> getSearchAttributes(FlashServletContext ctx)

Returns the set of selectable attributes that were used to generate the current search results.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

ArrayList - The current set of selectable attributes.

getSearchWord

public static java.lang.String getSearchWord(FlashServletContext ctx)

Returns the search word that was used to generate the current search results.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

String - The current search word.

getSearchInterface

public static ProductSearchInterface getSearchInterface(FlashServletContext ctx)
                                                 throws java.lang.Exception

Returns an instance of the configured product search interface per the "Product.Search.class" property value.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

ProductSearchInterface - The configured search interface.

Throws:

java.lang.Exception - - if an error occurs while obtaining the interface instance.

isSearch3Interface

public static boolean isSearch3Interface(FlashServletContext ctx)

Answers if the configured product search interface is an instance of or a subclasss of product search 3.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

boolean - true if product search 3, otherwise false.

isSearchRealtimeInfoSet

public static boolean isSearchRealtimeInfoSet(FlashServletContext ctx)

Answers if realtime pricing and availablity was retrieved for the current list of products when the search was performed.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

boolean - true if realtime info had been retrieved, otherwise false.

isShowAttributes

public static boolean isShowAttributes(FlashServletContext ctx)

Answers if product attributes are configured to be shown on the search page per the ProductSearch.Show.Attributes properties value.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

boolean - true if attributes are to be shown, otherwise false.

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.