Package name.matthewgreet.strutscommons.form

Class AbstractForm

java.lang.Object

name.matthewgreet.strutscommons.form.AbstractForm

All Implemented Interfaces:

Serializable, Form

Direct Known Subclasses:

AbstractFormattableForm, NullForm

public abstract class AbstractForm
extends Object
implements Form, Serializable

Template for class that receives form data for form driven Actions.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractForm()

Method Summary

Modifier and Type	Method	Description
abstract void	doValidate(com.opensymphony.xwork2.interceptor.ValidationAware validationAware, com.opensymphony.xwork2.TextProvider textProvider)	Validates and parses form data itself, such as required fields or date validation, writing any error or field messages to the ValidationAware message receiver.
ManualParameterConversionResult	manualParameterConvert(Map<String,String> unprocessedParameters, com.opensymphony.xwork2.interceptor.ValidationAware validationAware, com.opensymphony.xwork2.TextProvider textProvider)	Sets, converts and validates form fields from unprocessed request parameters, writes any error messages, and returns the names of successfully processed parameters and unsuccessfully processed parameters.
abstract void	resetFields()	Sets all displayed fields to default values for data entry of a new record, which is usually an empty string.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractForm

public AbstractForm()

Method Details

resetFields

public abstract void resetFields()

Sets all displayed fields to default values for data entry of a new record, which is usually an empty string.

Specified by:

resetFields in interface Form

doValidate

public abstract void doValidate(com.opensymphony.xwork2.interceptor.ValidationAware validationAware,
 com.opensymphony.xwork2.TextProvider textProvider)

Validates and parses form data itself, such as required fields or date validation, writing any error or field messages to the ValidationAware message receiver. Any error message indicates a failure.

Specified by:

doValidate in interface Form

Parameters:

validationAware - Error message receiver, usually the calling action.

textProvider - Message name translator that generates localised text, if this is set up. This is usually ignored as no localisation is set up.

manualParameterConvert

public ManualParameterConversionResult manualParameterConvert(Map<String,String> unprocessedParameters,
 com.opensymphony.xwork2.interceptor.ValidationAware validationAware,
 com.opensymphony.xwork2.TextProvider textProvider)

Sets, converts and validates form fields from unprocessed request parameters, writes any error messages, and returns the names of successfully processed parameters and unsuccessfully processed parameters. Where multiple request parameters have the same name, only the first is presented.

Unprocessed parameters are those that haven't set a form field for a number of reasons.

• No form field has the same name.
• Form field is annotated with ManualParameterConversion.
• Form field is a non-string array type.
• Form field is a non-string collection type without a converter annotation.

Specified by:

manualParameterConvert in interface Form