uk.ac.ed.epcc.webapp.forms.inputs

Class AbstractDateInput

java.lang.Object

uk.ac.ed.epcc.webapp.forms.inputs.BaseInput<V>

uk.ac.ed.epcc.webapp.forms.inputs.AbstractInput<V>

uk.ac.ed.epcc.webapp.forms.inputs.ParseAbstractInput<java.util.Date>

uk.ac.ed.epcc.webapp.forms.inputs.AbstractDateInput

All Implemented Interfaces:

BoundedDateInput, BoundedInput<java.util.Date>, FormatHintInput, HTML5Input, Input<java.util.Date>, LengthInput<java.util.Date>, ParseInput<java.util.Date>

Direct Known Subclasses:

DateInput, TimeStampInput

public abstract class AbstractDateInput
extends ParseAbstractInput<java.util.Date>
implements BoundedDateInput, FormatHintInput

A abstract superclass for text Inputs that parse to java Date objects. sub-classes may be constrained to generate values that are constrained to day/hour/min boundaries. This class uses a series of DateFormats applied in turn so as to support multiple formats the first format should be the one compatible with the format defined in the standard for the corresponding Html5 input. However getHintIndex() specifies the format that should be suggested to a user when defaulting to a text input

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Date	DEFAULT_MAX_DATE

Fields inherited from class uk.ac.ed.epcc.webapp.forms.inputs.BaseInput

validators

Fields inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.BoundedDateInput

USE_DATE_INPUT

Constructor Summary

Constructors

Constructor and Description
AbstractDateInput()
AbstractDateInput(long resolution)

Method Summary

Modifier and Type	Method and Description
java.util.Date	convert(java.lang.Object v) Perform any supported type conversions to to generate a value of the target type
java.lang.String	formatRange(java.util.Date n) format step/range values as used by the input into compatible to the way they are presented.
protected java.text.DateFormat	getDateFormat(java.lang.String format)
java.lang.String	getFormatHint()
abstract java.lang.String[]	getFormats()
protected int	getHintIndex() Which of the available formats in getFormats() should be used as the hint text.
java.util.Date	getMax() Maximum valid value null value implies no maximum
java.util.Date	getMin() Minimum valid value.
java.lang.String	getString(java.util.Date date) simple format of a date
java.lang.String	getType() get the type tag to emit for the corresponding html5 type.
java.util.Date	parseValue(java.lang.String v) Parse a String into the correct type for this input.
java.util.Date	setMax(java.util.Date val) set the maximum value
java.util.Date	setMin(java.util.Date val) Set the minimum value

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.ParseAbstractInput

accept, getBoxWidth, getMaxResultLength, getSingle, setBoxWidth, setMaxResultLength, setSingle

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.AbstractInput

getValue, setKey, setValue

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.BaseInput

addValidator, getKey, getPrettyString, getString, removeValidator, validate, validateInner

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.BoundedDateInput

getInstance, getInstance

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.ParseInput

getString, parse

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.Input

accept, addValidator, getKey, getPrettyString, getValue, isEmpty, removeValidator, setKey, setValue, validate

Field Detail

DEFAULT_MAX_DATE

public static final java.util.Date DEFAULT_MAX_DATE

Constructor Detail

AbstractDateInput

public AbstractDateInput()

AbstractDateInput

public AbstractDateInput(long resolution)

Method Detail

getDateFormat

protected java.text.DateFormat getDateFormat(java.lang.String format)

getFormats

public abstract java.lang.String[] getFormats()

parseValue

public java.util.Date parseValue(java.lang.String v)
                          throws ParseException

Description copied from interface: ParseInput

Parse a String into the correct type for this input. This must be compatible with the Input.getString(Object) method.

Specified by:

parseValue in interface ParseInput<java.util.Date>

Parameters:

v -

Returns:

Throws:

ParseException

getString

public java.lang.String getString(java.util.Date date)

simple format of a date

Specified by:

getString in interface Input<java.util.Date>

Overrides:

getString in class BaseInput<java.util.Date>

Parameters:

date - Date to format

Returns:

String in DD-MM-YYY format or null if passed null

See Also:

ParseInput

getHintIndex

protected int getHintIndex()

Which of the available formats in getFormats() should be used as the hint text.

Returns:

getFormatHint

public java.lang.String getFormatHint()

Specified by:

getFormatHint in interface FormatHintInput

convert

public java.util.Date convert(java.lang.Object v)
                       throws TypeError

Description copied from interface: Input

Perform any supported type conversions to to generate a value of the target type

Specified by:

convert in interface Input<java.util.Date>

Overrides:

convert in class BaseInput<java.util.Date>

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

getType

public java.lang.String getType()

Description copied from interface: HTML5Input

get the type tag to emit for the corresponding html5 type. If this method returns null no type should be used. This is for the case where. a sub-class breaks compatibility and needs to supress a type set in a superclass.

Specified by:

getType in interface HTML5Input

Returns:

name or null;

getMin

public java.util.Date getMin()

Description copied from interface: BoundedInput

Minimum valid value. null value implies no minimum.

Specified by:

getMin in interface BoundedInput<java.util.Date>

Returns:

T

getMax

public java.util.Date getMax()

Description copied from interface: BoundedInput

Maximum valid value null value implies no maximum

Specified by:

getMax in interface BoundedInput<java.util.Date>

Returns:

T

setMin

public java.util.Date setMin(java.util.Date val)

Description copied from interface: BoundedInput

Set the minimum value

Specified by:

setMin in interface BoundedInput<java.util.Date>

Returns:

previous limit

setMax

public java.util.Date setMax(java.util.Date val)

Description copied from interface: BoundedInput

set the maximum value

Specified by:

setMax in interface BoundedInput<java.util.Date>

Returns:

previous limit

formatRange

public java.lang.String formatRange(java.util.Date n)

Description copied from interface: BoundedInput

format step/range values as used by the input into compatible to the way they are presented. for example a percent input may use 0.0 and 1.0 but present as 0, 100 used to generate HTML5 ranges.

Specified by:

formatRange in interface BoundedInput<java.util.Date>

Returns: