KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > access > types > ExtendedTypeMap


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
57 package org.objectstyle.cayenne.access.types;
58
59 import java.util.HashMap JavaDoc;
60 import java.util.Iterator JavaDoc;
61 import java.util.Map JavaDoc;
62 import java.util.Set JavaDoc;
63
64 /**
65  * Contains a map of ExtendedType objects, that serve as handlers for converting values
66  * between Java application and JDBC layer.
67  * <p>
68  * Class uses singleton model, since mapping is usually shared within the application.
69  * </p>
70  *
71  * @author Andrei Adamchik
72  */
73 public class ExtendedTypeMap {
74
75     protected Map JavaDoc typeMap = new HashMap JavaDoc();
76     protected DefaultType defaultType = new DefaultType();
77
78     /**
79      * Creates new ExtendedTypeMap, populating it with default JDBC-compatible types.
80      */
81     public ExtendedTypeMap() {
82         this.initDefaultTypes();
83     }
84
85     /**
86      * Registers default extended types. This method is called from constructor.
87      */
88     protected void initDefaultTypes() {
89         // register default types
90 Iterator JavaDoc it = DefaultType.defaultTypes();
91         while (it.hasNext()) {
92             registerType(new DefaultType((String JavaDoc) it.next()));
93         }
94     }
95
96     /**
97      * Adds a new type to the list of registered types. If there is another type
98      * registered for a class described by the <code>type</code> argument, the old
99      * handler is overwriden by the new one.
100      */
101     public void registerType(ExtendedType type) {
102         typeMap.put(type.getClassName(), type);
103     }
104
105     /**
106      * Returns a default ExtendedType that is used to handle unmapped types.
107      */
108     public ExtendedType getDefaultType() {
109         return defaultType;
110     }
111
112     /**
113      * Returns a type registered for the class name. If no such type exists, returns the
114      * default type. It is guaranteed that this method returns a non-null ExtendedType
115      * instance. Note that for array types class name must be in the form 'MyClass[]'.
116      */
117     public ExtendedType getRegisteredType(String JavaDoc javaClassName) {
118         ExtendedType type = (ExtendedType) typeMap.get(javaClassName);
119         return (type != null) ? type : defaultType;
120     }
121
122     /**
123      * Returns a type registered for the class name. If no such type exists, returns the
124      * default type. It is guaranteed that this method returns a non-null ExtendedType
125      * instance.
126      */
127     public ExtendedType getRegisteredType(Class JavaDoc javaClass) {
128         String JavaDoc name = null;
129
130         if (javaClass.isArray()) {
131             // only support single dimensional arrays now
132 name = javaClass.getComponentType() + "[]";
133         }
134         else {
135             name = javaClass.getName();
136         }
137
138         ExtendedType type = (ExtendedType) typeMap.get(name);
139         return (type != null) ? type : defaultType;
140     }
141
142     /**
143      * Removes registered ExtendedType object corresponding to <code>javaClassName</code>
144      * parameter.
145      */
146     public void unregisterType(String JavaDoc javaClassName) {
147         typeMap.remove(javaClassName);
148     }
149
150     /**
151      * Returns array of Java class names supported by Cayenne for JDBC mapping.
152      */
153     public String JavaDoc[] getRegisteredTypeNames() {
154         Set JavaDoc keys = typeMap.keySet();
155         int len = keys.size();
156         String JavaDoc[] types = new String JavaDoc[len];
157
158         Iterator JavaDoc it = keys.iterator();
159         for (int i = 0; i < len; i++) {
160             types[i] = (String JavaDoc) it.next();
161         }
162
163         return types;
164     }
165 }
166
Popular Tags