org.josef.web.jsf.validator

Class ZipCodeValidator

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.validator.AbstractValidator

org.josef.web.jsf.validator.ZipCodeValidator

All Implemented Interfaces:

EventListener, javax.faces.component.StateHolder, javax.faces.validator.Validator

public class ZipCodeValidator
extends AbstractValidator

A zip code validator that validates a zip code of a country.
Usage: <jf:zipCodeValidator country="Iso3166Country.COUNTRY" [message="User defined message]"/>
Where Iso3166Country.COUNTRY must be replaced with the proper country, for example: "NETHERLANDS".
message: Error message in case a validation error occurs. This message supports a single argument:
{0}=The zip code
In the absence of the message attribute, this validator will use a build in, standard error message.
Note: Make sure that you add the proper validation messages to JsfMessages.properties files for all supported countries.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

See Also:

ZipCodeOfCountry

Field Summary

Fields inherited from interface javax.faces.validator.Validator

NOT_IN_RANGE_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
ZipCodeValidator()

Method Summary

Modifier and Type	Method and Description
Iso3166Country	getCountry() Gets the country.
void	restoreState(javax.faces.context.FacesContext facesContext, Object state) Restores the state saved by saveState(FacesContext).
Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this validator.
void	setCountry(Iso3166Country country) Sets the country.
void	validate(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object zipCode) Validates the supplied zipCode.

Methods inherited from class org.josef.web.jsf.validator.AbstractValidator

getFormattedErrorMessage, getMessage, hasMessage, isComponentOfTypeUIInput, setMessage

Methods inherited from class org.josef.web.jsf.AbstractStateHolder

isTransient, setTransient

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipCodeValidator

public ZipCodeValidator()

Method Detail

getCountry

public Iso3166Country getCountry()

Gets the country.

Returns:

The country.

setCountry

public void setCountry(Iso3166Country country)

Sets the country.

Parameters:

country - The country.

validate

public void validate(javax.faces.context.FacesContext facesContext,
                     javax.faces.component.UIComponent component,
                     Object zipCode)

Validates the supplied zipCode.
In the following cases, no validation will take place:

• The supplied component is not of type UIInput
• The supplied zipCode is not of type String
• The supplied zipCode is null or empty
• The country is not null
• No ZipCodeOfCountry exists for the supplied country

Note: A missing value (null or empty) is not handled by this validator since it should be handled by the required attribute of the component.

Parameters:

facesContext - The FacesContext.

component - The component that needs to be validated.

zipCode - The zip code that needs to be validated.

Throws:

NullPointerException - When either the supplied facesContext or component is null.

javax.faces.validator.ValidatorException - When the supplied zipCode is not a valid zip code.

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Saves the state of this validator.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractValidator

Parameters:

facesContext - The FacesContext.

Returns:

The saved state of this validator.

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Restores the state saved by saveState(FacesContext).

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class AbstractValidator

Parameters:

facesContext - The FacesContext.

state - The state saved by saveState(FacesContext).