org.josef.web.jsf.validator

Class DateRangeValidator

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.validator.AbstractValidator

org.josef.web.jsf.validator.DateRangeValidator

All Implemented Interfaces:

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

public class DateRangeValidator
extends AbstractValidator

A validator that validates that a date is within a certain range.
min: The minimum date (either a US date String or an actual Date)
max: The maximum date (either a US date String or an actual Date)
message: Error message in case a validation error occurs. This message supports three arguments:
{0}=The date to validate
{1}=The minimum date
{2}=The maximum date
In the absence of the message attribute, this validator will use a build in, standard error message.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Field Summary

Fields inherited from interface javax.faces.validator.Validator

NOT_IN_RANGE_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
DateRangeValidator()

Method Summary

Modifier and Type	Method and Description
Object	getMax() Gets the maximum date.
Object	getMin() Gets the minimum date.
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	setMax(Object maximumDate) Sets the maximum date.
void	setMin(Object minimumDate) Sets the minimum date.
void	validate(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, Object value) Validates that the supplied value is a date within the range [min ..max].

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

DateRangeValidator

public DateRangeValidator()

Method Detail

getMin

public Object getMin()

Gets the minimum date.

Returns:

The minimum date.

setMin

public void setMin(Object minimumDate)

Sets the minimum date.

Parameters:

minimumDate - The minimum date.
The type may either be a Date or a String. In the latter case the content must be a Date in US format (mm/dd/yyyy).

getMax

public Object getMax()

Gets the maximum date.

Returns:

The maximum date.

setMax

public void setMax(Object maximumDate)

Sets the maximum date.

Parameters:

maximumDate - The maximum date.
The type may either be a Date or a String. In the latter case the content must be a Date in US format (mm/dd/yyyy).

validate

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

Validates that the supplied value is a date within the range [min ..max].
In the following cases, no validation will take place:

• The supplied component is not of type UIInput
• The supplied value is null
• The supplied value is not of type Date

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.

uiComponent - The component that needs to be validated.

value - The date that needs to be validated.

Throws:

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

javax.faces.validator.ValidatorException - When the supplied value is not in the range: [min .. max]

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).