nl.b3p.commons.services

Class FormBaseBean

java.lang.Object

nl.b3p.commons.services.FormBaseBean

Direct Known Subclasses:

EditBaseBean, SimpleCrudBaseBean

public abstract class FormBaseBean
extends Object

Deze class slaat de informatie van een struts formulier op samen met alle bijkomende informatie uit de request. Vervolgens kan de request bewerkt worden. Deze class moet nog overklast worden voor het concrete werk.

Version:

$Revision: 1.0 $ $Date: 2005/05/17 12:48:31 $

Author:

Chris van Lith

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action
protected org.apache.struts.action.ActionMessages	errors
protected org.apache.struts.validator.DynaValidatorForm	form
protected boolean	isInit
protected Locale	locale
protected org.apache.commons.logging.Log	log
protected org.apache.struts.action.ActionMapping	mapping
protected org.apache.struts.util.MessageResources	messages
protected javax.servlet.http.HttpServletRequest	request
protected Map	requestParams
protected javax.servlet.http.HttpServletResponse	response
protected javax.servlet.http.HttpSession	session
static String	UNKNOWN_ACTION

Constructor Summary

Constructors

Constructor and Description
FormBaseBean(javax.servlet.http.HttpServletRequest req, org.apache.struts.validator.DynaValidatorForm dform, org.apache.struts.action.ActionMapping mapp) Deze minimale constructor kent geen locale instelling, geen message resources en geen foutterugmelding en zal niet vaak gebruikt worden.
FormBaseBean(javax.servlet.http.HttpServletRequest req, Locale loc, org.apache.struts.util.MessageResources mess, org.apache.struts.action.ActionMessages err, org.apache.struts.validator.DynaValidatorForm dform, org.apache.struts.action.ActionMapping mapp) De constructor bepaalt uit de request de parameters welke gepost zijn en slaat deze lokaal op.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	buttonPressed(String butt) gemaksfunctie die test of een knop met een bepaalde waarde in de request voorkomt en een waarde heeft; hiermee wordt vastgesteld dat deze knop geklikt is.
String	getAction() getter voor action
org.apache.struts.action.ActionMessages	getErrors()
org.apache.struts.validator.DynaValidatorForm	getForm()
protected String	getForm(String param) Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een String.
protected boolean	getFormAsBoolean(String param) Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een boolean.
protected org.apache.struts.upload.FormFile	getFormAsFormFile(String param) Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een FormFile.
protected Integer	getFormAsInteger(String param) Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een Integer.
protected Object	getFormAsObject(String param) Deze gemaksfunctie haalt een waarde voor een formulierveld op als Object.
protected String[]	getFormAsStringArray(String param) Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een String Array.
Locale	getLocale()
org.apache.struts.action.ActionMapping	getMapping()
org.apache.struts.util.MessageResources	getMessages()
protected Object	getParamAsObject(String param) De parameters uit de request zijn opgenomen tijdens de constructie van de class in een Map.
protected String	getParamAsString(String param) De parameters uit de request zijn opgenomen tijdens de constructie van de class in een Map.
protected String[]	getParamAsStringArray(String param) De parameters uit de request zijn opgenomen tijdens de constructie van de class in een Map.
javax.servlet.http.HttpServletRequest	getRequest()
Map	getRequestParams()
javax.servlet.http.HttpServletResponse	getResponse()
javax.servlet.http.HttpSession	getSession()
protected boolean	isAction(String lact) test of een actie de huidige actie is
protected static boolean	nullOrEmpty(String astr) gemaksfunctie die test of een string niet null of leeg is.
protected void	setAction(String action) setter voor action
void	setErrors(org.apache.struts.action.ActionMessages errors)
void	setForm(org.apache.struts.validator.DynaValidatorForm form)
protected void	setForm(String param, Object value) Deze gemaksfunctie plaatst een waarde in een struts formulierveld.
void	setLocale(Locale locale)
void	setMapping(org.apache.struts.action.ActionMapping mapping)
void	setMessages(org.apache.struts.util.MessageResources messages)
void	setRequest(javax.servlet.http.HttpServletRequest request)
void	setRequestParams(Map requestParams)
void	setResponse(javax.servlet.http.HttpServletResponse response)
void	setSession(javax.servlet.http.HttpSession session)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

