com.dpslink.flash.servlet.admin

Class AdmViewDatabaseInfo

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.admin.AdmViewDatabaseInfo

All Implemented Interfaces:

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

public class AdmViewDatabaseInfo
extends MainServlet

Writes and processes the admin view database information page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdmViewDatabaseInfo.Context Inner class used to store servlet context information.
class	AdmViewDatabaseInfo.Row Inner class used to define a row of displayed 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
AdmViewDatabaseInfo()

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	getColumnDefault(java.lang.String datatype, java.lang.String nullable) Returns the dbinfo.properties column default value for the given data type and nullable attribute.
private java.lang.String	getColumnDescription(java.lang.String tblname, java.lang.String colname) Returns the dbinfo.properties column description for the given table and column.
private java.lang.String	getMethodDescription(java.lang.String method) Returns the dbinfo.properties features method description for the given method name.
private java.lang.String	getMethodReturnValue(java.lang.String value) Returns a revised features method return value.
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.).
private java.lang.String	getSQLTypeName(AdmViewDatabaseInfo.Context ctx, java.lang.Object typenum) Returns the text description for the given sql type number.
private java.lang.String	getTableDescription(java.lang.String tblname) Returns the dbinfo.properties table description for the given table.
private void	getTableOrViewInfo(java.sql.ResultSet rs, java.util.TreeMap<java.lang.String,AdmViewDatabaseInfo.Row> sorted) Reads the given result set of table or view data and adds it to the given tree map of sorted information.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
private java.lang.String	getYesNoDescription(java.lang.String type, java.lang.String code) Returns the dbinfo.properties yes/no description for the given type and code.
protected boolean	isPreshopRequest(MainServlet.Context ctx) Answers if a request has been made that uses the preshop layout (no banner links, no navigation bar options and no displayed categories).
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	setTemplateFeaturesInfo(AdmViewDatabaseInfo.Context ctx) Sets the template data for supported features information.
private void	setTemplateSQLTypesInfo(AdmViewDatabaseInfo.Context ctx) Sets the template data for supported SQL types information.
private void	setTemplateTableColInfo(AdmViewDatabaseInfo.Context ctx) Sets the template data for table column information.
private void	setTemplateTableColSels(AdmViewDatabaseInfo.Context ctx) Sets the template data for table column information selections.
private void	setTemplateTableIdxInfo(AdmViewDatabaseInfo.Context ctx) Sets the template data for table index information.
private void	setTemplateTableSumInfo(AdmViewDatabaseInfo.Context ctx) Sets the template data for table summary information.

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

confirmSession, getPreviousCategoryList, getPreviousCategoryPath, hasSubcategories, hasSubcategories, isOmitNoStock, 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

AdmViewDatabaseInfo

public AdmViewDatabaseInfo()

Method Detail

isPreshopRequest

protected boolean isPreshopRequest(MainServlet.Context ctx)

Answers if a request has been made that uses the preshop layout (no banner links, no navigation bar options and no displayed categories). The default is false. This method should be overridden by a subclass if the subclass requires something different than the default. Overrides isPreshopRequest in MainServlet.

Overrides:

isPreshopRequest in class MainServlet

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if this is a request for preshop, 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.

setTemplateFeaturesInfo

private void setTemplateFeaturesInfo(AdmViewDatabaseInfo.Context ctx)
                              throws java.lang.Exception

Sets the template data for supported features information.

Parameters:

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

Throws:

java.lang.Exception - - if an error occurs while generating the template data.

setTemplateSQLTypesInfo

private void setTemplateSQLTypesInfo(AdmViewDatabaseInfo.Context ctx)
                              throws java.lang.Exception

Sets the template data for supported SQL types information.

Parameters:

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

Throws:

java.lang.Exception - - if an error occurs while generating the template data.

setTemplateTableColInfo

private void setTemplateTableColInfo(AdmViewDatabaseInfo.Context ctx)
                              throws java.lang.Exception

