org.apache.tapestry.valid
Class DateValidator

java.lang.Object
  org.apache.tapestry.valid.BaseValidator
      org.apache.tapestry.valid.DateValidator

All Implemented Interfaces:

IValidator

public class DateValidator
extends BaseValidator

Provides input validation for strings treated as dates. In addition, allows a minimum and maximum date to be set.

Since:

1.0.8

Author:

Howard Lewis Ship

Field Summary

static DateFormat	DEFAULT_DATE_FORMAT
static String	DEFAULT_DISPLAY_FORMAT

Fields inherited from class org.apache.tapestry.valid.BaseValidator

FIELD_SYMBOL, FORM_SYMBOL, FUNCTION_SYMBOL, VALIDATOR_SYMBOL

Constructor Summary

DateValidator()

DateValidator(String initializer)
Initializes the DateValidator with properties defined by the initializer.

Method Summary

protected String	buildDateTooEarlyMessage(IFormComponent field, String earliestDate)
protected String	buildDateTooLateMessage(IFormComponent field, String latestDate)
protected String	buildInvalidDateFormatMessage(IFormComponent field)
String	getDateTooEarlyMessage()
String	getDateTooLateMessage()
String	getDisplayFormat()
String	getEffectiveDisplayFormat()
DateFormat	getEffectiveFormat()
DateFormat	getFormat()
String	getInvalidDateFormatMessage()
Date	getMaximum()
Date	getMinimum()
String	getScriptPath()
void	renderValidatorContribution(IFormComponent field, IMarkupWriter writer, IRequestCycle cycle) This implementation does nothing.
void	setDateTooEarlyMessage(String string) Overrides the bundle key date-too-early.
void	setDateTooLateMessage(String string) Overrides the bundle key date-too-late.
void	setDisplayFormat(String value)
void	setFormat(DateFormat value)
void	setInvalidDateFormatMessage(String string) Overrides the bundle key invalid-date-format.
void	setMaximum(Date maximum)
void	setMinimum(Date minimum)
void	setScriptPath(String scriptPath) Allows a developer to use the existing validation logic with a different client-side script.
Object	toObject(IFormComponent field, String value) Converts input, submitted by the client, into an object value.
String	toString(IFormComponent file, Object value) Invoked during rendering to convert an object value (which may be null) to a String.

Methods inherited from class org.apache.tapestry.valid.BaseValidator

buildRequiredMessage, checkRequired, formatString, formatString, formatString, getPattern, getRequiredMessage, isClientScriptingEnabled, isRequired, processValidatorScript, setClientScriptingEnabled, setRequired, setRequiredMessage, setScriptSource

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DISPLAY_FORMAT

public static final String DEFAULT_DISPLAY_FORMAT

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final DateFormat DEFAULT_DATE_FORMAT

Constructor Detail

DateValidator

public DateValidator()

DateValidator

public DateValidator(String initializer)

Initializes the DateValidator with properties defined by the initializer.

Since:

4.0

Method Detail

setFormat

public void setFormat(DateFormat value)

getFormat

public DateFormat getFormat()

getEffectiveFormat

public DateFormat getEffectiveFormat()

Returns:

the DateFormatthe validator will use, returning the default if no other date format is specified via setFormat(DateFormat)

Since:

3.0

getDisplayFormat

public String getDisplayFormat()

setDisplayFormat

public void setDisplayFormat(String value)

getEffectiveDisplayFormat

public String getEffectiveDisplayFormat()

Returns:

the display format message the validator will use, returning the default if no other display format message is specified. The default is the SimpleDateFormat.toPattern()for SimpleDateFormats, or "MM/DD/YYYY" for unknown DateFormatsubclasses.

Since:

3.0

toString

public String toString(IFormComponent file,
                       Object value)

Description copied from interface: IValidator

Invoked during rendering to convert an object value (which may be null) to a String. It is acceptible to return null. The string will be the VALUE attribute of the HTML text field.

toObject

public Object toObject(IFormComponent field,
                       String value)
                throws ValidatorException

Description copied from interface: IValidator

Converts input, submitted by the client, into an object value. May return null if the input is null (and the required flag is false).

The input string will already have been trimmed. It may be null.

Throws:

ValidatorException - if the string cannot be converted into an object, or the object is not valid (due to other constraints).

getMaximum

public Date getMaximum()

setMaximum

public void setMaximum(Date maximum)

getMinimum

public Date getMinimum()

setMinimum

public void setMinimum(Date minimum)

renderValidatorContribution

public void renderValidatorContribution(IFormComponent field,
                                        IMarkupWriter writer,
                                        IRequestCycle cycle)

Description copied from class: BaseValidator

This implementation does nothing. Subclasses may supply their own implementation.

Specified by:

renderValidatorContribution in interface IValidator

Overrides:

renderValidatorContribution in class BaseValidator

Since:

2.2

getScriptPath

public String getScriptPath()

Since:

2.2

setScriptPath

public void setScriptPath(String scriptPath)

Allows a developer to use the existing validation logic with a different client-side script. This is often sufficient to allow application-specific error presentation (perhaps by using DHTML to update the content of a <span> tag, or to use a more sophisticated pop-up window than window.alert()).

Since:

2.2

getDateTooEarlyMessage

public String getDateTooEarlyMessage()

Since:

3.0

getDateTooLateMessage

public String getDateTooLateMessage()

Since:

3.0

getInvalidDateFormatMessage

public String getInvalidDateFormatMessage()

Since:

3.0

buildInvalidDateFormatMessage

protected String buildInvalidDateFormatMessage(IFormComponent field)

Since:

3.0

buildDateTooEarlyMessage

protected String buildDateTooEarlyMessage(IFormComponent field,
                                          String earliestDate)

Since:

3.0 *

buildDateTooLateMessage

protected String buildDateTooLateMessage(IFormComponent field,
                                         String latestDate)

Since:

3.0

setDateTooEarlyMessage

public void setDateTooEarlyMessage(String string)

Overrides the bundle key date-too-early. Parameter {0} is the display name of the field. Parameter {1} is the earliest allowed date.

Since:

3.0

setDateTooLateMessage

public void setDateTooLateMessage(String string)

Overrides the bundle key date-too-late. Parameter {0} is the display name of the field. Parameter {1} is the latest allowed date.

Since:

3.0

setInvalidDateFormatMessage

public void setInvalidDateFormatMessage(String string)

Overrides the bundle key invalid-date-format. Parameter {0} is the display name of the field. Parameter {1} is the allowed format.

Since:

3.0