action

protected String action

errors

protected org.apache.struts.action.ActionMessages errors

session

protected javax.servlet.http.HttpSession session

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

locale

protected Locale locale

messages

protected org.apache.struts.util.MessageResources messages

form

protected org.apache.struts.validator.DynaValidatorForm form

requestParams

protected Map requestParams

mapping

protected org.apache.struts.action.ActionMapping mapping

isInit

protected boolean isInit

UNKNOWN_ACTION

public static final String UNKNOWN_ACTION

See Also:

Constant Field Values

Constructor Detail

FormBaseBean

public FormBaseBean(javax.servlet.http.HttpServletRequest req,
            org.apache.struts.validator.DynaValidatorForm dform,
            org.apache.struts.action.ActionMapping mapp)

Deze minimale constructor kent geen locale instelling, geen message resources en geen foutterugmelding en zal niet vaak gebruikt worden.

Parameters:

req - de request waarmee het struts formulier gepost is

dform - het struts formulier zelf

mapp - de mapping voor deze struts action

FormBaseBean

public FormBaseBean(javax.servlet.http.HttpServletRequest req,
            Locale loc,
            org.apache.struts.util.MessageResources mess,
            org.apache.struts.action.ActionMessages err,
            org.apache.struts.validator.DynaValidatorForm dform,
            org.apache.struts.action.ActionMapping mapp)

De constructor bepaalt uit de request de parameters welke gepost zijn en slaat deze lokaal op. Hiernaast wordt het struts formulier zelf lokaal opgeslagen.

Indien locale, message resources en foutterugmelding null zijn, wordt een default waarde hiervoor vastgesteld, zodat de class verder kan functioneren.

Parameters:

req - de request waarmee het struts formulier gepost is

loc - de locale zoals door struts bepaald

mess - de message resources waaruit de foutmelding worden gehaald

err - de reeks van foutmeldingen, zoals deze tijdens de uitvoer van de functies wordt opgebouwd

dform - het struts formulier zelf

mapp - de mapping voor deze struts action

Method Detail

getAction

public String getAction()

getter voor action

Returns:

geeft de huidige actie

setAction

protected void setAction(String action)

setter voor action

Parameters:

action - zet een nieuwe actie

isAction

protected boolean isAction(String lact)

test of een actie de huidige actie is

Parameters:

lact - te testen actie

Returns:

true indien huidige actie gelijk is aan de te testen actie

buttonPressed

protected boolean buttonPressed(String butt)

gemaksfunctie die test of een knop met een bepaalde waarde in de request voorkomt en een waarde heeft; hiermee wordt vastgesteld dat deze knop geklikt is.

Parameters:

butt - naam van de te testen knop

Returns:

true indien de knop geklikt is

nullOrEmpty

protected static boolean nullOrEmpty(String astr)

gemaksfunctie die test of een string niet null of leeg is.

Parameters:

astr - te testen string

Returns:

true indien leeg of null

getParamAsString

protected String getParamAsString(String param)
                           throws B3pCommonsException

De parameters uit de request zijn opgenomen tijdens de constructie van de class in een Map. Deze functie haalt de waarde op van een bepaalde parameter. Indien de parameter meerdere waarden heeft, wordt alleen de eerste doorgegeven.

Parameters:

param - naam van de parameter

Returns:

waarde van de parameter

Throws:

B3pCommonsException

getParamAsStringArray

protected String[] getParamAsStringArray(String param)
                                  throws B3pCommonsException

De parameters uit de request zijn opgenomen tijdens de constructie van de class in een Map. Deze functie haalt de waarde op van een bepaalde parameter. Normaal betreft het een String array en deze functie cast daar naar toe.

Parameters:

param - naam van de parameter

Returns:

waarde van de parameter

Throws:

B3pCommonsException

getParamAsObject

protected Object getParamAsObject(String param)

