dk.heick.properties.types

Class DateTimePropertyType

java.lang.Object

dk.heick.properties.PropertyType<Date>

dk.heick.properties.types.DateTimePropertyType

All Implemented Interfaces:

Range<Date>, Serializable

public class DateTimePropertyType
extends PropertyType<Date>
implements Range<Date>

PropertyType that validates to a date value.
This type convert and validates a string to a java.util.Date.
The string value is trimmed before conversion.

This is uses the class java.text.SimpleDateFormat for parse the string to a date by the pattern provided in constructor.

Constructor Example			Comments
Property<Date> A_PROPERTY = new Property<Date>("name", new DateTimePropertyType());			Creates DateTimePropertyType with default SimpleDateFormat pattern "yyyy-MM-dd HH:mm:ss". No default value.
Property<Date> A_PROPERTY = new Property<Date>("name", new DateTimePropertyType("dd/MM yyyy HH:mm:ss"));			Creates DateTimePropertyType with default SimpleDateFormat pattern "dd/MM yyyy HH:mm:ss". No default value.
Property<Date> A_PROPERTY = new Property<Date>("name", DateTimePropertyType.createTimeType(new Date(1234)));			Creates DateTimePropertyType with default SimpleDateFormat pattern "HH:mm:ss". With default value "new Date(1234)".
Type of value(s)	Examples	Result	Comments
Valid	1973-11-28 19:30:59	new SimpleDateFormat("yyyy-MM-dd HH-mm-ss).format("1973-11-28 19:30:59")	Validate successfully.
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	«empty string»	null
Invalid	«empty string after trim»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.0

Author:

Frederik Heick

See Also:

SimpleDateFormat, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATE_FORMAT The default time pattern constant 'yyyyy-MM-dd'.
static String	DEFAULT_DATETIME_FORMAT The default date time pattern constant 'yyyy-MM-dd HH:mm:ss'.
static String	DEFAULT_TIME_FORMAT The default time pattern constant 'HH:mm:ss'.
static String	TYPE The type name string constant of DateTimePropertyType.

Constructor Summary

Constructors

Constructor and Description
DateTimePropertyType() Default constructor, initializes the with DEFAULT_DATETIME_FORMAT and null as default value.
DateTimePropertyType(Date defaultValue) Constructor, initializes the with DEFAULT_DATETIME_FORMAT.
DateTimePropertyType(Date minValue, Date maxValue) Constructor, initializes the with DEFAULT_DATETIME_FORMAT and default value is null.
DateTimePropertyType(Date defaultValue, Date minValue, Date maxValue) Constructor, initializes the with DEFAULT_DATETIME_FORMAT.
DateTimePropertyType(String dateFormatPattern) Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat.
DateTimePropertyType(String dateFormatPattern, Date defaultValue) Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat and a default value.
DateTimePropertyType(String dateFormatPattern, Date minValue, Date maxValue) Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat.
DateTimePropertyType(String dateFormatPattern, Date defaultValue, Date minValue, Date maxValue) Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat and a default value.

Method Summary

Modifier and Type	Method and Description
static DateTimePropertyType	createDatetimeType() Static factory which creates an instance with the default date time pattern.
static DateTimePropertyType	createDatetimeType(Date defaultValue) Static factory which creates an instance with the default date time pattern and a default Date if invalid property value.
static DateTimePropertyType	createDateType() Static factory which creates an instance with the default date pattern.
static DateTimePropertyType	createDateType(Date defaultValue) Static factory which creates an instance with the default date pattern and a default Date if invalid property value.
static DateTimePropertyType	createTimeType() Static factory which creates an instance with the default time pattern.
static DateTimePropertyType	createTimeType(Date defaultValue) Static factory which creates an instance with the default time pattern and a default Date if invalid property value.
String	getDateFormatPattern() The SimpleDateFormat pattern which the DateTimePropertyType instance is initialized with.
String	getFormattedDate(Date date) Format date using the type defined.
Date	getMaxValue() The maximum value (inclusive)
Date	getMinValue() The minimum value (inclusive)
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
boolean	isUseMaxValue() If there is a maximum limit.
boolean	isUseMinValue() If there is a minimum limit.
void	setDateFormatPattern(String dateFormatPattern) Sets the pattern for SimpleDateFormat and reinitialize the DateTimePropertyType with.
void	setMaxValue(Date maxValue) Sets the maximum limit (inclusive).
void	setMinValue(Date minValue) Sets the minimum limit (inclusive).
String	toString(String propertyName, Date t) Converts a typed to the string representation.
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
void	validateIsInRange(String propertyName, Date value) Validates that a value is inside the valid range of min and max value if defined.
void	validateMinMaxValues(String propertyName) Validates that minValue is less or equal to maxValue, must be called by validateConstraints, and if there is a default value that is inside the valid range.
Date	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toType, validate, validateNullType

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

The type name string constant of DateTimePropertyType.

See Also:

Constant Field Values

DEFAULT_DATETIME_FORMAT

public static final String DEFAULT_DATETIME_FORMAT

The default date time pattern constant 'yyyy-MM-dd HH:mm:ss'.

See Also:

SimpleDateFormat, Constant Field Values

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

The default time pattern constant 'yyyyy-MM-dd'.

See Also:

SimpleDateFormat, Constant Field Values

DEFAULT_TIME_FORMAT

public static final String DEFAULT_TIME_FORMAT

The default time pattern constant 'HH:mm:ss'.

See Also:

SimpleDateFormat, Constant Field Values

Constructor Detail

DateTimePropertyType

public DateTimePropertyType()

Default constructor, initializes the with DEFAULT_DATETIME_FORMAT and null as default value.

See Also:

DEFAULT_DATETIME_FORMAT

DateTimePropertyType

public DateTimePropertyType(Date defaultValue)

Constructor, initializes the with DEFAULT_DATETIME_FORMAT.

Parameters:

defaultValue - default value returned if property value is undefined.

See Also:

DEFAULT_DATETIME_FORMAT

DateTimePropertyType

public DateTimePropertyType(String dateFormatPattern)

Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat.
The default value is null.

Parameters:

dateFormatPattern - the pattern

See Also:

SimpleDateFormat

DateTimePropertyType

public DateTimePropertyType(String dateFormatPattern,
                            Date defaultValue)

Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat and a default value.

Parameters:

dateFormatPattern - the pattern

defaultValue - default value returned if property value is undefined.

DateTimePropertyType

public DateTimePropertyType(String dateFormatPattern,
                            Date defaultValue,
                            Date minValue,
                            Date maxValue)

Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat and a default value.

Parameters:

dateFormatPattern - the pattern

defaultValue - default value returned if property value is undefined.

minValue - the minimum value (Date) the value must have (inclusive), if null than no minimum limit.

maxValue - the maximum value (Date) the value must have (inclusive), if null than no maximum limit.

DateTimePropertyType

public DateTimePropertyType(Date defaultValue,
                            Date minValue,
                            Date maxValue)

Constructor, initializes the with DEFAULT_DATETIME_FORMAT.

Parameters:

defaultValue - default value returned if property value is undefined.

minValue - the minimum value (Date) the value must have (inclusive), if null than no minimum limit.

maxValue - the maximum value (Date) the value must have (inclusive), if null than no maximum limit.

See Also:

DEFAULT_DATETIME_FORMAT

DateTimePropertyType

public DateTimePropertyType(String dateFormatPattern,
                            Date minValue,
                            Date maxValue)

Constructor with a dateFormatPattern which upholds the pattern rules for SimpleDateFormat.
The default value is null.

Parameters:

dateFormatPattern - the pattern

minValue - the minimum value (Date) the value must have (inclusive), if null than no minimum limit.

maxValue - the maximum value (Date) the value must have (inclusive), if null than no maximum limit.

See Also:

SimpleDateFormat

DateTimePropertyType

public DateTimePropertyType(Date minValue,
                            Date maxValue)

Constructor, initializes the with DEFAULT_DATETIME_FORMAT and default value is null.

Parameters:

minValue - the minimum value (Date) the value must have (inclusive), if null than no minimum limit.

maxValue - the maximum value (Date) the value must have (inclusive), if null than no maximum limit.

Method Detail

createDatetimeType

public static DateTimePropertyType createDatetimeType()

Static factory which creates an instance with the default date time pattern.

Returns:

a DateTimePropertyType with DEFAULT_DATETIME_FORMAT as SimpleDateFormat pattern.

See Also:

SimpleDateFormat, DEFAULT_DATETIME_FORMAT

createDateType

public static DateTimePropertyType createDateType()

Static factory which creates an instance with the default date pattern.

Returns:

a DateTimePropertyType with DEFAULT_DATE_FORMAT as SimpleDateFormat pattern.

See Also:

SimpleDateFormat, DEFAULT_DATE_FORMAT

createTimeType

public static DateTimePropertyType createTimeType()

Static factory which creates an instance with the default time pattern.

Returns:

a DateTimePropertyType with DEFAULT_TIME_FORMAT as SimpleDateFormat pattern.

See Also:

SimpleDateFormat, DEFAULT_TIME_FORMAT

createDatetimeType

public static DateTimePropertyType createDatetimeType(Date defaultValue)

Static factory which creates an instance with the default date time pattern and a default Date if invalid property value.

Parameters:

defaultValue - default value returned if property value is undefined.

Returns:

a DateTimePropertyType with DEFAULT_DATETIME_FORMAT as SimpleDateFormat pattern.

See Also:

SimpleDateFormat, DEFAULT_DATETIME_FORMAT

createDateType

public static DateTimePropertyType createDateType(Date defaultValue)

Static factory which creates an instance with the default date pattern and a default Date if invalid property value.

Parameters:

defaultValue - default value returned if property value is undefined.

Returns:

a DateTimePropertyType with DEFAULT_DATE_FORMAT as SimpleDateFormat pattern.

See Also:

SimpleDateFormat, DEFAULT_DATE_FORMAT

createTimeType

public static DateTimePropertyType createTimeType(Date defaultValue)

Static factory which creates an instance with the default time pattern and a default Date if invalid property value.

Parameters:

defaultValue - default value returned if property value is undefined.

Returns:

a DateTimePropertyType with DEFAULT_TIME_FORMAT as SimpleDateFormat pattern.

See Also:

SimpleDateFormat, DEFAULT_TIME_FORMAT

getDateFormatPattern

public String getDateFormatPattern()

The SimpleDateFormat pattern which the DateTimePropertyType instance is initialized with.

Returns:

the pattern.

setDateFormatPattern

public void setDateFormatPattern(String dateFormatPattern)

Sets the pattern for SimpleDateFormat and reinitialize the DateTimePropertyType with.

Parameters:

dateFormatPattern - the pattern

toString

public String toString(String propertyName,
                       Date t)
                throws PropertyException

Description copied from class: PropertyType

Converts a typed to the string representation. This must be associative, so the string generate here will successful validate. This is enforced, so the converted string is sub sequencetially validate with the validate method. In some of the property sub types, this method is overridden to ensure above rule.

Overrides:

toString in class PropertyType<Date>

Parameters:

propertyName - the name of the property used for logging purposes.

t - the type T.

Returns:

The string representation of the type.

Throws:

PropertyException - if conversion failed in validation.

See Also:

PropertyType.validate(String, String)

validateValue

public Date validateValue(String propertyName,
                          String value)
                   throws PropertyException

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<Date>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Description copied from class: PropertyType

A PropertyType can have some constraints here is where they are validated.
The constraints of a PropertyType is always assumed to be valid, but what if they are not.
Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully.
This is the method where we validate the constraints of a PropertyType before any value is actually validated.
Any many cases this will not be nessecary.
This method is call in Property.validate();

Overrides:

validateConstraints in class PropertyType<Date>

Parameters:

propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues.

Throws:

PropertyException - if the constraints have invalid/conflicting values.

See Also:

Property.validate()

getFormattedDate

public final String getFormattedDate(Date date)

Format date using the type defined. format

Parameters:

date - a date to format.

Returns:

a date formatted to String using the format defined in the type.

Since:

1.6

getRestrictions

public List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getRestrictions in class PropertyType<Date>

Returns:

the restrictions of the PropertyType as a list of strings.

setMinValue

public void setMinValue(Date minValue)

Description copied from interface: Range

Sets the minimum limit (inclusive).

Specified by:

setMinValue in interface Range<Date>

Parameters:

minValue - the minimum limit, if null than no limit.

setMaxValue

public void setMaxValue(Date maxValue)

Description copied from interface: Range

Sets the maximum limit (inclusive).

Specified by:

setMaxValue in interface Range<Date>

Parameters:

maxValue - the maximum limit, if null than no limit.

getMinValue

public Date getMinValue()

Description copied from interface: Range

The minimum value (inclusive)

Specified by:

getMinValue in interface Range<Date>

Returns:

the minimum value, if null than no minimum limit.

getMaxValue

public Date getMaxValue()

Description copied from interface: Range

The maximum value (inclusive)

Specified by:

getMaxValue in interface Range<Date>

Returns:

the maximum value, if null than no minimum limit.

isUseMinValue

public boolean isUseMinValue()

Description copied from interface: Range

If there is a minimum limit.

Specified by:

isUseMinValue in interface Range<Date>

Returns:

true if getMinValue() differs from null, otherwise false.

isUseMaxValue

public boolean isUseMaxValue()

Description copied from interface: Range

If there is a maximum limit.

Specified by:

isUseMaxValue in interface Range<Date>

Returns:

true if getMaxValue() differs from null, otherwise false.

validateIsInRange

public void validateIsInRange(String propertyName,
                              Date value)
                       throws PropertyException

Description copied from interface: Range

Validates that a value is inside the valid range of min and max value if defined.

Specified by:

validateIsInRange in interface Range<Date>

Parameters:

propertyName - the property

value - the value

Throws:

PropertyException - if minValue is not null and value is less than, or maxValue is not null and value is greather than.

See Also:

PropertyType.validateValue(String, String)

validateMinMaxValues

public void validateMinMaxValues(String propertyName)
                          throws PropertyException

Description copied from interface: Range

Validates that minValue is less or equal to maxValue, must be called by validateConstraints, and if there is a default value that is inside the valid range.

Specified by:

validateMinMaxValues in interface Range<Date>

Parameters:

propertyName - the name of the property.

Throws:

PropertyException - if minValue is greather than maxValue.

See Also:

PropertyType.validateConstraints(String)