org.apache.commons.validator.routines.AbstractCalendarValidator Maven / Gradle / Ivy
Show all versions of commons-validator Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.validator.routines;
import java.text.DateFormatSymbols;
import java.text.Format;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Locale;
import java.util.TimeZone;
/**
* Abstract class for Date/Time/Calendar validation.
*
* This is a base class for building Date / Time
* Validators using format parsing.
*
* @version $Revision: 1739356 $
* @since Validator 1.3.0
*/
public abstract class AbstractCalendarValidator extends AbstractFormatValidator {
private static final long serialVersionUID = -1410008585975827379L;
private final int dateStyle;
private final int timeStyle;
/**
* Construct an instance with the specified strict,
* time and date style parameters.
*
* @param strict true if strict
* Format parsing should be used.
* @param dateStyle the date style to use for Locale validation.
* @param timeStyle the time style to use for Locale validation.
*/
public AbstractCalendarValidator(boolean strict, int dateStyle, int timeStyle) {
super(strict);
this.dateStyle = dateStyle;
this.timeStyle = timeStyle;
}
/**
* Validate using the specified Locale.
*
* @param value The value validation is being performed on.
* @param pattern The pattern used to format the value.
* @param locale The locale to use for the Format, defaults to the default
* @return true if the value is valid.
*/
@Override
public boolean isValid(String value, String pattern, Locale locale) {
Object parsedValue = parse(value, pattern, locale, (TimeZone)null);
return (parsedValue == null ? false : true);
}
/**
*
Format an object into a String using
* the default Locale.
*
* @param value The value validation is being performed on.
* @param timeZone The Time Zone used to format the date,
* system default if null (unless value is a Calendar.
* @return The value formatted as a String.
*/
public String format(Object value, TimeZone timeZone) {
return format(value, (String)null, (Locale)null, timeZone);
}
/**
* Format an object into a String using
* the specified pattern.
*
* @param value The value validation is being performed on.
* @param pattern The pattern used to format the value.
* @param timeZone The Time Zone used to format the date,
* system default if null (unless value is a Calendar.
* @return The value formatted as a String.
*/
public String format(Object value, String pattern, TimeZone timeZone) {
return format(value, pattern, (Locale)null, timeZone);
}
/**
* Format an object into a String using
* the specified Locale.
*
* @param value The value validation is being performed on.
* @param locale The locale to use for the Format.
* @param timeZone The Time Zone used to format the date,
* system default if null (unless value is a Calendar.
* @return The value formatted as a String.
*/
public String format(Object value, Locale locale, TimeZone timeZone) {
return format(value, (String)null, locale, timeZone);
}
/**
* Format an object using the specified pattern and/or
* Locale.
*
* @param value The value validation is being performed on.
* @param pattern The pattern used to format the value.
* @param locale The locale to use for the Format.
* @return The value formatted as a String.
*/
@Override
public String format(Object value, String pattern, Locale locale) {
return format(value, pattern, locale, (TimeZone)null);
}
/**
*
Format an object using the specified pattern and/or
* Locale.
*
* @param value The value validation is being performed on.
* @param pattern The pattern used to format the value.
* @param locale The locale to use for the Format.
* @param timeZone The Time Zone used to format the date,
* system default if null (unless value is a Calendar.
* @return The value formatted as a String.
*/
public String format(Object value, String pattern, Locale locale, TimeZone timeZone) {
DateFormat formatter = (DateFormat)getFormat(pattern, locale);
if (timeZone != null) {
formatter.setTimeZone(timeZone);
} else if (value instanceof Calendar) {
formatter.setTimeZone(((Calendar)value).getTimeZone());
}
return format(value, formatter);
}
/**
*
Format a value with the specified DateFormat.
*
* @param value The value to be formatted.
* @param formatter The Format to use.
* @return The formatted value.
*/
@Override
protected String format(Object value, Format formatter) {
if (value == null) {
return null;
} else if (value instanceof Calendar) {
value = ((Calendar)value).getTime();
}
return formatter.format(value);
}
/**
* Checks if the value is valid against a specified pattern.
*
* @param value The value validation is being performed on.
* @param pattern The pattern used to validate the value against, or the
* default for the Locale if null.
* @param locale The locale to use for the date format, system default if null.
* @param timeZone The Time Zone used to parse the date, system default if null.
* @return The parsed value if valid or null if invalid.
*/
protected Object parse(String value, String pattern, Locale locale, TimeZone timeZone) {
value = (value == null ? null : value.trim());
if (value == null || value.length() == 0) {
return null;
}
DateFormat formatter = (DateFormat)getFormat(pattern, locale);
if (timeZone != null) {
formatter.setTimeZone(timeZone);
}
return parse(value, formatter);
}
/**
* Process the parsed value, performing any further validation
* and type conversion required.
*
* @param value The parsed object created.
* @param formatter The Format used to parse the value with.
* @return The parsed value converted to the appropriate type
* if valid or null if invalid.
*/
@Override
protected abstract Object processParsedValue(Object value, Format formatter);
/**
* Returns a DateFormat for the specified pattern
* and/or Locale.
*
* @param pattern The pattern used to validate the value against or
* null to use the default for the Locale.
* @param locale The locale to use for the currency format, system default if null.
* @return The DateFormat to created.
*/
@Override
protected Format getFormat(String pattern, Locale locale) {
DateFormat formatter = null;
boolean usePattern = (pattern != null && pattern.length() > 0);
if (!usePattern) {
formatter = (DateFormat)getFormat(locale);
} else if (locale == null) {
formatter = new SimpleDateFormat(pattern);
} else {
DateFormatSymbols symbols = new DateFormatSymbols(locale);
formatter = new SimpleDateFormat(pattern, symbols);
}
formatter.setLenient(false);
return formatter;
}
/**
* Returns a DateFormat for the specified Locale.
*
* @param locale The locale a DateFormat is required for,
* system default if null.
* @return The DateFormat to created.
*/
protected Format getFormat(Locale locale) {
DateFormat formatter = null;
if (dateStyle >= 0 && timeStyle >= 0) {
if (locale == null) {
formatter = DateFormat.getDateTimeInstance(dateStyle, timeStyle);
} else {
formatter = DateFormat.getDateTimeInstance(dateStyle, timeStyle, locale);
}
} else if (timeStyle >= 0) {
if (locale == null) {
formatter = DateFormat.getTimeInstance(timeStyle);
} else {
formatter = DateFormat.getTimeInstance(timeStyle, locale);
}
} else {
int useDateStyle = dateStyle >= 0 ? dateStyle : DateFormat.SHORT;
if (locale == null) {
formatter = DateFormat.getDateInstance(useDateStyle);
} else {
formatter = DateFormat.getDateInstance(useDateStyle, locale);
}
}
formatter.setLenient(false);
return formatter;
}
/**
* Compares a calendar value to another, indicating whether it is
* equal, less then or more than at a specified level.
*
* @param value The Calendar value.
* @param compare The Calendar to check the value against.
* @param field The field level to compare to - e.g. specifying
* Calendar.MONTH will compare the year and month
* portions of the calendar.
* @return Zero if the first value is equal to the second, -1
* if it is less than the second or +1 if it is greater than the second.
*/
protected int compare(Calendar value, Calendar compare, int field) {
int result = 0;
// Compare Year
result = calculateCompareResult(value, compare, Calendar.YEAR);
if (result != 0 || field == Calendar.YEAR) {
return result;
}
// Compare Week of Year
if (field == Calendar.WEEK_OF_YEAR) {
return calculateCompareResult(value, compare, Calendar.WEEK_OF_YEAR);
}
// Compare Day of the Year
if (field == Calendar.DAY_OF_YEAR) {
return calculateCompareResult(value, compare, Calendar.DAY_OF_YEAR);
}
// Compare Month
result = calculateCompareResult(value, compare, Calendar.MONTH);
if (result != 0 || field == Calendar.MONTH) {
return result;
}
// Compare Week of Month
if (field == Calendar.WEEK_OF_MONTH) {
return calculateCompareResult(value, compare, Calendar.WEEK_OF_MONTH);
}
// Compare Date
result = calculateCompareResult(value, compare, Calendar.DATE);
if (result != 0 || (field == Calendar.DATE ||
field == Calendar.DAY_OF_WEEK ||
field == Calendar.DAY_OF_WEEK_IN_MONTH)) {
return result;
}
// Compare Time fields
return compareTime(value, compare, field);
}
/**
* Compares a calendar time value to another, indicating whether it is
* equal, less then or more than at a specified level.
*
* @param value The Calendar value.
* @param compare The Calendar to check the value against.
* @param field The field level to compare to - e.g. specifying
* Calendar.MINUTE will compare the hours and minutes
* portions of the calendar.
* @return Zero if the first value is equal to the second, -1
* if it is less than the second or +1 if it is greater than the second.
*/
protected int compareTime(Calendar value, Calendar compare, int field) {
int result = 0;
// Compare Hour
result = calculateCompareResult(value, compare, Calendar.HOUR_OF_DAY);
if (result != 0 || (field == Calendar.HOUR || field == Calendar.HOUR_OF_DAY)) {
return result;
}
// Compare Minute
result = calculateCompareResult(value, compare, Calendar.MINUTE);
if (result != 0 || field == Calendar.MINUTE) {
return result;
}
// Compare Second
result = calculateCompareResult(value, compare, Calendar.SECOND);
if (result != 0 || field == Calendar.SECOND) {
return result;
}
// Compare Milliseconds
if (field == Calendar.MILLISECOND) {
return calculateCompareResult(value, compare, Calendar.MILLISECOND);
}
throw new IllegalArgumentException("Invalid field: " + field);
}
/**
* Compares a calendar's quarter value to another, indicating whether it is
* equal, less then or more than the specified quarter.
*
* @param value The Calendar value.
* @param compare The Calendar to check the value against.
* @param monthOfFirstQuarter The month that the first quarter starts.
* @return Zero if the first quarter is equal to the second, -1
* if it is less than the second or +1 if it is greater than the second.
*/
protected int compareQuarters(Calendar value, Calendar compare, int monthOfFirstQuarter) {
int valueQuarter = calculateQuarter(value, monthOfFirstQuarter);
int compareQuarter = calculateQuarter(compare, monthOfFirstQuarter);
if (valueQuarter < compareQuarter) {
return -1;
} else if (valueQuarter > compareQuarter) {
return 1;
} else {
return 0;
}
}
/**
* Calculate the quarter for the specified Calendar.
*
* @param calendar The Calendar value.
* @param monthOfFirstQuarter The month that the first quarter starts.
* @return The calculated quarter.
*/
private int calculateQuarter(Calendar calendar, int monthOfFirstQuarter) {
// Add Year
int year = calendar.get(Calendar.YEAR);
int month = (calendar.get(Calendar.MONTH) + 1);
int relativeMonth = (month >= monthOfFirstQuarter)
? (month - monthOfFirstQuarter)
: (month + (12 - monthOfFirstQuarter)); // CHECKSTYLE IGNORE MagicNumber
int quarter = ((relativeMonth / 3) + 1); // CHECKSTYLE IGNORE MagicNumber
// adjust the year if the quarter doesn't start in January
if (month < monthOfFirstQuarter) {
--year;
}
return (year * 10) + quarter; // CHECKSTYLE IGNORE MagicNumber
}
/**
* Compares the field from two calendars indicating whether the field for the
* first calendar is equal to, less than or greater than the field from the
* second calendar.
*
* @param value The Calendar value.
* @param compare The Calendar to check the value against.
* @param field The field to compare for the calendars.
* @return Zero if the first calendar's field is equal to the seconds, -1
* if it is less than the seconds or +1 if it is greater than the seconds.
*/
private int calculateCompareResult(Calendar value, Calendar compare, int field) {
int difference = value.get(field) - compare.get(field);
if (difference < 0) {
return -1;
} else if (difference > 0) {
return 1;
} else {
return 0;
}
}
}