← Back to branch summary

~ubuntu-branches/ubuntu/lucid/libjcommon-java/lucid

« back to all changes in this revision

Viewing changes to source/org/jfree/xml/factory/objects/BeanObjectDescription.java

  • Committer: Bazaar Package Importer
  • Author(s): Wolfgang Baer
  • Date: 2006-02-09 15:58:13 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20060209155813-fzi9zwh2rzedbllq
Tags: 1.0.0-1
http://bugs.debian.org/328574
* New stable upstream release (closes: #328574)
* Move to main - build with kaffe
* Use cdbs build system - added cdbs build-dependency
* Move package to pkg-java-maintainers for comaintenance, 
  added Christian Bayle and myself as uploaders
* Removed unneeded README.Debian
* Added README.Debian-source how the upstream tarball was cleaned
* Move big documentation in an own -doc package
* Register javadoc api with doc-base
* Standards-Version 3.6.2 (no changes)

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/org/jfree/xml/factory/objects/BeanObjectDescription.java
 
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
 * BeanObjectDescription.java
 
29
 * --------------------------
 
30
 * (C)opyright 2003-2005, by Thomas Morgner and Contributors.
 
31
 *
 
32
 * Original Author:  Thomas Morgner;
 
33
 * Contributor(s):   David Gilbert (for Object Refinery Limited);
 
34
 *
 
35
 * $Id: BeanObjectDescription.java,v 1.6 2005/10/18 13:31:58 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 
 
41
 *               JCommon (TM);
 
42
 * 18-Aug-2005 : Added casts to suppress compiler warnings, as suggested in 
 
43
 *               patch 1260622 (DG);
 
44
 *
 
45
 */
 
46
 
 
47
package org.jfree.xml.factory.objects;
 
48
 
 
49
import java.lang.reflect.Method;
 
50
import java.lang.reflect.Modifier;
 
51
import java.util.Iterator;
 
52
import java.util.TreeSet;
 
53
import java.util.HashMap;
 
54
import java.beans.Introspector;
 
55
import java.beans.IntrospectionException;
 
56
import java.beans.BeanInfo;
 
57
import java.beans.PropertyDescriptor;
 
58
import java.io.ObjectInputStream;
 
59
import java.io.IOException;
 
60
 
 
61
import org.jfree.util.Log;
 
62
 
 
63
/**
 
64
 * An object-description for a bean object. This object description
 
65
 * is very dangerous, if the bean contains properties with undefined
 
66
 * types.
 
67
 *
 
68
 * @author Thomas Morgner
 
69
 */
 
70
public class BeanObjectDescription extends AbstractObjectDescription {
 
71
 
 
72
    private TreeSet ignoredParameters;
 
73
    private transient HashMap properties;
 
74
 
 
75
    /**
 
76
     * Creates a new object description.
 
77
     *
 
78
     * @param className  the class.
 
79
     */
 
80
    public BeanObjectDescription(final Class className) {
 
81
        this(className, true);
 
82
    }
 
83
 
 
84
    /**
 
85
     * Creates a new object description.
 
86
     *
 
87
     * @param className  the class.
 
88
     * @param init  set to true, to autmaoticly initialise the object 
 
89
     *              description. If set to false, the initialisation is 
 
90
     *              elsewhere.
 
91
     */
 
92
    public BeanObjectDescription(final Class className, final boolean init) {
 
93
        super(className);
 
94
        // now create some method descriptions ..
 
95
        this.ignoredParameters = new TreeSet();
 
96
        readBeanDescription(className, init);
 
97
    }
 
98
 
 
99
    private boolean isValidMethod (final Method method, final int parCount)
 
100
    {
 
101
        if (method == null) {
 
102
            return false;
 
103
        }
 
104
        if (!Modifier.isPublic(method.getModifiers())) {
 
105
            return false;
 
106
        }
 
107
        if (Modifier.isStatic(method.getModifiers())) {
 
108
            return false;
 
109
        }
 
110
        if (method.getParameterTypes().length != parCount) {
 
111
            return false;
 
112
        }
 
113
        return true;
 
114
    }
 
115
 
 
116
    /**
 
117
     * Creates an object based on this description.
 
118
     *
 
119
     * @return The object.
 
120
     */
 
121
    public Object createObject() {
 
122
        try {
 
123
            final Object o = getObjectClass().newInstance();
 
124
            // now add the various parameters ...
 
125
 
 
126
            final Iterator it = getParameterNames();
 
127
            while (it.hasNext()) {
 
128
                final String name = (String) it.next();
 
129
 
 
130
                if (isParameterIgnored(name)) {
 
131
                    continue;
 
132
                }
 
133
 
 
134
                final Method method = findSetMethod(name);
 
135
                final Object parameterValue = getParameter(name);
 
136
                if (parameterValue == null) {
 
137
                    // Log.debug ("Parameter: " + name + " is null");
 
138
                }
 
139
                else {
 
140
                    method.invoke(o, new Object[]{parameterValue});
 
141
                }
 
142
            }
 
143
            return o;
 
144
        }
 
145
        catch (Exception e) {
 
146
            Log.error("Unable to invoke bean method", e);
 
147
        }
 
148
        return null;
 
149
    }
 
150
 
 
151
    /**
 
152
     * Finds a set method in the bean.
 
153
     *
 
154
     * @param parameterName  the parameter name.
 
155
     *
 
156
     * @return The method.
 
157
     */
 
158
    private Method findSetMethod(final String parameterName) {
 
159
        final PropertyDescriptor descriptor 
 
160
            = (PropertyDescriptor) this.properties.get(parameterName);
 
161
        return descriptor.getWriteMethod();
 
162
    }
 
163
 
 
164
    /**
 
165
     * Finds a get method in the bean.
 
166
     *
 
167
     * @param parameterName  the paramater name.
 
168
     * @return The method.
 
169
     */
 
170
    private Method findGetMethod(final String parameterName) {
 
171
        final PropertyDescriptor descriptor 
 
172
            = (PropertyDescriptor) this.properties.get(parameterName);
 
173
        return descriptor.getReadMethod();
 
174
    }
 
175
 
 
176
    /**
 
177
     * Sets the parameters in the description to match the supplied object.
 
178
     *
 
179
     * @param o  the object (<code>null</code> not allowed).
 
180
     *
 
181
     * @throws ObjectFactoryException if there is a problem.
 
182
     */
 
183
    public void setParameterFromObject(final Object o)
 
184
        throws ObjectFactoryException {
 
185
        if (o == null) {
 
186
            throw new NullPointerException("Given object is null");
 
187
        }
 
188
        final Class c = getObjectClass();
 
189
        if (!c.isInstance(o)) {
 
190
            throw new ObjectFactoryException("Object is no instance of " + c 
 
191
                + "(is " + o.getClass() + ")");
 
192
        }
 
193
 
 
194
        final Iterator it = getParameterNames();
 
195
        while (it.hasNext()) {
 
196
            final String propertyName = (String) it.next();
 
197
 
 
198
            if (isParameterIgnored(propertyName)) {
 
199
                continue;
 
200
            }
 
201
 
 
202
            try {
 
203
                final Method method = findGetMethod(propertyName);
 
204
                final Object retval = method.invoke(o, (Object[]) null);
 
205
                if (retval != null) {
 
206
                    setParameter(propertyName, retval);
 
207
                }
 
208
            }
 
209
            catch (Exception e) {
 
210
                Log.info("Exception on method invokation.", e);
 
211
            }
 
212
 
 
213
        }
 
214
    }
 
215
 
 
216
    /**
 
217
     * Adds a parameter to the ignored parameters.
 
218
     * 
 
219
     * @param parameter  the parameter.
 
220
     */
 
221
    protected void ignoreParameter(final String parameter) {
 
222
        this.ignoredParameters.add (parameter);
 
223
    }
 
224
 
 
225
    /**
 
226
     * Returns a flag that indicates whether or not the specified parameter is 
 
227
     * ignored.
 
228
     * 
 
229
     * @param parameter  the parameter.
 
230
     * 
 
231
     * @return The flag.
 
232
     */
 
233
    protected boolean isParameterIgnored (final String parameter) {
 
234
        return this.ignoredParameters.contains(parameter);
 
235
    }
 
236
 
 
237
  private void readObject(final ObjectInputStream in)
 
238
      throws IOException, ClassNotFoundException {
 
239
    in.defaultReadObject();
 
240
    readBeanDescription(getObjectClass(), false);
 
241
  }
 
242
 
 
243
  private void readBeanDescription(final Class className, final boolean init) {
 
244
    try {
 
245
        this.properties = new HashMap();
 
246
 
 
247
        final BeanInfo bi = Introspector.getBeanInfo(className);
 
248
        final PropertyDescriptor[] propertyDescriptors 
 
249
            = bi.getPropertyDescriptors();
 
250
        for (int i = 0; i < propertyDescriptors.length; i++)
 
251
        {
 
252
            final PropertyDescriptor propertyDescriptor = propertyDescriptors[i];
 
253
            final Method readMethod = propertyDescriptor.getReadMethod();
 
254
            final Method writeMethod = propertyDescriptor.getWriteMethod();
 
255
            if (isValidMethod(readMethod, 0) && isValidMethod(writeMethod, 1))
 
256
            {
 
257
                final String name = propertyDescriptor.getName();
 
258
                this.properties.put(name, propertyDescriptor);
 
259
                if (init) {
 
260
                    super.setParameterDefinition(name, 
 
261
                            propertyDescriptor.getPropertyType());
 
262
                }
 
263
            }
 
264
        }
 
265
    }
 
266
    catch (IntrospectionException e) {
 
267
        Log.error ("Unable to build bean description", e);
 
268
    }
 
269
  }
 
270
}