uk.ac.ed.epcc.webapp.forms

Class MapForm

java.lang.Object

uk.ac.ed.epcc.webapp.forms.BaseForm

uk.ac.ed.epcc.webapp.forms.MapForm

All Implemented Interfaces:

java.lang.Iterable<Field>, Contexed, Form

Direct Known Subclasses:

BaseHTMLForm, CommandLineForm

public class MapForm
extends BaseForm

Form that can take its inputs as a Map

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MapForm.ParseVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	action_name
static java.lang.String	GENERAL_ERROR

Fields inherited from class uk.ac.ed.epcc.webapp.forms.BaseForm

additional_confirm, log, validators

Constructor Summary

Constructors

Constructor and Description
MapForm(AppContext c)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	addStringMap(java.util.Map<java.lang.String,java.lang.Object> map) return a map of values.
FormResult	doAction(java.util.Map<java.lang.String,java.lang.Object> params) perform any action requested for this form.
java.lang.String	getActionName()
FormAction	getShortcutAction(java.util.Map<java.lang.String,java.lang.Object> params) return the FormAction for non validating actions.
java.lang.String	locateAction(java.util.Map<java.lang.String,java.lang.Object> params)
protected boolean	parsePost(java.util.Map<java.lang.String,java.lang.String> errors, java.util.Map<java.lang.String,java.lang.Object> params, boolean skip_null) parse a map containing the POST parameters for this Form.
void	setActionName(java.lang.String name) Set the name to use for the action parameter defaults to action
boolean	validate(java.util.Collection<java.lang.String> missing_fields, java.util.Map<java.lang.String,java.lang.String> errors) Validate the form storing error information.

Methods inherited from class uk.ac.ed.epcc.webapp.forms.BaseForm

addAction, addInput, addInput, addValidator, clear, containsInput, diff, doAction, fieldCount, get, getAction, getActionNames, getAutoFocus, getContents, getContext, getField, getFieldIterator, getFieldNames, getFormID, getInput, getItem, getLogger, getSingleActionName, getTable, getValidators, hasActions, hasField, iterator, makeField, mustConfirm, put, removeAction, removeField, removeValidator, setAutoFocus, setConfirm, setContents, setFormID, toString, update, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.Form

getTargetStage, isComplete, isFixed, poll, setTargetStage, supportsMultiStage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

GENERAL_ERROR

public static final java.lang.String GENERAL_ERROR

See Also:

Constant Field Values

action_name

protected java.lang.String action_name

Constructor Detail

MapForm

public MapForm(AppContext c)

Method Detail

parsePost

protected boolean parsePost(java.util.Map<java.lang.String,java.lang.String> errors,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            boolean skip_null)

parse a map containing the POST parameters for this Form. Fill in the Per field errors and return parse status. Parse post may be called in a Servlet to interpret a POST or by a form when displaying errors. Even though we have been passed the missing fields and the error map on an error display we re-parse the params to initialise the state of the correct fields.

Parameters:

errors -

params - These may be Strings from POST parameters or objects from default values

skip_null - skip null inputs if true.

Returns:

boolean true if all OK

Throws:

FieldException

validate

public boolean validate(java.util.Collection<java.lang.String> missing_fields,
                        java.util.Map<java.lang.String,java.lang.String> errors)

Validate the form storing error information. Any field that already has an error recorded is assumed to have failed the parse stage and is skipped

Parameters:

missing_fields -

errors -

Returns:

boolean true if no errors

setActionName

public void setActionName(java.lang.String name)

Set the name to use for the action parameter defaults to action

Parameters:

name -

getActionName

public java.lang.String getActionName()

locateAction

public java.lang.String locateAction(java.util.Map<java.lang.String,java.lang.Object> params)
                              throws ActionException

Throws:

ActionException

doAction

public FormResult doAction(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws FieldException,
                           ActionException

perform any action requested for this form.

Parameters:

params - Map of form parameters

Returns:

result Object from the action

Throws:

FieldException

ActionException

getShortcutAction

public FormAction getShortcutAction(java.util.Map<java.lang.String,java.lang.Object> params)
                             throws FieldException,
                                    ActionException

return the FormAction for non validating actions. These ignore the form state as this is intended for cancel/retire actions though we still may want the action to request confirmation.

Parameters:

params -

Returns:

FormAction or null

Throws:

FieldException

ActionException

addStringMap

public java.util.Map<java.lang.String,java.lang.Object> addStringMap(java.util.Map<java.lang.String,java.lang.Object> map)

return a map of values. This is used in tests to extract the default values from a form.

Returns:

Map