org.scrashmeow.ojb.console.ui.action
Class BrowseAction

java.lang.Object
  |
  +--org.apache.struts.action.Action
        |
        +--org.apache.struts.actions.DispatchAction
              |
              +--org.apache.struts.actions.LookupDispatchAction
                    |
                    +--org.scrashmeow.ojb.console.framework.OjbcLookupDispatchAction
                          |
                          +--org.scrashmeow.ojb.console.ui.action.BrowseAction

All Implemented Interfaces:

ApplicationServiceAware, BrowseActionAware, java.io.Serializable

Direct Known Subclasses:

BrowseCrudAction

public class BrowseAction

extends OjbcLookupDispatchAction

implements BrowseActionAware

Author:

alexander To change this generated comment edit the template variable "typecomment": Window>Preferences>Java>Templates. To enable and disable the creation of type comments go to Window>Preferences>Java>Code Generation.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.struts.actions.LookupDispatchAction

keyMethodMap, localeMap

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, messages, methods, types

Fields inherited from class org.apache.struts.action.Action

ACTION_SERVLET_KEY, APPLICATION_KEY, DATA_SOURCE_KEY, defaultLocale, ERROR_KEY, EXCEPTION_KEY, FORM_BEANS_KEY, FORWARDS_KEY, LOCALE_KEY, MAPPING_KEY, MAPPINGS_KEY, MESSAGE_KEY, MESSAGES_KEY, MULTIPART_KEY, PLUG_INS_KEY, REQUEST_PROCESSOR_KEY, servlet, SERVLET_KEY, TRANSACTION_TOKEN_KEY

Constructor Summary

BrowseAction()

Method Summary

org.apache.struts.action.ActionForward	browse(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) The dispatch method to display the data that the user is browsing.
protected org.apache.ojb.broker.query.Criteria	buildCriteria(BrowseForm myForm, HttpServletRequest request) Method buildCriteria @add-javadoc!!!
protected GridControl	buildGridControl(BrowseForm myForm, HttpServletRequest request) Method buildGridControl @add-javadoc!!!
protected GridControl	createGridControl(SearchGridControlFactory factory, java.util.Iterator rs, int rsSize, int windowSize, int currentWindow) Method createGridControl @add-javadoc!!!
protected SearchGridControlFactory	createSearchGridControlFactory(BrowseForm myForm, HttpServletRequest request, org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.String sortCol, boolean sortAscending) Method createSearchGridControlFactory @add-javadoc!!!
protected org.apache.ojb.broker.metadata.ClassDescriptor	findClassDescriptor(BrowseForm myForm, HttpServletRequest request) Method findClassDescriptor @add-javadoc!!!
protected int	findCurrentWindow(BrowseForm myForm, HttpServletRequest request) Method findCurrentWindow @add-javadoc!!!
protected java.util.Iterator	findResultSet(BrowseForm myForm, HttpServletRequest request, org.apache.ojb.broker.query.Criteria criteria) Method findResultSet @add-javadoc!!!
protected int	findResultSetSize(BrowseForm myForm, HttpServletRequest request, org.apache.ojb.broker.query.Criteria criteria) Method findResultSetSize @add-javadoc!!!
protected java.lang.String	findSortColumn(BrowseForm myForm, HttpServletRequest request) Method findSortColumn @add-javadoc!!!
protected boolean	findSortOrder(BrowseForm myForm, HttpServletRequest request) Method findSortOrder @add-javadoc!!!
protected int	findWindowSize(BrowseForm myForm, HttpServletRequest request) Method findWindowSize @add-javadoc!!!
org.apache.struts.action.ActionForward	getBrowseForward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request) Returns the forward for the browse dispatch
protected java.util.Map	getKeyMethodMap()
org.apache.struts.action.ActionForward	go(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) The dispatch method that is triggered when a user wishes to go to a specific page of data.
protected boolean	hasSortColumn(BrowseForm myForm, HttpServletRequest request) Method hasSortColumn @add-javadoc!!!
org.apache.struts.action.ActionForward	next(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) The dispatch method that is triggered when a user wishes to move to the next page of data.
org.apache.struts.action.ActionForward	previous(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) The dispatch method that is triggered when a user wishes to move to the previous page of data.
org.apache.struts.action.ActionForward	sizeWindow(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) The dispatch method that is triggered when a user needs to change the window/page size of data.
org.apache.struts.action.ActionForward	sort(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) The dispatch method that is triggered when a user wishes to sort the data.
protected org.apache.struts.action.ActionForward	unspecified(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response)

