KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > project > DataMapProject


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.project;
57
58 import java.io.File JavaDoc;
59 import java.io.FileInputStream JavaDoc;
60 import java.io.IOException JavaDoc;
61 import java.io.InputStream JavaDoc;
62 import java.util.ArrayList JavaDoc;
63 import java.util.List JavaDoc;
64
65 import org.apache.log4j.Logger;
66 import org.objectstyle.cayenne.conf.ConfigStatus;
67 import org.objectstyle.cayenne.map.DataMap;
68 import org.objectstyle.cayenne.map.DataMapException;
69 import org.objectstyle.cayenne.map.MapLoader;
70 import org.xml.sax.InputSource JavaDoc;
71
72 /**
73  * Cayenne project that consists of a single DataMap.
74  *
75  * @author Andrei Adamchik
76  */

77 public class DataMapProject extends Project {
78     private static Logger logObj = Logger.getLogger(DataMapProject.class);
79     
80     protected DataMap map;
81
82     /**
83      * Constructor for MapProject.
84      *
85      * @param projectFile
86      */

87     public DataMapProject(File JavaDoc projectFile) {
88         super(projectFile);
89     }
90
91     /**
92      * @since 1.1
93      */

94     public void upgrade() throws ProjectException {
95         // upgrades not supported in this type of project
96
throw new ProjectException("'DataMapProject' does not support upgrades.");
97     }
98     
99     /**
100      * Does nothing.
101      */

102     public void checkForUpgrades() {
103         // do nothing
104
}
105
106     /**
107     * Initializes internal <code>map</code> object and then calls super.
108     */

109     protected void postInitialize(File JavaDoc projectFile) {
110         if (projectFile != null) {
111             try {
112                 InputStream JavaDoc in = new FileInputStream JavaDoc(projectFile.getCanonicalFile());
113                 map = new MapLoader().loadDataMap(new InputSource JavaDoc(in));
114
115                 String JavaDoc fileName = resolveSymbolicName(projectFile);
116                 logObj.error("resolving: " + projectFile + " to " + fileName);
117                 String JavaDoc mapName =
118                     (fileName != null && fileName.endsWith(DataMapFile.LOCATION_SUFFIX))
119                         ? fileName.substring(0, fileName.length() - DataMapFile.LOCATION_SUFFIX.length())
120                         : "UntitledMap";
121
122                 map.setName(mapName);
123             } catch (IOException JavaDoc e) {
124                 throw new ProjectException("Error creating " + this.getClass().getName(), e);
125             } catch (DataMapException dme) {
126                 throw new ProjectException("Error creating " + this.getClass().getName(), dme);
127             }
128         } else {
129             map = (DataMap) NamedObjectFactory.createObject(DataMap.class, null);
130         }
131
132         super.postInitialize(projectFile);
133     }
134
135
136     /**
137      * Returns a list that contains project DataMap as a single object.
138      */

139     public List JavaDoc getChildren() {
140         List JavaDoc entities = new ArrayList JavaDoc();
141         entities.add(map);
142         return entities;
143     }
144
145
146     /**
147      * Returns appropriate ProjectFile or null if object does not require
148      * a file of its own. In case of DataMapProject, the only
149      * object that requires a file is the project itself.
150      */

151     public ProjectFile projectFileForObject(Object JavaDoc obj) {
152         if(obj == this) {
153             return new DataMapFile(this, map);
154         }
155         
156         return null;
157     }
158     
159     /**
160      * Always returns empty status. Map projects do not support status tracking
161      * yet.
162      */

163     public ConfigStatus getLoadStatus() {
164         return new ConfigStatus();
165     }
166 }
167
Popular Tags