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

   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:  * Line2DObjectDescription.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: Line2DObjectDescription.java,v 1.3 2005/11/14 11:02:46 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.awt.geom.Line2D;
  47: 
  48: /**
  49:  * An object-description for a <code>Line2D</code> object.
  50:  *
  51:  * @author Thomas Morgner
  52:  */
  53: public class Line2DObjectDescription extends AbstractObjectDescription {
  54: 
  55:     /**
  56:      * Creates a new object description.
  57:      */
  58:     public Line2DObjectDescription() {
  59:         super(Line2D.class);
  60:         setParameterDefinition("x1", Float.class);
  61:         setParameterDefinition("x2", Float.class);
  62:         setParameterDefinition("y1", Float.class);
  63:         setParameterDefinition("y2", Float.class);
  64:     }
  65: 
  66:     /**
  67:      * Creates an object based on this description.
  68:      *
  69:      * @return The object.
  70:      */
  71:     public Object createObject() {
  72:         final Line2D line = new Line2D.Float();
  73: 
  74:         final float x1 = getFloatParameter("x1");
  75:         final float x2 = getFloatParameter("x2");
  76:         final float y1 = getFloatParameter("y1");
  77:         final float y2 = getFloatParameter("y2");
  78:         line.setLine(x1, y1, x2, y2);
  79:         return line;
  80:     }
  81: 
  82:     /**
  83:      * Returns a parameter value as a float.
  84:      *
  85:      * @param param  the parameter name.
  86:      *
  87:      * @return The float value.
  88:      */
  89:     private float getFloatParameter(final String param) {
  90:         final Float p = (Float) getParameter(param);
  91:         if (p == null) {
  92:             return 0;
  93:         }
  94:         return p.floatValue();
  95:     }
  96: 
  97:     /**
  98:      * Sets the parameters of this description object to match the supplied object.
  99:      *
 100:      * @param o  the object (should be an instance of <code>Line2D</code>).
 101:      *
 102:      * @throws ObjectFactoryException if the object is not an instance of <code>Line2D</code>.
 103:      */
 104:     public void setParameterFromObject(final Object o) throws ObjectFactoryException {
 105:         if (!(o instanceof Line2D)) {
 106:             throw new ObjectFactoryException("The given object is no java.awt.geom.Line2D.");
 107:         }
 108:         final Line2D line = (Line2D) o;
 109:         final float x1 = (float) line.getX1();
 110:         final float x2 = (float) line.getX2();
 111:         final float y1 = (float) line.getY1();
 112:         final float y2 = (float) line.getY2();
 113: 
 114:         setParameter("x1", new Float(x1));
 115:         setParameter("x2", new Float(x2));
 116:         setParameter("y1", new Float(y1));
 117:         setParameter("y2", new Float(y2));
 118:     }
 119: }