| package org.apache.turbine.services.intake.validator; |
| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2001-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" and |
| * "Apache Turbine" must not be used to endorse or promote products |
| * derived from this software without prior written permission. For |
| * written permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * "Apache Turbine", nor may "Apache" appear in their name, without |
| * prior written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| import java.text.DateFormat; |
| import java.text.ParseException; |
| import java.text.SimpleDateFormat; |
| |
| import java.util.ArrayList; |
| import java.util.Date; |
| import java.util.List; |
| import java.util.Map; |
| |
| import org.apache.commons.lang.StringUtils; |
| |
| import org.apache.turbine.services.intake.IntakeException; |
| |
| /** |
| * Validates numbers with the following constraints in addition to those |
| * listed in DefaultValidator. |
| * |
| * <table> |
| * <tr><th>Name</th><th>Valid Values</th><th>Default Value</th></tr> |
| * <tr><td>format</td><td>see SimpleDateFormat javadoc</td> |
| * <td> </td></tr> |
| * <tr><td>formatx</td><td>see SimpleDateFormat javadoc</td> |
| * <td> </td></tr> |
| * <tr><td colspan=3>where x is >= 1 to specify multiple date |
| * formats. Only one format rule should have a message</td></tr> |
| * <tr><td>flexible</td><td>true, as long as DateFormat can parse the date, |
| * allow it, and false</td> |
| * <td>false</td></tr> |
| * </table> |
| * |
| * @deprecated Use the Fulcrum Intake component instead. |
| * @author <a href="mailto:jmcnally@collab.net">John McNally</a> |
| * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a> |
| * @author <a href="mailto:Colin.Chalmers@maxware.nl">Colin Chalmers</a> |
| * @author <a href="mailto:jh@byteaction.de">Jürgen Hoffmann</a> |
| * @author <a href="mailto:seade@backstagetech.com.au">Scott Eade</a> |
| * @version $Id$ |
| */ |
| public class DateStringValidator |
| extends DefaultValidator |
| { |
| private static final String DEFAULT_DATE_MESSAGE = |
| "Date could not be parsed"; |
| |
| /** */ |
| private List dateFormats = null; |
| |
| /** */ |
| private String dateFormatMessage = null; |
| |
| /** */ |
| private boolean flexible = false; |
| |
| /** */ |
| private DateFormat df = null; |
| |
| /** */ |
| private SimpleDateFormat sdf = null; |
| |
| public DateStringValidator(Map paramMap) |
| throws IntakeException |
| { |
| init(paramMap); |
| } |
| |
| /** |
| * Default Constructor |
| */ |
| public DateStringValidator() |
| { |
| dateFormats = new ArrayList(5); |
| } |
| |
| /** |
| * Constructor to use when initialising Object |
| * |
| * @param paramMap |
| * @throws InvalidMaskException |
| */ |
| public void init(Map paramMap) |
| throws InvalidMaskException |
| { |
| super.init(paramMap); |
| |
| Constraint constraint = (Constraint) paramMap.get(FORMAT_RULE_NAME); |
| |
| if (constraint != null) |
| { |
| dateFormats.add(constraint.getValue()); |
| setDateFormatMessage(constraint.getMessage()); |
| } |
| |
| for(int i = 1 ;; i++) |
| { |
| constraint = (Constraint) paramMap.get(FORMAT_RULE_NAME + i); |
| |
| if (constraint == null) |
| { |
| break; // for |
| } |
| |
| dateFormats.add(constraint.getValue()); |
| setDateFormatMessage(constraint.getMessage()); |
| } |
| |
| if (StringUtils.isEmpty(dateFormatMessage)) |
| { |
| dateFormatMessage = DEFAULT_DATE_MESSAGE; |
| } |
| |
| constraint = (Constraint) paramMap.get(FLEXIBLE_RULE_NAME); |
| |
| if (constraint != null) |
| { |
| flexible = Boolean.valueOf(constraint.getValue()).booleanValue(); |
| } |
| |
| if (dateFormats.size() == 0) |
| { |
| df = DateFormat.getInstance(); |
| df.setLenient(flexible); |
| } |
| else |
| { |
| sdf = new SimpleDateFormat(); |
| sdf.setLenient(flexible); |
| } |
| } |
| |
| /** |
| * Determine whether a testValue meets the criteria specified |
| * in the constraints defined for this validator |
| * |
| * @param testValue a <code>String</code> to be tested |
| * @exception ValidationException containing an error message if the |
| * testValue did not pass the validation tests. |
| */ |
| public void assertValidity(String testValue) |
| throws ValidationException |
| { |
| super.assertValidity(testValue); |
| |
| if (required || StringUtils.isNotEmpty(testValue)) |
| { |
| try |
| { |
| parse(testValue); |
| } |
| catch (ParseException e) |
| { |
| errorMessage = dateFormatMessage; |
| throw new ValidationException(dateFormatMessage); |
| } |
| } |
| } |
| |
| /** |
| * Parses the String s according to the rules/formats for this validator. |
| * The formats provided by the "formatx" rules (where x is >= 1) are |
| * used <strong>before</strong> the "format" rules to allow for a display |
| * format that includes a 4 digit year, but that will parse the date using |
| * a format that accepts 2 digit years. |
| * |
| * @throws ParseException indicates that the string could not be |
| * parsed into a date. |
| */ |
| public Date parse(String s) |
| throws ParseException |
| { |
| Date date = null; |
| |
| if (s == null) |
| { |
| throw new ParseException("Input string was null", -1); |
| } |
| |
| for (int i = 1; i < dateFormats.size() && date == null; i++) |
| { |
| sdf.applyPattern((String) dateFormats.get(i)); |
| |
| try |
| { |
| date = sdf.parse(s); |
| } |
| catch (ParseException e) |
| { |
| // ignore |
| } |
| } |
| |
| if (date == null) |
| { |
| sdf.applyPattern((String) dateFormats.get(0)); |
| |
| try |
| { |
| date = sdf.parse(s); |
| } |
| catch (ParseException e) |
| { |
| // ignore |
| } |
| } |
| |
| if (date == null && df != null) |
| { |
| date = df.parse(s); |
| } |
| |
| // if the date still has not been parsed at this point, throw |
| // a ParseException. |
| if (date == null) |
| { |
| throw new ParseException("Could not parse the date", 0); |
| } |
| |
| return date; |
| } |
| |
| /** |
| * Formats a date into a String. The format used is from |
| * the first format rule found for the field. |
| * |
| * @param date the Date object to convert into a string. |
| * @return formatted date |
| */ |
| public String format(Date date) |
| { |
| String s = null; |
| if (date != null) |
| { |
| sdf.applyPattern((String) dateFormats.get(0)); |
| s = sdf.format(date); |
| } |
| return s; |
| } |
| |
| |
| // ************************************************************ |
| // ** Bean accessor methods ** |
| // ************************************************************ |
| |
| /** |
| * Get the value of minLengthMessage. |
| * |
| * @return value of minLengthMessage. |
| */ |
| public String getDateFormatMessage() |
| { |
| return dateFormatMessage; |
| } |
| |
| /** |
| * Only sets the message if the new message has some information. |
| * So the last setMessage call with valid data wins. But later calls |
| * with null or empty string will not affect a previous valid setting. |
| * |
| * @param message Value to assign to minLengthMessage. |
| */ |
| public void setDateFormatMessage(String message) |
| { |
| if (StringUtils.isNotEmpty(message)) |
| { |
| dateFormatMessage = message; |
| } |
| } |
| |
| /** |
| * Get the value of dateFormats. |
| * |
| * @return value of dateFormats. |
| */ |
| public List getDateFormats() |
| { |
| return dateFormats; |
| } |
| |
| /** |
| * Set the value of dateFormats. |
| * |
| * @param formats Value to assign to dateFormats. |
| */ |
| public void setDateFormats(List formats) |
| { |
| this.dateFormats = formats; |
| } |
| |
| /** |
| * Get the value of flexible. |
| * |
| * @return value of flexible. |
| */ |
| public boolean isFlexible() |
| { |
| return flexible; |
| } |
| |
| /** |
| * Set the value of flexible. |
| * |
| * @param flexible Value to assign to flexible. |
| */ |
| public void setFlexible(boolean flexible) |
| { |
| this.flexible = flexible; |
| } |
| } |
