com.sptci.echo.binding

Class ViewValidator<V>

java.lang.Object

com.sptci.echo.binding.ViewValidator<V>

Type Parameters:

V - The class name of the view being validated.

Direct Known Subclasses:

JDOViewValidator

public class ViewValidator<V>
extends Object

A standard validator for view components. Processes annotations for components of the specified view and applies standard validation rules.

© Copyright 2008 Sans Pareil Technologies, Inc.

Version:

$Id: ViewValidator.java 4553 2008-12-24 10:34:16Z rakesh $

Author:

Rakesh Vidyadharan 2008-04-18

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Field>	fields The map of all fields in view.
protected V	view The view whose child components are to be validated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ViewValidator() Default constructor.
	ViewValidator(V view) Create a new instance of the validator for the specified view.

Method Summary

Modifier and Type	Method and Description
protected void	checkConfirm(String value, Constraints constraint, String name, Collection<String> messages) Check a secondary field value with the value for equality.
protected void	checkText(String text, String name, Collection<String> messages) Check the specified text for non-null.
protected void	processListComponent(AbstractListComponent component, Constraints constraint, String name, Collection<String> messages) Check the specified list component and ensure that at least one value is selected if annotated as mandatory.
protected void	processRegex(Constraints constraint, String value, String name, Collection<String> messages) Process the Constraints.regex() value and apply to the value in the field.
protected void	processTextComponent(TextComponent component, Constraints constraint, String name, Collection<String> messages) Process a TextComponent against its annotated constraints.
Collection<String>	validate() Perform the validation on the child components.

Methods inherited from class java.lang.Object

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

Field Detail

view

protected final V view

The view whose child components are to be validated.

fields

protected final Map<String,Field> fields

The map of all fields in view.

Constructor Detail

ViewValidator

protected ViewValidator()

Default constructor. Cannot be directly invoked.

ViewValidator

public ViewValidator(V view)

Create a new instance of the validator for the specified view.

Parameters:

view - The view to be validated.

Method Detail

validate

public Collection<String> validate()

Perform the validation on the child components. Passes back a collection of localised messages based on failure of validation. An empty collection indicates successful validation.

Returns:

A collection of messages that indicate failure(s) of validation for the child components.

See Also:

processTextComponent(nextapp.echo.app.text.TextComponent, com.sptci.echo.annotation.Constraints, java.lang.String, java.util.Collection<java.lang.String>), processListComponent(nextapp.echo.app.list.AbstractListComponent, com.sptci.echo.annotation.Constraints, java.lang.String, java.util.Collection<java.lang.String>)

processTextComponent

protected void processTextComponent(TextComponent component,
                                    Constraints constraint,
                                    String name,
                                    Collection<String> messages)

Process a TextComponent against its annotated constraints.

Parameters:

component - The text component being validated.

constraint - The annotated constraint.

name - The name of the field in view that is being processed.

messages - The collection to which any localised error messages are added.

See Also:

checkText(java.lang.String, java.lang.String, java.util.Collection<java.lang.String>), processRegex(com.sptci.echo.annotation.Constraints, java.lang.String, java.lang.String, java.util.Collection<java.lang.String>)

checkText

protected void checkText(String text,
                         String name,
                         Collection<String> messages)

Check the specified text for non-null. Also checks against empty string. If the check fails, a localised error message is added to the messages collection. The localised message is retrieved using the following name:

   <View.getClass().getName()>.<field name>.empty.error
 

Parameters:

text - The text value that is to be checked.

name - The name of the field in view that is being checked.

messages - The collection to which error messages will be added as appropriate.

See Also:

checkConfirm(java.lang.String, com.sptci.echo.annotation.Constraints, java.lang.String, java.util.Collection<java.lang.String>)

checkConfirm

protected void checkConfirm(String value,
                            Constraints constraint,
                            String name,
                            Collection<String> messages)

Check a secondary field value with the value for equality. If the check fails a localised message is added to the messages collection. The localised message is retrieved using the following name:

   <View.getClass().getName()>.<name>.confirm.error
 

Parameters:

value - The value in the field that is to be checked.

constraint - The annotated constraint for the field.

name - The name of the field.

messages - The collection to which error messages will be added.

processRegex

protected void processRegex(Constraints constraint,
                            String value,
                            String name,
                            Collection<String> messages)

Process the Constraints.regex() value and apply to the value in the field. If the regex does not match the value, a localised message is added to the messages collection. The localised message is retrieved using the following name:

   <View.getClass().getName()>.<field name>.regex.error
 

Parameters:

constraint - The annotatated constraint for the field being processed.

value - The value in the field that is being validated.

name - The name of the field in view that is being checked.

messages - The collection to which any localised error messages are added.

processListComponent

protected void processListComponent(AbstractListComponent component,
                                    Constraints constraint,
                                    String name,
                                    Collection<String> messages)

Check the specified list component and ensure that at least one value is selected if annotated as mandatory. If the check fails, a localised error message is added to the messages collection. The localised message is retrieved using the following name:

   <View.getClass().getName()>.<field name>.empty.error
 

Parameters:

component - The list component that is to be checked.

constraint - The annotated constraint on the list component.

name - The name of the field in view that is being checked.

messages - The collection to which error message will be added as appropriate.