Source for org.jfree.xml.factory.objects.SimpleDateFormatObjectDescription

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  * 
  27:  * --------------------------
  28:  * LongObjectDescription.java
  29:  * --------------------------
  30:  * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: SimpleDateFormatObjectDescription.java,v 1.3 2005/11/14 11:04:12 mungady Exp $
  36:  *
  37:  * Changes (from 19-Feb-2003)
  38:  * -------------------------
  39:  * 19-Feb-2003 : Added standard header and Javadocs (DG);
  40:  * 29-Apr-2003 : Distilled from the JFreeReport project and moved into JCommon
  41:  *
  42:  */
  43: 
  44: package org.jfree.xml.factory.objects;
  45: 
  46: import java.text.DateFormatSymbols;
  47: import java.text.NumberFormat;
  48: import java.text.SimpleDateFormat;
  49: import java.util.Calendar;
  50: import java.util.Date;
  51: 
  52: /**
  53:  * An object-description for a <code>SimpleDateFormat</code> object.
  54:  *
  55:  * @author Thomas Morgner
  56:  */
  57: public class SimpleDateFormatObjectDescription extends BeanObjectDescription {
  58: 
  59:     /**
  60:      * Creates a new object description.
  61:      */
  62:     public SimpleDateFormatObjectDescription() {
  63:         this(SimpleDateFormat.class);
  64:     }
  65: 
  66:     /**
  67:      * Creates a new object description.
  68:      *
  69:      * @param className  the class.
  70:      */
  71:     public SimpleDateFormatObjectDescription(final Class className) {
  72:         this(className, true);
  73:     }
  74: 
  75:     /**
  76:      * Creates a new object description.
  77:      *
  78:      * @param className  the class.
  79:      * @param init  initialise?
  80:      */
  81:     public SimpleDateFormatObjectDescription(final Class className, final boolean init) {
  82:         super(className, false);
  83:         setParameterDefinition("2DigitYearStart", Date.class);
  84:         setParameterDefinition("calendar", Calendar.class);
  85:         setParameterDefinition("dateFormatSymbols", DateFormatSymbols.class);
  86:         setParameterDefinition("lenient", Boolean.TYPE);
  87:         setParameterDefinition("numberFormat", NumberFormat.class);
  88: //        setParameterDefinition("timeZone", TimeZone.class);
  89:         setParameterDefinition("localizedPattern", String.class);
  90:         setParameterDefinition("pattern", String.class);
  91:         ignoreParameter("localizedPattern");
  92:         ignoreParameter("pattern");
  93:     }
  94: 
  95:     /**
  96:      * Sets the parameters of this description object to match the supplied object.
  97:      *
  98:      * @param o  the object.
  99:      *
 100:      * @throws ObjectFactoryException if there is a problem while reading the
 101:      * properties of the given object.
 102:      */
 103:     public void setParameterFromObject(final Object o)
 104:         throws ObjectFactoryException {
 105:         super.setParameterFromObject(o);
 106:         final SimpleDateFormat format = (SimpleDateFormat) o;
 107:         setParameter("localizedPattern", format.toLocalizedPattern());
 108:         setParameter("pattern", format.toPattern());
 109:     }
 110: 
 111:     /**
 112:      * Creates an object based on this description.
 113:      *
 114:      * @return The object.
 115:      */
 116:     public Object createObject() {
 117:         final SimpleDateFormat format = (SimpleDateFormat) super.createObject();
 118:         if (getParameter("pattern") != null) {
 119:             format.applyPattern((String) getParameter("pattern"));
 120:         }
 121:         if (getParameter("localizedPattern") != null) {
 122:             format.applyLocalizedPattern((String) getParameter("localizedPattern"));
 123:         }
 124:         return format;
 125:     }
 126: 
 127: }