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

   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:  * DateObjectDescription.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: DateObjectDescription.java,v 1.4 2005/11/14 11:01:31 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.util.Calendar;
  47: import java.util.Date;
  48: import java.util.GregorianCalendar;
  49: 
  50: /**
  51:  * An object-description for a <code>Date</code> object.
  52:  *
  53:  * @author Thomas Morgner
  54:  */
  55: public class DateObjectDescription extends AbstractObjectDescription {
  56: 
  57:     /**
  58:      * Creates a new object description.
  59:      */
  60:     public DateObjectDescription() {
  61:         super(Date.class);
  62:         setParameterDefinition("year", Integer.class);
  63:         setParameterDefinition("month", Integer.class);
  64:         setParameterDefinition("day", Integer.class);
  65:     }
  66: 
  67:     /**
  68:      * Creates an object based on this description.
  69:      *
  70:      * @return The object.
  71:      */
  72:     public Object createObject() {
  73:         final int y = getIntParameter("year");
  74:         final int m = getIntParameter("month");
  75:         final int d = getIntParameter("day");
  76: 
  77:         return new GregorianCalendar(y, m, d).getTime();
  78:     }
  79: 
  80:     /**
  81:      * Returns a parameter value as an <code>int</code>.
  82:      *
  83:      * @param param  the parameter name.
  84:      *
  85:      * @return The parameter value.
  86:      */
  87:     private int getIntParameter(final String param) {
  88:         final Integer p = (Integer) getParameter(param);
  89:         if (p == null) {
  90:             return 0;
  91:         }
  92:         return p.intValue();
  93:     }
  94: 
  95:     /**
  96:      * Sets the parameters of this description object to match the supplied object.
  97:      *
  98:      * @param o  the object (should be an instance of <code>Date</code>).
  99:      *
 100:      * @throws ObjectFactoryException if the object is not an instance of <code>Date</code>.
 101:      */
 102:     public void setParameterFromObject(final Object o) throws ObjectFactoryException {
 103:         if (o instanceof Date) {
 104:             final GregorianCalendar gc = new GregorianCalendar();
 105:             gc.setTime((Date) o);
 106:             final int year = gc.get(Calendar.YEAR);
 107:             final int month = gc.get(Calendar.MONTH);
 108:             final int day = gc.get(Calendar.DAY_OF_MONTH);
 109: 
 110:             setParameter("year", new Integer(year));
 111:             setParameter("month", new Integer(month));
 112:             setParameter("day", new Integer(day));
 113:         }
 114:         else {
 115:             throw new ObjectFactoryException("Is no instance of java.util.Date");
 116:         }
 117: 
 118:     }
 119: }