Overview
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
L
M
N
O
P
Q
R
S
T
U
V
W
X
A
AbstractFormConfiguration
- class org.formproc.config.
AbstractFormConfiguration
.
Abstract implementation of the FormConfiguration interface which provides common base functionality.
AbstractFormConfiguration()
- Constructor for class org.formproc.config.
AbstractFormConfiguration
AbstractFormElement
- class org.formproc.form.
AbstractFormElement
.
An abstract base class which implements the FormElement interface.
AbstractFormElement()
- Constructor for class org.formproc.form.
AbstractFormElement
Default constructor.
AbstractFormElement(FormElementGroup)
- Constructor for class org.formproc.form.
AbstractFormElement
Construct a new AbstractFormElement which is member of the given FormElementGroup.
AbstractFormElementGroup
- class org.formproc.form.
AbstractFormElementGroup
.
Abstract base class which implements the FormElementGroup interface.
AbstractFormElementGroup()
- Constructor for class org.formproc.form.
AbstractFormElementGroup
Construct an empty AbstractFormElementGroup.
AbstractFormElementGroup(List)
- Constructor for class org.formproc.form.
AbstractFormElementGroup
Construct an AbstractFormElementGroup with the given list of FormElements.
AbstractMessageProvider
- class org.formproc.message.
AbstractMessageProvider
.
Abstract base class which implements the MessageProvider interface.
AbstractMessageProvider()
- Constructor for class org.formproc.message.
AbstractMessageProvider
AbstractRule
- class org.formproc.validation.
AbstractRule
.
Abstract base class which implements the Rule interface.
AbstractRule()
- Constructor for class org.formproc.validation.
AbstractRule
AbstractStorer
- class org.formproc.store.
AbstractStorer
.
Base abstract class for Storer implementations.
AbstractStorer()
- Constructor for class org.formproc.store.
AbstractStorer
AbstractTypeConverter
- class org.formproc.conversion.
AbstractTypeConverter
.
Base abstract class for TypeConverter implementations.
AbstractTypeConverter()
- Constructor for class org.formproc.conversion.
AbstractTypeConverter
allValid()
- Method in class org.formproc.validation.
ValidationResultSet
Return true if all ValidationResults in the set are valid.
allValid()
- Method in class org.formproc.validation.
ValidationResultMap
Return true if all validation results in the map are valid.
AllValidDialog
- class org.formproc.example.
AllValidDialog
.
Dialog which is shown when all fields are valid.
AllValidDialog(Form, Locale)
- Constructor for class org.formproc.example.
AllValidDialog
Construct a new AllValidDialog for the given form in the given locale.
B
BasicFormElement
- class org.formproc.form.
BasicFormElement
.
A basic implementation of the FormElement interface which allows the element to be configured manually.
BasicFormElement()
- Constructor for class org.formproc.form.
BasicFormElement
Create a new FormElement.
BasicFormElement(FormElementGroup)
- Constructor for class org.formproc.form.
BasicFormElement
Construct a new FormElement which is member of the given FormElementGroup.
BasicFormElementGroup
- class org.formproc.form.
BasicFormElementGroup
.
Basic implementation of the FormElementGroup interface which allows configuration to be controlled through method calls.
BasicFormElementGroup()
- Constructor for class org.formproc.form.
BasicFormElementGroup
Construct an empty FormElementGroup.
BigDecimalConverter
- class org.formproc.conversion.
BigDecimalConverter
.
TypeConverter which converts to a BigDecimal.
BigDecimalConverter()
- Constructor for class org.formproc.conversion.
BigDecimalConverter
BigIntegerConverter
- class org.formproc.conversion.
BigIntegerConverter
.
TypeConverter which converts to a BigInteger.
BigIntegerConverter()
- Constructor for class org.formproc.conversion.
BigIntegerConverter
BooleanConverter
- class org.formproc.conversion.
BooleanConverter
.
TypeConverter which converts to an Boolean.
BooleanConverter()
- Constructor for class org.formproc.conversion.
BooleanConverter
ByteConverter
- class org.formproc.conversion.
ByteConverter
.
TypeConverter which converts to a Byte.
ByteConverter()
- Constructor for class org.formproc.conversion.
ByteConverter
C
CharacterConverter
- class org.formproc.conversion.
CharacterConverter
.
TypeConverter which converts to a Character.
CharacterConverter()
- Constructor for class org.formproc.conversion.
CharacterConverter
CLASS_TYPE_VALIDATOR
- Static variable in class org.formproc.
FormManager
Keyword for class type validators (the keyword is "class")
clone()
- Method in class org.formproc.validation.
Validator
Clone the validator.
CONFIGURATION_FILE
- Static variable in class org.formproc.
FormManager
The default configuration file name (formproc.xml).
configure(Configuration)
- Method in class org.formproc.form.
DefaultFormElementGroup
Configure the FormElementGroup.
configure(Configuration)
- Method in class org.formproc.form.
DefaultFormElement
Configure the FormElement using the given JDOM Element object.
configure(Configuration)
- Method in class org.formproc.validation.
ValidatorMapEntry
Configure the ValidatorMapEntry by loading all properties for that Validator.
configure(Configuration)
- Method in class org.formproc.validation.
Validator
Configure the validator using the given configuration object.
configure(Configuration)
- Method in interface org.formproc.validation.
Rule
Configure the rule.
configure(Configuration)
- Method in class org.formproc.validation.
AbstractRule
Configure the rule.
configure(Form)
- Method in class org.formproc.
FormManager
Configure the given form.
configure(FormConfiguration)
- Method in class org.formproc.
Form
Configure this form from the given FormConfiguration.
configureInternal(Configuration)
- Method in class org.formproc.validation.
ValidatorGroup
Configure the validator.
configureInternal(Configuration)
- Method in class org.formproc.validation.
Validator
Implementations can override this method to configure themselves.
configureInternal(Configuration)
- Method in class org.formproc.validation.
ScriptValidator
Configure the validator using the given JDOM element.
configureInternal(Configuration)
- Method in class org.formproc.validation.
RuleValidator
Configure the validator using the given configuration object
configureInternal(Configuration)
- Method in class org.formproc.validation.
REValidator
Configure the validator using the given JDOM element.
convert(FormElement, Object, Locale)
- Method in class org.formproc.
Form
Convert the given value from one type to another using the converter assigned to the given FormElement.
convert(Object, Locale)
- Method in interface org.formproc.conversion.
TypeConverter
Convert the given data object from one type to another.
convert(Object, Locale)
- Method in class org.formproc.conversion.
ShortConverter
Convert the given data object to a Short.
convert(Object, Locale)
- Method in class org.formproc.conversion.
NumberConverter
Convert the given data object to a Date.
convert(Object, Locale)
- Method in class org.formproc.conversion.
LongConverter
Convert the given data object to a Long.
convert(Object, Locale)
- Method in class org.formproc.conversion.
IntegerConverter
Convert the given data object to an Integer.
convert(Object, Locale)
- Method in class org.formproc.conversion.
FloatConverter
Convert the given data object to an Float.
convert(Object, Locale)
- Method in class org.formproc.conversion.
DoubleConverter
Convert the given data object to an Double.
convert(Object, Locale)
- Method in class org.formproc.conversion.
DateConverter
Convert the given data object to a Date.
convert(Object, Locale)
- Method in class org.formproc.conversion.
CharacterConverter
Convert the given data object to a Character.
convert(Object, Locale)
- Method in class org.formproc.conversion.
ByteConverter
Convert the given data object to a Byte.
convert(Object, Locale)
- Method in class org.formproc.conversion.
BooleanConverter
Convert the given data object to an Boolean.
convert(Object, Locale)
- Method in class org.formproc.conversion.
BigIntegerConverter
Convert the given data object to a BigInteger.
convert(Object, Locale)
- Method in class org.formproc.conversion.
BigDecimalConverter
Convert the given data object to a BigDecimal.
convertNullValues
- Variable in class org.formproc.config.
AbstractFormConfiguration
D
DateConverter
- class org.formproc.conversion.
DateConverter
.
TypeConverter which converts to a Date.
DateConverter()
- Constructor for class org.formproc.conversion.
DateConverter
DEFAULT_RESOURCE_LOADER
- Static variable in class org.formproc.
FormManager
The default resource loader (com.anthonyeden.lib.resource.FileResourceLoader)
DEFAULT_SCRIPT_ROOT_TYPE
- Static variable in class org.formproc.validation.
ScriptValidator
The default script root type ("file").
DEFAULT_SEPARATOR
- Static variable in class org.formproc.validation.
ValidationResultSet
The default separator.
DefaultFormElement
- class org.formproc.form.
DefaultFormElement
.
A default implementation of the FormElement interface.
DefaultFormElement(FormManager)
- Constructor for class org.formproc.form.
DefaultFormElement
Create a new FormElement.
DefaultFormElement(FormManager, FormElementGroup)
- Constructor for class org.formproc.form.
DefaultFormElement
Construct a new FormElement which is member of the given FormElementGroup.
DefaultFormElementGroup
- class org.formproc.form.
DefaultFormElementGroup
.
Default implementation of the FormElementGroup interface.
DefaultFormElementGroup(FormManager)
- Constructor for class org.formproc.form.
DefaultFormElementGroup
Construct an empty FormElementGroup.
defaultValue
- Variable in class org.formproc.form.
AbstractFormElement
DoubleConverter
- class org.formproc.conversion.
DoubleConverter
.
TypeConverter which converts to a Double.
DoubleConverter()
- Constructor for class org.formproc.conversion.
DoubleConverter
E
error
- Variable in class org.formproc.validation.
ValidationResult
ErrorDialog
- class org.formproc.example.
ErrorDialog
.
Error dialog which is displayed when there are one or more validation errors.
ErrorDialog(FormResult, Locale)
- Constructor for class org.formproc.example.
ErrorDialog
Construct a new ErrorDialog with the given FormResult in the given locale.
ExampleApp
- class org.formproc.example.
ExampleApp
.
An example Swing application which demonstrates how FormProc can be used in a desktop application.
ExampleApp()
- Constructor for class org.formproc.example.
ExampleApp
Construct the ExampleApp.
ExampleResourceBundle
- class org.formproc.example.
ExampleResourceBundle
.
Default resource bundle for the example application.
ExampleResourceBundle_fr
- class org.formproc.example.
ExampleResourceBundle_fr
.
French language resource bundle for the example application.
ExampleResourceBundle_fr()
- Constructor for class org.formproc.example.
ExampleResourceBundle_fr
ExampleResourceBundle()
- Constructor for class org.formproc.example.
ExampleResourceBundle
ExtendedHttpForm
- class org.formproc.servlet.
ExtendedHttpForm
.
Extended version of the HttpForm class which pulls data from both the request and the session.
ExtendedHttpForm()
- Constructor for class org.formproc.servlet.
ExtendedHttpForm
Construct a new ExtendedHttpForm.
ExtendedHttpForm(String, Object)
- Constructor for class org.formproc.servlet.
ExtendedHttpForm
Construct a new ExtendedHttpForm with the given form name and target object.
F
filterFormData(FormData[], List)
- Static method in class org.formproc.
FormUtilities
Filter the incoming FormData array so that the resulting array only contains values for fields which are part of the FormElementGroup.
findFormData(FormElement, FormData[])
- Static method in class org.formproc.
FormUtilities
Helper method for finding a named FormData object in an array of FormData objects.
findFormData(String, FormData[])
- Static method in class org.formproc.
FormUtilities
Helper method for finding a named FormData object in an array of FormData objects.
findPath(Configuration, FileObject)
- Method in class org.formproc.
FormManager
Find the path specified in the given configuration object.
FloatConverter
- class org.formproc.conversion.
FloatConverter
.
TypeConverter which converts to a Float.
FloatConverter()
- Constructor for class org.formproc.conversion.
FloatConverter
Form
- class org.formproc.
Form
.
A form represents a collection of fields which can be validated.
Form()
- Constructor for class org.formproc.
Form
Construct a new form.
Form(String, Object)
- Constructor for class org.formproc.
Form
Construct a new form with the given form name and target object.
FormConfiguration
- interface org.formproc.
FormConfiguration
.
Standard interface for configuration information for a single Form.
FormConfigurationException
- exception org.formproc.
FormConfigurationException
.
An exception which is thrown if there are any problems with form configuration.
FormConfigurationException(String)
- Constructor for class org.formproc.
FormConfigurationException
Construct a new FormConfigurationException with the given message.
FormConfigurationException(String, Throwable)
- Constructor for class org.formproc.
FormConfigurationException
Construct a new FormConfigurationException with the given nested Exception and error message.
FormConfigurationException(Throwable)
- Constructor for class org.formproc.
FormConfigurationException
Construct a new FormConfigurationException with the given nested Exception.
formData
- Variable in class org.formproc.validation.
ValidationResult
FormData
- class org.formproc.
FormData
.
A name/value pair for a single form field.
FormData(String, Object)
- Constructor for class org.formproc.
FormData
Construct a new FormData object for the given field name with the given value.
FormElement
- interface org.formproc.
FormElement
.
A FormElement represents a single form field.
formElementGroup
- Variable in class org.formproc.form.
AbstractFormElement
FormElementGroup
- interface org.formproc.
FormElementGroup
.
Base interface for a group of FormElements where elements can get references to other form elements so that elements can validate based on the results of other elements.
formElementGroupList
- Variable in class org.formproc.config.
AbstractFormConfiguration
formElementGroups
- Variable in class org.formproc.config.
AbstractFormConfiguration
formElementList
- Variable in class org.formproc.config.
AbstractFormConfiguration
formElements
- Variable in class org.formproc.config.
AbstractFormConfiguration
formElements
- Variable in class org.formproc.form.
AbstractFormElementGroup
formElements
- Variable in class org.formproc.validation.
ValidationResult
formManager
- Variable in class org.formproc.form.
DefaultFormElementGroup
formManager
- Variable in class org.formproc.form.
DefaultFormElement
formManager
- Variable in class org.formproc.validation.
Validator
FormManager
- class org.formproc.
FormManager
.
The FormManager is the central class for configuring Form objects.
FormManager()
- Constructor for class org.formproc.
FormManager
Construct a new FormManager.
FormManager(File)
- Constructor for class org.formproc.
FormManager
Construct a new FormManager using the given configuration file to configure the FormManager.
FormManager(FileObject)
- Constructor for class org.formproc.
FormManager
Construct a new FormManager using the given configuration file to configure the FormManager.
FormManager(InputStream)
- Constructor for class org.formproc.
FormManager
Construct a new FormManager using the given InputStream to configure the FormManager.
FormResult
- class org.formproc.
FormResult
.
Class representing the results of processing a Form.
FormResult()
- Constructor for class org.formproc.
FormResult
Construct a FormResult with no results.
FormResult(ValidationResultMap, ValidationResultMap, Map)
- Constructor for class org.formproc.
FormResult
Construct a FormResult with the given element validation results and group validation results.
FormUtilities
- class org.formproc.
FormUtilities
.
Utility class.
G
getAge()
- Method in class org.formproc.example.
User
getBirthdate()
- Method in class org.formproc.example.
User
getContents()
- Method in class org.formproc.example.
ExampleResourceBundle_fr
Get the bundle contents.
getContents()
- Method in class org.formproc.example.
ExampleResourceBundle
Get the contents of the resource bundle.
getDefaultValue()
- Method in interface org.formproc.
FormElement
Get the default value which is used if no data is submitted for the given form element.
getDefaultValue()
- Method in class org.formproc.form.
AbstractFormElement
Get the default value which is used if no data is submitted for the given form element.
getError()
- Method in class org.formproc.validation.
ValidationResult
Return the Throwable error or null.
getError()
- Method in class org.formproc.validation.
RuleResult
Get the error thrown by the rule.
getErrorMessage()
- Method in class org.formproc.validation.
Validator
Return the validator error message using the default Locale.
getErrorMessage()
- Method in class org.formproc.validation.
ValidationResultSet
Get the error message for the validation set.
getErrorMessage()
- Method in class org.formproc.validation.
ValidationResult
Return the error message from the validator which was in error using the default Locale.
getErrorMessage()
- Method in class org.formproc.validation.
RuleResult
Get the error message.
getErrorMessage(Locale)
- Method in class org.formproc.validation.
Validator
Get the validator error message for the given locale.
getErrorMessage(Locale)
- Method in class org.formproc.validation.
ValidationResult
Return the error message from the validator which was in error using the given Locale.
getErrorMessage(String)
- Method in class org.formproc.
Form
Get the last error message for the given field.
getErrorMessage(String)
- Method in class org.formproc.validation.
ValidationResultSet
Get the error message for the validation set.
getErrorMessage(String)
- Method in class org.formproc.validation.
ValidationResultMap
Get the error message for the given field or null if the field is valid.
getErrorMessage(String, Locale)
- Method in class org.formproc.
Form
Get the last error message for the given field using the given Locale.
getErrorMessage(String, Locale)
- Method in class org.formproc.validation.
ValidationResultMap
Get the locale-specific error message for the given field or null if the field is valid.
getErrorMessages()
- Method in class org.formproc.validation.
ValidationResultMap
Get an iterator for all error messages using the default Locale.
getErrorMessages(Locale)
- Method in class org.formproc.validation.
ValidationResultMap
Get an Iterator for all error messages in the given Locale.
getErrorOrMessage(String)
- Method in class org.formproc.
FormResult
Return the error message or user message for the given named element.
getErrorOrMessage(String, Locale)
- Method in class org.formproc.
FormResult
Return the error message or user message for the given named element.
getFileSystemManager()
- Method in class org.formproc.
FormManager
Get the FileSystemManager.
getFormConfiguration()
- Method in class org.formproc.
Form
Get the FormConfiguration for this form.
getFormConfiguration(String)
- Method in class org.formproc.
FormManager
Get the FormConfiguration for the given form name.
getFormData()
- Method in class org.formproc.validation.
ValidationResult
Get the validated FormData array.
getFormElement(String)
- Method in interface org.formproc.
FormConfiguration
Get the named FormElement.
getFormElement(String)
- Method in class org.formproc.config.
AbstractFormConfiguration
Get the named FormElement.
getFormElementGroup(String)
- Method in interface org.formproc.
FormConfiguration
Get the named FormElementGroup.
getFormElementGroup(String)
- Method in class org.formproc.config.
AbstractFormConfiguration
Get the named FormElementGroup.
getFormElementGroups()
- Method in interface org.formproc.
FormConfiguration
Return a non-mutable List of FormElementGroup objects in the same order as they appear in the form's configuration.
getFormElementGroups()
- Method in class org.formproc.config.
AbstractFormConfiguration
Return a non-mutable List of FormElementGroup objects in the same order as they appear in the form's configuration.
getFormElements()
- Method in interface org.formproc.
FormElementGroup
Get the List of FormElements in this group.
getFormElements()
- Method in interface org.formproc.
FormConfiguration
Return a non-mutable List of FormElements in the same order as they appear in the form's configuration.
getFormElements()
- Method in class org.formproc.config.
AbstractFormConfiguration
Return a non-mutable List of FormElements in the same order as they appear in the form's configuration.
getFormElements()
- Method in class org.formproc.form.
AbstractFormElementGroup
Get the List of FormElements in this group.
getFormElements()
- Method in class org.formproc.validation.
ValidationResult
Get the array of validated elements.
getGroupErrorMessage(String)
- Method in class org.formproc.
FormResult
Get the error message for the named FormElementGroup.
getGroupErrorMessage(String, Locale)
- Method in class org.formproc.
FormResult
Get the error message for the named FormElementGroup.
getGroupValidationResults()
- Method in class org.formproc.
FormResult
Get the ValidationResultMap for all element group validation results.
getLocale()
- Method in class org.formproc.example.
ExampleApp
Get the Locale to use for messages.
getLocale()
- Method in class org.formproc.validation.
ValidationResult
Get the Locale which was specified at validation time.
getMessage()
- Method in interface org.formproc.
FormElement
Get the field's message in the default Locale.
getMessage()
- Method in class org.formproc.form.
AbstractFormElement
Get the field's message in the default Locale.
getMessage(Locale)
- Method in interface org.formproc.
FormElement
Get the message in the given Locale.
getMessage(Locale)
- Method in class org.formproc.form.
AbstractFormElement
Get the message in the given Locale.
getMessage(Locale)
- Method in class org.formproc.message.
ResourceBundleMessageProvider
Get the message for the given locale.
getMessage(Locale)
- Method in interface org.formproc.message.
MessageProvider
Get the message for the given locale.
getMessage(Locale)
- Method in class org.formproc.message.
InlineMessageProvider
Get the message for the given locale.
getMessage(Locale)
- Method in class org.formproc.message.
AbstractMessageProvider
Get the message for the given locale.
getMessage(String)
- Method in class org.formproc.
Form
Get a message for the given field using the default Locale.
getMessage(String, Locale)
- Method in class org.formproc.
Form
Get a message for the given field using the given Locale.
getMessageElementName()
- Method in class org.formproc.message.
InlineMessageProvider
Get the element name which is used for finding the inline messages.
getName()
- Method in interface org.formproc.
FormElementGroup
Get the form element group name.
getName()
- Method in interface org.formproc.
FormElement
Get the FormElement name.
getName()
- Method in class org.formproc.
FormData
Get the field name.
getName()
- Method in interface org.formproc.
FormConfiguration
Get the form name.
getName()
- Method in class org.formproc.
Form
Get the form name.
getName()
- Method in class org.formproc.config.
AbstractFormConfiguration
Get the form name.
getName()
- Method in class org.formproc.example.
User
getName()
- Method in class org.formproc.form.
AbstractFormElementGroup
Get the form element group name.
getName()
- Method in class org.formproc.form.
AbstractFormElement
Get the FormElement name.
getNotes()
- Method in class org.formproc.example.
User
getOccupation()
- Method in class org.formproc.example.
User
getOriginalValue(String)
- Method in class org.formproc.
FormResult
Get the original value submitted for the given field.
getOriginalValueAsString(String)
- Method in class org.formproc.
FormResult
Get the original value submitted for the given field as a String.
getPassword()
- Method in class org.formproc.example.
User
getPattern()
- Method in class org.formproc.validation.
REValidator
Get the Pattern used for matching.
getPatternString()
- Method in class org.formproc.validation.
REValidator
Get the current pattern as a String.
getProperties()
- Method in class org.formproc.validation.
ValidatorMapEntry
Get a Map of properties for the given Validator.
getScript()
- Method in class org.formproc.validation.
ScriptValidator
Get the script file.
getScriptRoot()
- Method in class org.formproc.validation.
ScriptValidator
Get the script root.
getScriptRootType()
- Method in class org.formproc.validation.
ScriptValidator
Get the type for the script root.
getSharedValidators()
- Method in class org.formproc.
FormManager
Get a Map of shared validators.
getStorer()
- Method in interface org.formproc.
FormElement
Get the Storer used to store field data in the target object.
getStorer()
- Method in interface org.formproc.
FormConfiguration
Get the default Storer.
getStorer()
- Method in class org.formproc.config.
AbstractFormConfiguration
Get the default Storer.
getStorer()
- Method in class org.formproc.form.
AbstractFormElement
Get the Storer used to store field data in the target object.
getTarget()
- Method in class org.formproc.
Form
Get the target object.
getThrowable()
- Method in class org.formproc.
FormConfigurationException
Get the nested exception
getTypeConverter()
- Method in interface org.formproc.
FormElement
Get the TypeConverter which will be applied before invoking the target object's write method.
getTypeConverter()
- Method in interface org.formproc.
FormConfiguration
Get the default TypeConverter.
getTypeConverter()
- Method in class org.formproc.config.
AbstractFormConfiguration
Get the default TypeConverter.
getTypeConverter()
- Method in class org.formproc.form.
AbstractFormElement
Get the TypeConverter which will be applied before invoking the target object's write method.
getUsername()
- Method in class org.formproc.example.
User
getValidationResults()
- Method in class org.formproc.
FormResult
Get the ValidationResultMap for all element validation results.
getValidator()
- Method in interface org.formproc.
FormElementGroup
Get the Validator for this element group.
getValidator()
- Method in interface org.formproc.
FormElement
Get the validator for this field.
getValidator()
- Method in interface org.formproc.
FormConfiguration
Get the default Validator.
getValidator()
- Method in class org.formproc.config.
AbstractFormConfiguration
Get the default Validator.
getValidator()
- Method in class org.formproc.form.
AbstractFormElementGroup
Get the Validator for this element group.
getValidator()
- Method in class org.formproc.form.
AbstractFormElement
Get the validator for this field.
getValidator()
- Method in class org.formproc.validation.
ValidationResult
Return the validator which is in error.
getValidator(Configuration)
- Method in class org.formproc.
FormManager
Get the validator which is defined by the given configuration object.
getValidatorClass()
- Method in class org.formproc.validation.
ValidatorMapEntry
Get the validator class.
getValidatorMap()
- Method in class org.formproc.
FormManager
Get the validator map.
getValidators()
- Method in class org.formproc.validation.
ValidatorGroup
Get the List of validators in the group.
getValue()
- Method in class org.formproc.
FormData
Get the value.
getWriteMethod()
- Method in interface org.formproc.
FormElement
Get a predefined write method for the given form element.
getWriteMethod()
- Method in class org.formproc.form.
AbstractFormElement
Get a predefined write method for the given form element.
getWriteMethod(String)
- Method in class org.formproc.
Form
Get the write method for the given field name.
H
HttpForm
- class org.formproc.servlet.
HttpForm
.
Extension of the Form class which adds a method for easily handling HTTP form requests.
HttpForm()
- Constructor for class org.formproc.servlet.
HttpForm
Construct a new HttpForm.
HttpForm(String, Object)
- Constructor for class org.formproc.servlet.
HttpForm
Construct a new HttpForm with the given form name and target object.
I
InlineMessageProvider
- class org.formproc.message.
InlineMessageProvider
.
Implementation of the MessageProvider interface which expects the messages to be stored inline in the configuration information.
InlineMessageProvider()
- Constructor for class org.formproc.message.
InlineMessageProvider
Default constructor.
IntegerConverter
- class org.formproc.conversion.
IntegerConverter
.
TypeConverter which converts to an Integer.
IntegerConverter()
- Constructor for class org.formproc.conversion.
IntegerConverter
isAllowExtended()
- Method in class org.formproc.conversion.
BooleanConverter
Get the allow extended property value.
isConvertNullValues()
- Method in interface org.formproc.
FormConfiguration
Return true to convert null values.
isConvertNullValues()
- Method in class org.formproc.config.
AbstractFormConfiguration
Return true to convert null values.
isElementGroupValid(String)
- Method in class org.formproc.
FormResult
Return true if the given form element group is valid.
isElementValid(String)
- Method in class org.formproc.
FormResult
Return true if the given form element is valid.
IsIntRule
- class org.formproc.example.
IsIntRule
.
This validates that the given value is an integer.
IsIntRule()
- Constructor for class org.formproc.example.
IsIntRule
isOptional()
- Method in interface org.formproc.
FormElement
Return true if the FormElement is optional.
isOptional()
- Method in class org.formproc.form.
AbstractFormElement
Return true if the FormElement is optional.
isPassed()
- Method in class org.formproc.validation.
ScriptResult
Return true if the script validation passes.
isSkipNullValues()
- Method in interface org.formproc.
FormConfiguration
Return true to skip validation, conversion and storage of null values.
isSkipNullValues()
- Method in class org.formproc.config.
AbstractFormConfiguration
Return true to skip validation, conversion and storage of null values.
isStoreNullValues()
- Method in interface org.formproc.
FormConfiguration
Return true to store null values.
isStoreNullValues()
- Method in class org.formproc.config.
AbstractFormConfiguration
Return true to store null values.
isValid()
- Method in class org.formproc.
FormResult
Return true if all validators passed, and thus all of the form data is valid.
isValid()
- Method in class org.formproc.validation.
ValidationResult
Return true all fields are valid.
isValid()
- Method in class org.formproc.validation.
RuleResult
Return true if the value is valid against the target rule.
isValid(String)
- Method in class org.formproc.validation.
ValidationResultMap
Return true if the given field's validation result is true.
isValidateNullValues()
- Method in interface org.formproc.
FormConfiguration
Return true to validate null values.
isValidateNullValues()
- Method in class org.formproc.config.
AbstractFormConfiguration
Return true to validate null values.
L
load(InputStream)
- Method in class org.formproc.
FormManager
Deprecated.
Use loadConfiguration() instead
load(InputStream)
- Method in class org.formproc.config.
XMLFormConfiguration
Load the configuration from the given input stream.
loadConfiguration()
- Method in class org.formproc.
FormManager
Load the configuration using this class's ClassLoader to locate the configuration file as a resource stream.
loadConfiguration(Configuration)
- Method in class org.formproc.config.
XMLFormConfiguration
Load the Form's configuration information from the given configuration object.
loadConfiguration(Configuration)
- Method in interface org.formproc.conversion.
TypeConverter
Load the converter's configuration.
loadConfiguration(Configuration)
- Method in class org.formproc.conversion.
NumberConverter
Load the converter's configuration.
loadConfiguration(Configuration)
- Method in class org.formproc.conversion.
DateConverter
Load the converter's configuration.
loadConfiguration(Configuration)
- Method in class org.formproc.conversion.
BooleanConverter
Load the converter's configuration.
loadConfiguration(Configuration)
- Method in class org.formproc.conversion.
AbstractTypeConverter
Provides a no-op default implementation of this method.
loadConfiguration(Configuration)
- Method in class org.formproc.message.
ResourceBundleMessageProvider
Load the message provider's configuration.
loadConfiguration(Configuration)
- Method in interface org.formproc.message.
MessageProvider
Load the message provider's configuration.
loadConfiguration(Configuration)
- Method in class org.formproc.message.
InlineMessageProvider
Load the message provider's configuration.
loadConfiguration(Configuration)
- Method in class org.formproc.message.
AbstractMessageProvider
Load the message provider's configuration.
loadConfiguration(Configuration)
- Method in interface org.formproc.store.
Storer
Load the storer's configuration.
loadConfiguration(Configuration)
- Method in class org.formproc.store.
AbstractStorer
Provides a no-op default implementation of this method.
loadConfiguration(File)
- Method in class org.formproc.
FormManager
Load the configuration from the given file.
loadConfiguration(FileObject)
- Method in class org.formproc.
FormManager
Load the configuration from the given file.
loadConfiguration(InputStream)
- Method in class org.formproc.
FormManager
Load the configuration from the given InputStream.
loadConfiguration(InputStream)
- Method in class org.formproc.config.
XMLFormConfiguration
Load the form's configuration information from the given InputStream.
loadForm(Configuration)
- Method in class org.formproc.
FormManager
Load the form configuration defined by the given configuration object.
loadInclude(Configuration)
- Method in class org.formproc.
FormManager
Load the included configuration defined by the given configuration object.
loadResources()
- Method in class org.formproc.example.
ExampleApp
Load the resources.
loadResources(Locale)
- Method in class org.formproc.example.
ExampleApp
Load the resources for the given locale.
loadSharedValidator(Configuration)
- Method in class org.formproc.
FormManager
Load the shared validator defined by the given configuration object.
loadValidatorMap(Configuration)
- Method in class org.formproc.
FormManager
Load the validator map defined by the given configuration object.
locale
- Variable in class org.formproc.validation.
ValidationResult
LongConverter
- class org.formproc.conversion.
LongConverter
.
TypeConverter which converts to a Long.
LongConverter()
- Constructor for class org.formproc.conversion.
LongConverter
M
main(String[])
- Static method in class org.formproc.example.
ExampleApp
Main entry point for the ExampleApp.
MapStorer
- class org.formproc.store.
MapStorer
.
Implementation of the Storer interface which stores values in a Map.
MapStorer()
- Constructor for class org.formproc.store.
MapStorer
Construct a new MapStorer.
messageProvider
- Variable in class org.formproc.form.
AbstractFormElement
messageProvider
- Variable in class org.formproc.validation.
Validator
MessageProvider
- interface org.formproc.message.
MessageProvider
.
Base interface which must be implemented by any class which will provide runtime messages such as error and other messages consumed be users.
messages
- Variable in class org.formproc.form.
AbstractFormElement
N
name
- Variable in class org.formproc.config.
AbstractFormConfiguration
name
- Variable in class org.formproc.form.
AbstractFormElementGroup
name
- Variable in class org.formproc.form.
AbstractFormElement
NumberConverter
- class org.formproc.conversion.
NumberConverter
.
TypeConverter which converts to a Number.
NumberConverter()
- Constructor for class org.formproc.conversion.
NumberConverter
O
optional
- Variable in class org.formproc.form.
AbstractFormElement
org.formproc
- package org.formproc
Base package which contains the main FormProc objects.
org.formproc.config
- package org.formproc.config
Package which contains implementations of the FormElement and FormElementGroup interfaces.
org.formproc.conversion
- package org.formproc.conversion
Package which contains classes for converting from one data type to another.
org.formproc.example
- package org.formproc.example
Example code.
org.formproc.form
- package org.formproc.form
Package which contains classes for providing configuration information to FormProc.
org.formproc.message
- package org.formproc.message
Package which contains classes which provide user-readable messages when errors occur or other times when a user-readable message is required.
org.formproc.servlet
- package org.formproc.servlet
Servlet specific code.
org.formproc.store
- package org.formproc.store
Package which contains classes used for storing field values into some target object.
org.formproc.validation
- package org.formproc.validation
Package which contains classes which are used for validing user input values.
P
PassValidator
- class org.formproc.validation.
PassValidator
.
A form validator which allows any incoming data to be passed as valid.
PassValidator()
- Constructor for class org.formproc.validation.
PassValidator
process(FormData[])
- Method in class org.formproc.
Form
Process the given FormData objects.
process(FormData[], Locale)
- Method in class org.formproc.
Form
Process the given FormData objects.
process(FormElement, FormData, Locale)
- Method in class org.formproc.
Form
Process the given FormData object.
process(HttpServletRequest)
- Method in class org.formproc.servlet.
HttpForm
Process the given HttpServletRequest.
process(HttpServletRequest)
- Method in class org.formproc.servlet.
ExtendedHttpForm
Process the given HttpServletRequest.
process(HttpServletRequest, Locale)
- Method in class org.formproc.servlet.
HttpForm
Process the given HttpServletRequest.
process(HttpServletRequest, Locale)
- Method in class org.formproc.servlet.
ExtendedHttpForm
Process the given HttpServletRequest.
process(List)
- Method in class org.formproc.
Form
Process the given FormData objects.
process(List, Locale)
- Method in class org.formproc.
Form
Process the given FormData objects.
properties
- Variable in class org.formproc.validation.
Validator
Q
quit()
- Method in class org.formproc.example.
ExampleApp
Quit the ExampleApp.
R
ReflectionStorer
- class org.formproc.store.
ReflectionStorer
.
Implementation of the Storer interface which uses reflection to store the specified field value in the target object of the specified Form.
ReflectionStorer()
- Constructor for class org.formproc.store.
ReflectionStorer
Construct a new ReflectionStorer.
reload()
- Method in class org.formproc.
FormManager
Reload the configuration.
ResourceBundleMessageProvider
- class org.formproc.message.
ResourceBundleMessageProvider
.
Implementation of the MessageProvider interface which uses the Java ResourceBundle class to locate messages in resource bundles.
ResourceBundleMessageProvider()
- Constructor for class org.formproc.message.
ResourceBundleMessageProvider
REValidator
- class org.formproc.validation.
REValidator
.
An implementation of the Validator interface which validates FormElements based on a Perl 5 regular expression.
REValidator()
- Constructor for class org.formproc.validation.
REValidator
Construct a new REFormValidator.
REValidator(String)
- Constructor for class org.formproc.validation.
REValidator
Construct a new REValidator with the given pattern.
Rule
- interface org.formproc.validation.
Rule
.
Interface for a Rule.
RuleResult
- class org.formproc.validation.
RuleResult
.
The RuleResult class encapsulates a result of a validation against a Rule.
RuleResult()
- Constructor for class org.formproc.validation.
RuleResult
Construct a new RuleResult with valid set to true.
RuleResult(String)
- Constructor for class org.formproc.validation.
RuleResult
Construct a new RuleResult with valid set to false and with the given error message.
RuleResult(Throwable)
- Constructor for class org.formproc.validation.
RuleResult
Construct a new RuleResult with valid set to false and with the given Throwable error.
RuleResult(Throwable, String)
- Constructor for class org.formproc.validation.
RuleResult
Construct a new RuleResult with valid set to false and with the given Throwable error and error message.
RuleValidator
- class org.formproc.validation.
RuleValidator
.
A FormValidator which uses Rule objects to test for validity.
RuleValidator()
- Constructor for class org.formproc.validation.
RuleValidator
Construct a RuleValidator.
S
SCRIPT_ROOT_TYPE_CLASSPATH
- Static variable in class org.formproc.validation.
ScriptValidator
The script root type "classpath".
SCRIPT_ROOT_TYPE_FILE
- Static variable in class org.formproc.validation.
ScriptValidator
The script root type "file".
ScriptResult
- class org.formproc.validation.
ScriptResult
.
A simple wrapper object for a script result.
ScriptResult()
- Constructor for class org.formproc.validation.
ScriptResult
Construct a new ScriptResult object.
ScriptValidator
- class org.formproc.validation.
ScriptValidator
.
A Validator which uses a BSF-supported script to validate the form data.
ScriptValidator()
- Constructor for class org.formproc.validation.
ScriptValidator
Construct a new ScriptValidator.
setAge(int)
- Method in class org.formproc.example.
User
setAge(Integer)
- Method in class org.formproc.example.
User
setAllowExtended(boolean)
- Method in class org.formproc.conversion.
BooleanConverter
Set the allow extended property.
setAllowExtended(String)
- Method in class org.formproc.conversion.
BooleanConverter
Set the allow extended property.
setBirthdate(Date)
- Method in class org.formproc.example.
User
setConvertNullValues(String)
- Method in class org.formproc.config.
XMLFormConfiguration
setDateStyle(String)
- Method in class org.formproc.conversion.
DateConverter
Set the date style property.
setDefaultValue(String)
- Method in interface org.formproc.
FormElement
Set the default value which is used if no data is submitted for the given form element.
setDefaultValue(String)
- Method in class org.formproc.form.
AbstractFormElement
Set the default value which is used if no data is submitted for the given form element.
setFormConfiguration(String, FormConfiguration)
- Method in class org.formproc.
FormManager
Set the FormConfiguration for the given form name.
setFormManager(FormManager)
- Method in class org.formproc.validation.
Validator
Set the FormManager.
setGroupingUsed(String)
- Method in class org.formproc.conversion.
NumberConverter
Set the grouping used property.
setMaximumFractionDigits(String)
- Method in class org.formproc.conversion.
NumberConverter
Set the maximum fraction digits property.
setMaximumIntegerDigits(String)
- Method in class org.formproc.conversion.
NumberConverter
Set the maximum integer digits property.
setMessageElementName(String)
- Method in class org.formproc.message.
InlineMessageProvider
Set the element name which is used for finding the inline messages.
setMessageProvider(MessageProvider)
- Method in class org.formproc.form.
BasicFormElement
Set the message provider.
setMinimumFractionDigits(String)
- Method in class org.formproc.conversion.
NumberConverter
Set the minimum fraction digits property.
setMinimumIntegerDigits(String)
- Method in class org.formproc.conversion.
NumberConverter
Set the minimum integer digits property.
setName(String)
- Method in class org.formproc.
Form
Set the form name.
setName(String)
- Method in class org.formproc.config.
AbstractFormConfiguration
Set the form name.
setName(String)
- Method in class org.formproc.example.
User
setName(String)
- Method in class org.formproc.form.
AbstractFormElementGroup
Set the group name.
setName(String)
- Method in class org.formproc.form.
AbstractFormElement
Set the FormElement name.
setNotes(String)
- Method in class org.formproc.example.
User
setOccupation(String)
- Method in class org.formproc.example.
User
setOptional(boolean)
- Method in interface org.formproc.
FormElement
Set to true if the FormElement is optional.
setOptional(boolean)
- Method in class org.formproc.form.
AbstractFormElement
Set to true if the FormElement is optional.
setOptional(String)
- Method in interface org.formproc.
FormElement
Set to "true" if the FormElement is optional.
setOptional(String)
- Method in class org.formproc.form.
AbstractFormElement
Set to "true" if the FormElement is optional.
setParseIntegerOnly(String)
- Method in class org.formproc.conversion.
NumberConverter
Set the parse integer only property.
setPassed(boolean)
- Method in class org.formproc.validation.
ScriptResult
Set to true if the script validation passes.
setPassword(String)
- Method in class org.formproc.example.
User
setPattern(Pattern)
- Method in class org.formproc.validation.
REValidator
Set the regular expression pattern.
setPattern(String)
- Method in class org.formproc.conversion.
NumberConverter
Set the pattern property.
setPattern(String)
- Method in class org.formproc.conversion.
DateConverter
Set the pattern property.
setPattern(String)
- Method in class org.formproc.validation.
REValidator
Set the regular expression pattern to the given String.
setProperties(Map)
- Method in class org.formproc.validation.
Validator
Set the global properties which are shared between all validators of a particular type.
setProperties(Map)
- Method in class org.formproc.validation.
ScriptValidator
Set the global properties which are shared between all validators of a particular type.
setScript(File)
- Method in class org.formproc.validation.
ScriptValidator
Set the script file.
setScript(String)
- Method in class org.formproc.validation.
ScriptValidator
Set the script file.
setScriptRoot(File)
- Method in class org.formproc.validation.
ScriptValidator
Set the script root.
setScriptRoot(String)
- Method in class org.formproc.validation.
ScriptValidator
Set the script root.
setScriptRootType(String)
- Method in class org.formproc.validation.
ScriptValidator
Set the type for the script root.
setSkipNullValues(String)
- Method in class org.formproc.config.
XMLFormConfiguration
setStoreNullValues(String)
- Method in class org.formproc.config.
XMLFormConfiguration
setStorer(Storer)
- Method in class org.formproc.form.
BasicFormElement
Set the storer.
setTarget(Object)
- Method in class org.formproc.
Form
Set the target object.
setTimeStyle(String)
- Method in class org.formproc.conversion.
DateConverter
Set the time style property.
setTypeConverter(TypeConverter)
- Method in class org.formproc.form.
BasicFormElement
Set the type converter.
setUsername(String)
- Method in class org.formproc.example.
User
setValidateNullValues(String)
- Method in class org.formproc.config.
XMLFormConfiguration
setValidator(Validator)
- Method in class org.formproc.form.
BasicFormElementGroup
Set the group validator.
setValidator(Validator)
- Method in class org.formproc.form.
BasicFormElement
Set the validator.
setWriteMethod(String)
- Method in class org.formproc.form.
BasicFormElement
Set the write method.
SHARED_TYPE_VALIDATOR
- Static variable in class org.formproc.
FormManager
Keyword for shared validators (the keyword is "shared")
ShortConverter
- class org.formproc.conversion.
ShortConverter
.
TypeConverter which converts to a Short.
ShortConverter()
- Constructor for class org.formproc.conversion.
ShortConverter
skipNullValues
- Variable in class org.formproc.config.
AbstractFormConfiguration
store(FormElement, Object, Locale)
- Method in class org.formproc.
Form
Store the value for the named field in the target object.
store(Form, String, Object, Locale)
- Method in interface org.formproc.store.
Storer
Store the field data in the target object of the given form.
store(Form, String, Object, Locale)
- Method in class org.formproc.store.
ReflectionStorer
Store the field data in the target object.
store(Form, String, Object, Locale)
- Method in class org.formproc.store.
MapStorer
Store the field data in the target Map.
storeNullValues
- Variable in class org.formproc.config.
AbstractFormConfiguration
storer
- Variable in class org.formproc.config.
AbstractFormConfiguration
storer
- Variable in class org.formproc.form.
AbstractFormElement
Storer
- interface org.formproc.store.
Storer
.
Interface implemented by classes which can store the given field data in the target object.
submit()
- Method in class org.formproc.example.
ExampleApp
Submit the data in the fields.
T
toFormDataArray(FormData)
- Static method in class org.formproc.
FormUtilities
Convert a single FormData object into a FormData array with one element.
toFormElementArray(FormElement)
- Static method in class org.formproc.
FormUtilities
Convert a single FormElement object into a FormElement array with one element.
typeConverter
- Variable in class org.formproc.config.
AbstractFormConfiguration
typeConverter
- Variable in class org.formproc.form.
AbstractFormElement
TypeConverter
- interface org.formproc.conversion.
TypeConverter
.
Interface which must be implemented by all type converters.
U
User
- class org.formproc.example.
User
.
An example business object representing a user.
User()
- Constructor for class org.formproc.example.
User
UsernameValidator
- class org.formproc.example.
UsernameValidator
.
A custom validator which demonstrates how to add new validator classes to FormProc.
UsernameValidator()
- Constructor for class org.formproc.example.
UsernameValidator
V
valid
- Variable in class org.formproc.validation.
ValidationResult
validate(FormElement[], FormData[], Locale)
- Method in class org.formproc.example.
UsernameValidator
Validate the given FormData.
validate(FormElement[], FormData[], Locale)
- Method in class org.formproc.validation.
ValidatorGroup
Validate the given FormData.
validate(FormElement[], FormData[], Locale)
- Method in class org.formproc.validation.
Validator
Validate the given FormData array.
validate(FormElement[], FormData[], Locale)
- Method in class org.formproc.validation.
ScriptValidator
Validate the given FormData.
validate(FormElement[], FormData[], Locale)
- Method in class org.formproc.validation.
RuleValidator
Validate the given FormData array.
validate(FormElement[], FormData[], Locale)
- Method in class org.formproc.validation.
REValidator
Validate the given FormData array.
validate(FormElement[], FormData[], Locale)
- Method in class org.formproc.validation.
PassValidator
Validate the given FormData.
validate(FormElement, FormData, Locale)
- Method in class org.formproc.
Form
Validate the given form data.
validate(Object, Locale)
- Method in class org.formproc.example.
IsIntRule
Validate that the value is an integer
validate(Object, Locale)
- Method in interface org.formproc.validation.
Rule
Validate a particular value against a rule.
validateGroups(FormData[], Locale)
- Method in class org.formproc.
Form
Validate all of the FormElementGroups defined for this form.
validateNullValues
- Variable in class org.formproc.config.
AbstractFormConfiguration
ValidationResult
- class org.formproc.validation.
ValidationResult
.
Class which represents a form validation results.
ValidationResult(FormElement[], FormData[], Locale)
- Constructor for class org.formproc.validation.
ValidationResult
Construct a new ValidationResult object.
ValidationResult(FormElement[], FormData[], Locale, Validator)
- Constructor for class org.formproc.validation.
ValidationResult
Construct a new ValidationResult object.
ValidationResult(FormElement[], FormData[], Locale, Validator, boolean, Throwable)
- Constructor for class org.formproc.validation.
ValidationResult
Construct a ValidationResult object.
ValidationResult(FormElement[], FormData[], Locale, Validator, Throwable)
- Constructor for class org.formproc.validation.
ValidationResult
Construct a new ValidationResult object.
ValidationResultMap
- class org.formproc.validation.
ValidationResultMap
.
A map of field names to validation results.
ValidationResultMap()
- Constructor for class org.formproc.validation.
ValidationResultMap
validationResults
- Variable in class org.formproc.
Form
ValidationResultSet
- class org.formproc.validation.
ValidationResultSet
.
A set of ValidationResult objects.
ValidationResultSet()
- Constructor for class org.formproc.validation.
ValidationResultSet
validator
- Variable in class org.formproc.config.
AbstractFormConfiguration
validator
- Variable in class org.formproc.form.
AbstractFormElementGroup
validator
- Variable in class org.formproc.form.
AbstractFormElement
validator
- Variable in class org.formproc.validation.
ValidationResult
Validator
- class org.formproc.validation.
Validator
.
Base class for all validators.
Validator()
- Constructor for class org.formproc.validation.
Validator
Construct a new Validator.
ValidatorGroup
- class org.formproc.validation.
ValidatorGroup
.
A Validator which contains a list of child validators to be executed in order.
ValidatorGroup()
- Constructor for class org.formproc.validation.
ValidatorGroup
Construct a new ValidatorGroup.
ValidatorMapEntry
- class org.formproc.validation.
ValidatorMapEntry
.
Class representing a single validator map entry which has a reference to the validator class as well as system-wide properties for that validator.
ValidatorMapEntry(Class)
- Constructor for class org.formproc.validation.
ValidatorMapEntry
Construct a ValidatorMapEntry.
W
writeMethod
- Variable in class org.formproc.form.
AbstractFormElement
X
XMLFormConfiguration
- class org.formproc.config.
XMLFormConfiguration
.
This class represents configuration information for a single Form.
XMLFormConfiguration(FormManager)
- Constructor for class org.formproc.config.
XMLFormConfiguration
Construct a FormConfiguration object for the given FormManager.
A
B
C
D
E
F
G
H
I
L
M
N
O
P
Q
R
S
T
U
V
W
X
Overview
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
Copyright (c) 2001-2003 Anthony Eden. All Rights Reserved.