Sets the template data for table column information.

Parameters:

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

Throws:

java.lang.Exception - - if an error occurs while generating the template data.

setTemplateTableColSels

private void setTemplateTableColSels(AdmViewDatabaseInfo.Context ctx)
                              throws java.lang.Exception

Sets the template data for table column information selections.

Parameters:

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

Throws:

java.lang.Exception - - if an error occurs while generating the template data.

setTemplateTableIdxInfo

private void setTemplateTableIdxInfo(AdmViewDatabaseInfo.Context ctx)
                              throws java.lang.Exception

Sets the template data for table index information.

Parameters:

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

Throws:

java.lang.Exception - - if an error occurs while generating the template data.

setTemplateTableSumInfo

private void setTemplateTableSumInfo(AdmViewDatabaseInfo.Context ctx)
                              throws java.lang.Exception

Sets the template data for table summary information.

Parameters:

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

Throws:

java.lang.Exception - - if an error occurs while generating the template data.

getColumnDefault

private java.lang.String getColumnDefault(java.lang.String datatype,
                                          java.lang.String nullable)

Returns the dbinfo.properties column default value for the given data type and nullable attribute.

Parameters:

datatype - (String) An SQL data type description.

nullable - (String) An "is_nullable" value ("yes" or "no").

Returns:

String - The column default value from dbinfo.properties.

getColumnDescription

private java.lang.String getColumnDescription(java.lang.String tblname,
                                              java.lang.String colname)

Returns the dbinfo.properties column description for the given table and column.

Parameters:

tblname - (String) The name of a table.

colname - (String) The name of a column in the given table.

Returns:

String - The column description from dbinfo.properties.

getMethodDescription

private java.lang.String getMethodDescription(java.lang.String method)

Returns the dbinfo.properties features method description for the given method name.

Parameters:

method - (String) The name of a method.

Returns:

String - The method description from dbinfo.properties.

getMethodReturnValue

private java.lang.String getMethodReturnValue(java.lang.String value)

Returns a revised features method return value. Some method return values consist of a lengthy comma delimited string that does not include any embedded spaces. This causes the displayed web page to have a large horizontal width because the browser can't do word wrapping on the string. This method inserts a space after every comma so word wrapping can occur.

Parameters:

value - (String) A method return value.

Returns:

String - The revised value.

getSQLTypeName

private java.lang.String getSQLTypeName(AdmViewDatabaseInfo.Context ctx,
                                        java.lang.Object typenum)
                                 throws java.lang.Exception

Returns the text description for the given sql type number. The returned description is the field name for the specified number's corresponding constant in java.sql.Types.

Parameters:

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

typenum - (Object) The number for the desired type description.

Returns:

String - The type description for the specified number.

Throws:

java.lang.Exception - - if an error occurs while determining the type description.

getTableDescription

private java.lang.String getTableDescription(java.lang.String tblname)

Returns the dbinfo.properties table description for the given table.

Parameters:

tblname - (String) The name of a table.

Returns:

String - The table description from dbinfo.properties.

getTableOrViewInfo

private void getTableOrViewInfo(java.sql.ResultSet rs,
                                java.util.TreeMap<java.lang.String,AdmViewDatabaseInfo.Row> sorted)
                         throws java.lang.Exception

Reads the given result set of table or view data and adds it to the given tree map of sorted information.

Parameters:

rs - (ResultSet) A result set of table or view data.

sorted - (TreeMap) The tree map to add the information to.

Throws:

java.lang.Exception - - if an error occurs while processing the result set.

getYesNoDescription

private java.lang.String getYesNoDescription(java.lang.String type,
                                             java.lang.String code)

Returns the dbinfo.properties yes/no description for the given type and code. Valid types are "Common", "Search" and "Unique". Codes are usually a single character value ranging from 0 through 3.

Parameters:

type - (String) The type of description to retrieve.

code - (String) The code for the description to retrieve.

Returns:

String - The yes/no description from dbinfo.properties.

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.