De parameters uit de request zijn opgenomen tijdens de constructie van de class in een Map. Deze functie haalt de waarde op van een bepaalde parameter.

Parameters:

param - naam van de parameter

Returns:

waarde van de parameter

getForm

protected String getForm(String param)
                  throws B3pCommonsException

Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een String.

Parameters:

param - naam van formulierveld

Returns:

waarde van het formulierveld als String

Throws:

B3pCommonsException - indien er iets fout gaat bij het ophalen de waarde van het formulierveld (bv als het veld niet bestaat)

getFormAsStringArray

protected String[] getFormAsStringArray(String param)
                                 throws B3pCommonsException

Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een String Array.

Parameters:

param - naam van formulierveld

Returns:

waarde van het formulierveld als String

Throws:

B3pCommonsException - indien er iets fout gaat bij het ophalen de waarde van het formulierveld (bv als het veld niet bestaat)

getFormAsInteger

protected Integer getFormAsInteger(String param)
                            throws B3pCommonsException

Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een Integer.

Parameters:

param - naam van formulierveld

Returns:

waarde van het formulierveld als Integer

Throws:

B3pCommonsException - indien er iets fout gaat bij het ophalen de waarde van het formulierveld (bv als het veld niet bestaat)

getFormAsFormFile

protected org.apache.struts.upload.FormFile getFormAsFormFile(String param)
                                                       throws B3pCommonsException

Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een FormFile. Een FormFile is een struts object waarmee een multipart formulier kan worden opgehaald.

Parameters:

param - naam van formulierveld

Returns:

waarde van het formulierveld als String

Throws:

B3pCommonsException - indien er iets fout gaat bij het ophalen de waarde van het formulierveld (bv als het veld niet bestaat)

getFormAsBoolean

protected boolean getFormAsBoolean(String param)
                            throws B3pCommonsException

Deze gemaksfunctie haalt een waarde voor een formulierveld op en cast deze naar een boolean.

Parameters:

param - naam van formulierveld

Returns:

waarde van het formulierveld als boolean

Throws:

B3pCommonsException - indien er iets fout gaat bij het ophalen de waarde van het formulierveld (bv als het veld niet bestaat)

getFormAsObject

protected Object getFormAsObject(String param)
                          throws B3pCommonsException

Deze gemaksfunctie haalt een waarde voor een formulierveld op als Object. Deze functie wordt gebruikt door alle vergelijkbare functies in deze class.

Indien er fouten optreden, dan worden deze omgevormd naar een B3pCommonsException.

Parameters:

param - naam van formulierveld

Returns:

waarde van het formulierveld als String

Throws:

B3pCommonsException - indien er iets fout gaat bij het ophalen de waarde van het formulierveld (bv als het veld niet bestaat)

setForm

protected void setForm(String param,
           Object value)
                throws B3pCommonsException

Deze gemaksfunctie plaatst een waarde in een struts formulierveld. Indien er fouten optreden dan worden deze omgevormd naar een B3pCommonsException.

Parameters:

param - de naam van het formulierveld

value - de waarde van het formulierveld als Object

Throws:

B3pCommonsException - indien er iets fout gaat bij het bepalen van een waarden (bv als een veld niet bestaat)

getErrors

public org.apache.struts.action.ActionMessages getErrors()

setErrors

public void setErrors(org.apache.struts.action.ActionMessages errors)

getSession

public javax.servlet.http.HttpSession getSession()

setSession

public void setSession(javax.servlet.http.HttpSession session)

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale locale)

getMessages

public org.apache.struts.util.MessageResources getMessages()

setMessages

public void setMessages(org.apache.struts.util.MessageResources messages)

getForm

public org.apache.struts.validator.DynaValidatorForm getForm()

setForm

public void setForm(org.apache.struts.validator.DynaValidatorForm form)

getRequestParams

public Map getRequestParams()

setRequestParams

public void setRequestParams(Map requestParams)

getMapping

public org.apache.struts.action.ActionMapping getMapping()

setMapping

public void setMapping(org.apache.struts.action.ActionMapping mapping)