KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > service > ClientServerUtils


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56 package org.objectstyle.cayenne.service;
57
58 import java.util.ArrayList JavaDoc;
59 import java.util.Iterator JavaDoc;
60 import java.util.List JavaDoc;
61
62 import org.apache.commons.beanutils.PropertyUtils;
63 import org.objectstyle.cayenne.CayenneDataObject;
64 import org.objectstyle.cayenne.CayenneRuntimeException;
65 import org.objectstyle.cayenne.Persistent;
66 import org.objectstyle.cayenne.map.EntityResolver;
67 import org.objectstyle.cayenne.map.ObjEntity;
68
69 /**
70  * @since 1.2
71  * @author Andrei Adamchik
72  */
73 // TODO: create a generic GraphSerializer, maybe using the same approach as XML
74 // serialization mechanism only based on Java serialization.
75 class ClientServerUtils {
76
77     static Object JavaDoc toClientObject(EntityResolver resolver, CayenneDataObject object)
78             throws Exception JavaDoc {
79         ObjEntity entity = object.getObjEntity();
80
81         // TODO: move class creation to ObjEntity
82 if (entity.getClientClassName() == null) {
83             throw new CayenneRuntimeException(
84                     "No client-side class defined for ObjEntity: " + entity.getName());
85         }
86
87         Class JavaDoc clientClass = Class.forName(entity.getClientClassName(), true, Thread
88                 .currentThread()
89                 .getContextClassLoader());
90
91         Object JavaDoc clientObject = clientClass.newInstance();
92
93         // copy ID
94 if (clientObject instanceof Persistent) {
95             ((Persistent) clientObject).setOid(resolver.convertToGlobalID(object.getObjectId()));
96         }
97
98         // TODO: implement attribute filtering for client..
99 // copy client properties
100
101         Iterator JavaDoc it = entity.getAttributeMap().keySet().iterator();
102         while (it.hasNext()) {
103             String JavaDoc key = (String JavaDoc) it.next();
104             PropertyUtils.setProperty(clientObject, key, object.readProperty(key));
105         }
106
107         return clientObject;
108     }
109
110     /**
111      * Converts a list of server-side objects to their client counterparts.
112      */
113     static List JavaDoc toClientObjects(EntityResolver resolver, List JavaDoc dataObjects)
114             throws Exception JavaDoc {
115         List JavaDoc clientObjects = new ArrayList JavaDoc(dataObjects.size());
116
117         Iterator JavaDoc it = dataObjects.iterator();
118         while (it.hasNext()) {
119             CayenneDataObject serverObject = (CayenneDataObject) it.next();
120
121             // TODO: toClientObject performs some entity specific lookups that can be
122 // cached as local variables when processing the list
123
124             clientObjects.add(toClientObject(resolver, serverObject));
125         }
126
127         return clientObjects;
128     }
129
130     private ClientServerUtils() {
131
132     }
133 }
Popular Tags