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

   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:  * DimensionObjectDescription.java
  29:  * -------------------------------
  30:  * (C)opyright 2004, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: DimensionObjectDescription.java,v 1.2 2005/10/18 13:31:58 mungady Exp $
  36:  *
  37:  * Changes 
  38:  * -------
  39:  * 13-Jan-2004 : Initial version
  40:  *  
  41:  */
  42: 
  43: package org.jfree.xml.factory.objects;
  44: 
  45: import java.awt.Dimension;
  46: import java.awt.geom.Dimension2D;
  47: 
  48: /**
  49:  * An object-description for a <code>java.awt.Dimension</code> object.
  50:  *
  51:  * @author Thomas Morgner
  52:  */
  53: public class DimensionObjectDescription extends AbstractObjectDescription {
  54: 
  55:     /**
  56:      * Creates a new object description.
  57:      */
  58:     public DimensionObjectDescription() {
  59:         super(Dimension.class);
  60:         setParameterDefinition("width", Float.class);
  61:         setParameterDefinition("height", Float.class);
  62:     }
  63: 
  64:     /**
  65:      * Creates an object based on the description.
  66:      *
  67:      * @return The object.
  68:      */
  69:     public Object createObject() {
  70:         final Dimension2D dim = new Dimension();
  71: 
  72:         final float width = getFloatParameter("width");
  73:         final float height = getFloatParameter("height");
  74:         dim.setSize(width, height);
  75:         return dim;
  76:     }
  77: 
  78:     /**
  79:      * Returns a parameter value as a float.
  80:      *
  81:      * @param param  the parameter name.
  82:      *
  83:      * @return The float value.
  84:      */
  85:     private float getFloatParameter(final String param) {
  86:         final Float p = (Float) getParameter(param);
  87:         if (p == null) {
  88:             return 0;
  89:         }
  90:         return p.floatValue();
  91:     }
  92: 
  93: 
  94:     /**
  95:      * Sets the parameters of this description object to match the supplied object.
  96:      *
  97:      * @param o  the object (should be an instance of <code>Dimension2D</code>).
  98:      *
  99:      * @throws ObjectFactoryException if the object is not an instance of <code>Point2D</code>.
 100:      */
 101:     public void setParameterFromObject(final Object o) throws ObjectFactoryException {
 102:         if (!(o instanceof Dimension)) {
 103:             throw new ObjectFactoryException("The given object is no java.awt.geom.Dimension2D.");
 104:         }
 105: 
 106:         final Dimension dim = (Dimension) o;
 107:         final float width = (float) dim.getWidth();
 108:         final float height = (float) dim.getHeight();
 109: 
 110:         setParameter("width", new Float(width));
 111:         setParameter("height", new Float(height));
 112:     }
 113: }