Methods inherited from class org.scrashmeow.ojb.console.framework.OjbcLookupDispatchAction

createBreadcrumbs, execute, findRedirectingForward, getApplicationService, initializeUserSession

Methods inherited from class org.apache.struts.actions.LookupDispatchAction

execute

Methods inherited from class org.apache.struts.actions.DispatchAction

dispatchMethod, getMethod, unspecified

Methods inherited from class org.apache.struts.action.Action

execute, generateToken, getDataSource, getDataSource, getLocale, getResources, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, perform, perform, resetToken, saveErrors, saveMessages, saveToken, setLocale, setServlet, toHex

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowseAction

public BrowseAction()

Method Detail

browse

public org.apache.struts.action.ActionForward browse(org.apache.struts.action.ActionMapping mapping,
                                                     org.apache.struts.action.ActionForm form,
                                                     HttpServletRequest request,
                                                     HttpServletResponse response)
                                              throws java.lang.Exception

Description copied from interface: BrowseActionAware

The dispatch method to display the data that the user is browsing.

Specified by:

browse in interface BrowseActionAware

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

response - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

org.scrashmeow.ojb.console.framework.BrowseActionAware#browse(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse)

go

public org.apache.struts.action.ActionForward go(org.apache.struts.action.ActionMapping mapping,
                                                 org.apache.struts.action.ActionForm form,
                                                 HttpServletRequest request,
                                                 HttpServletResponse response)
                                          throws java.lang.Exception

Description copied from interface: BrowseActionAware

The dispatch method that is triggered when a user wishes to go to a specific page of data.

Specified by:

go in interface BrowseActionAware

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

response - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

org.scrashmeow.ojb.console.framework.BrowseActionAware#go(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse)

next

public org.apache.struts.action.ActionForward next(org.apache.struts.action.ActionMapping mapping,
                                                   org.apache.struts.action.ActionForm form,
                                                   HttpServletRequest request,
                                                   HttpServletResponse response)
                                            throws java.lang.Exception

Description copied from interface: BrowseActionAware

The dispatch method that is triggered when a user wishes to move to the next page of data.

Specified by:

next in interface BrowseActionAware

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

response - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

org.scrashmeow.ojb.console.framework.BrowseActionAware#next(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse)

previous

public org.apache.struts.action.ActionForward previous(org.apache.struts.action.ActionMapping mapping,
                                                       org.apache.struts.action.ActionForm form,
                                                       HttpServletRequest request,
                                                       HttpServletResponse response)
                                                throws java.lang.Exception

Description copied from interface: BrowseActionAware

The dispatch method that is triggered when a user wishes to move to the previous page of data.

Specified by:

previous in interface BrowseActionAware

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

response - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

org.scrashmeow.ojb.console.framework.BrowseActionAware#previous(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse)

sizeWindow

public org.apache.struts.action.ActionForward sizeWindow(org.apache.struts.action.ActionMapping mapping,
                                                         org.apache.struts.action.ActionForm form,
                                                         HttpServletRequest request,
                                                         HttpServletResponse response)
                                                  throws java.lang.Exception

Description copied from interface: BrowseActionAware

The dispatch method that is triggered when a user needs to change the window/page size of data.

Specified by:

sizeWindow in interface BrowseActionAware

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

response - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

org.scrashmeow.ojb.console.framework.BrowseActionAware#sizeWindow(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse)

sort

public org.apache.struts.action.ActionForward sort(org.apache.struts.action.ActionMapping mapping,
                                                   org.apache.struts.action.ActionForm form,
                                                   HttpServletRequest request,
                                                   HttpServletResponse response)
                                            throws java.lang.Exception

Description copied from interface: BrowseActionAware

The dispatch method that is triggered when a user wishes to sort the data.

Specified by:

sort in interface BrowseActionAware

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

response - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

org.scrashmeow.ojb.console.framework.BrowseActionAware#sort(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse)

unspecified

protected org.apache.struts.action.ActionForward unspecified(org.apache.struts.action.ActionMapping mapping,
                                                             org.apache.struts.action.ActionForm form,
                                                             HttpServletRequest request,
                                                             HttpServletResponse response)
                                                      throws java.lang.Exception

Overrides:

unspecified in class org.apache.struts.actions.DispatchAction

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

response - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

org.apache.struts.actions.DispatchAction#unspecified(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse)

buildCriteria

protected org.apache.ojb.broker.query.Criteria buildCriteria(BrowseForm myForm,
                                                             HttpServletRequest request)
                                                      throws ServiceException

Method buildCriteria @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findResultSetSize

protected int findResultSetSize(BrowseForm myForm,
                                HttpServletRequest request,
                                org.apache.ojb.broker.query.Criteria criteria)
                         throws ServiceException

Method findResultSetSize @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

criteria - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findResultSet

protected java.util.Iterator findResultSet(BrowseForm myForm,
                                           HttpServletRequest request,
                                           org.apache.ojb.broker.query.Criteria criteria)
                                    throws ServiceException

Method findResultSet @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

criteria - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findWindowSize

protected int findWindowSize(BrowseForm myForm,
                             HttpServletRequest request)
                      throws ServiceException

Method findWindowSize @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findCurrentWindow

protected int findCurrentWindow(BrowseForm myForm,
                                HttpServletRequest request)
                         throws ServiceException

Method findCurrentWindow @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

hasSortColumn

protected boolean hasSortColumn(BrowseForm myForm,
                                HttpServletRequest request)
                         throws ServiceException

Method hasSortColumn @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findSortColumn

protected java.lang.String findSortColumn(BrowseForm myForm,
                                          HttpServletRequest request)
                                   throws ServiceException

Method findSortColumn @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findSortOrder

protected boolean findSortOrder(BrowseForm myForm,
                                HttpServletRequest request)
                         throws ServiceException

Method findSortOrder @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findClassDescriptor

protected org.apache.ojb.broker.metadata.ClassDescriptor findClassDescriptor(BrowseForm myForm,
                                                                             HttpServletRequest request)
                                                                      throws ServiceException

Method findClassDescriptor @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

createSearchGridControlFactory

protected SearchGridControlFactory createSearchGridControlFactory(BrowseForm myForm,
                                                                  HttpServletRequest request,
                                                                  org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                                                  java.lang.String sortCol,
                                                                  boolean sortAscending)
                                                           throws ServiceException

Method createSearchGridControlFactory @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

cld - @add-javadoc!!!

sortCol - @add-javadoc!!!

sortAscending - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

createGridControl

protected GridControl createGridControl(SearchGridControlFactory factory,
                                        java.util.Iterator rs,
                                        int rsSize,
                                        int windowSize,
                                        int currentWindow)
                                 throws ServiceException

Method createGridControl @add-javadoc!!!

Parameters:

factory - @add-javadoc!!!

rs - @add-javadoc!!!

rsSize - @add-javadoc!!!

windowSize - @add-javadoc!!!

currentWindow - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

buildGridControl

protected GridControl buildGridControl(BrowseForm myForm,
                                       HttpServletRequest request)
                                throws ServiceException

Method buildGridControl @add-javadoc!!!

Parameters:

myForm - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getKeyMethodMap

protected java.util.Map getKeyMethodMap()

Overrides:

getKeyMethodMap in class OjbcLookupDispatchAction

Returns:

@add-javadoc!!!

See Also:

LookupDispatchAction.getKeyMethodMap()

getBrowseForward

public org.apache.struts.action.ActionForward getBrowseForward(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               HttpServletRequest request)
                                                        throws java.lang.Exception

Description copied from interface: BrowseActionAware

Returns the forward for the browse dispatch

Specified by:

getBrowseForward in interface BrowseActionAware

Parameters:

mapping - @add-javadoc!!!

form - @add-javadoc!!!

request - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

java.lang.Exception - @add-javadoc!!!

See Also:

BrowseActionAware.getBrowseForward(ActionMapping, ActionForm, HttpServletRequest)