KickJava   Java API By Example, From Geeks To Geeks.

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


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.util.ArrayList JavaDoc;
60 import java.util.List JavaDoc;
61
62 import org.apache.log4j.Logger;
63 import org.objectstyle.cayenne.access.DataNode;
64 import org.objectstyle.cayenne.conf.ConfigStatus;
65 import org.objectstyle.cayenne.conf.Configuration;
66 import org.objectstyle.cayenne.conf.DriverDataSourceFactory;
67 import org.objectstyle.cayenne.map.DataMap;
68
69 /**
70  * Represents Cayenne application project.
71  *
72  * @author Andrei Adamchik
73  */
74 public class ApplicationProject extends Project {
75     private static Logger logObj = Logger.getLogger(ApplicationProject.class);
76
77     protected ProjectConfiguration configuration;
78
79     /**
80      * Constructor for ApplicationProject.
81      *
82      * @param projectFile
83      */
84     public ApplicationProject(File JavaDoc projectFile) {
85         super(projectFile);
86     }
87
88     /**
89      * @since 1.1
90      */
91     public void upgrade() throws ProjectException {
92         ApplicationUpgradeHandler.sharedHandler().performUpgrade(this);
93     }
94
95     /**
96      * Initializes internal <code>Configuration</code> object and then calls super.
97      */
98     protected void postInitialize(File JavaDoc projectFile) {
99         logObj.debug("postInitialize: " + projectFile);
100
101         try {
102             // if the projectFile is real..
103 if (projectFile != null) {
104                 // see whether it's a directory
105 if (projectFile.isDirectory()) {
106                     // if so, create a new default file with full path
107 projectFile =
108                         new File JavaDoc(
109                             projectFile.getPath()
110                                 + File.separator
111                                 + Configuration.DEFAULT_DOMAIN_FILE);
112                 }
113
114                 projectFile = projectFile.getCanonicalFile();
115             }
116
117             loadProject(projectFile);
118         }
119         catch (Exception JavaDoc e) {
120             throw new ProjectException("Error creating ApplicationProject.", e);
121         }
122
123         super.postInitialize(projectFile);
124     }
125
126     /**
127      * @since 1.1
128      */
129     protected void loadProject(File JavaDoc projectFile) throws Exception JavaDoc {
130         ProjectConfiguration conf = new ProjectConfiguration(projectFile);
131
132         // try to initialize configuration
133 if (conf.canInitialize()) {
134             conf.initialize();
135             conf.didInitialize();
136         }
137         
138         // set default version
139 if (conf.getProjectVersion() == null) {
140             conf.setProjectVersion(
141                 ApplicationUpgradeHandler.sharedHandler().supportedVersion());
142         }
143
144         this.configuration = conf;
145     }
146
147     /**
148     * Returns Cayenne configuration object associated with this project.
149     */
150     public Configuration getConfiguration() {
151         return configuration;
152     }
153
154     /**
155     * Sets Cayenne configuration object associated with this project.
156     */
157     public void setConfiguration(ProjectConfiguration config) {
158         this.configuration = config;
159     }
160
161     public void checkForUpgrades() {
162         ApplicationUpgradeHandler.sharedHandler().checkForUpgrades(
163             configuration,
164             upgradeMessages);
165     }
166
167     /**
168      * @see org.objectstyle.cayenne.project.Project#getChildren()
169      */
170     public List JavaDoc getChildren() {
171         return new ArrayList JavaDoc(this.getConfiguration().getDomains());
172     }
173
174     /**
175     * Returns appropriate ProjectFile or null if object does not require
176     * a file of its own. In case of ApplicationProject, the nodes
177     * that require separate filed are: the project itself, each DataMap, each
178     * driver DataNode.
179     */
180     public ProjectFile projectFileForObject(Object JavaDoc obj) {
181         if (requiresProjectFile(obj)) {
182             String JavaDoc domainFileName = this.getConfiguration().getDomainConfigurationName();
183             return new ApplicationProjectFile(this, domainFileName);
184         }
185         else if (requiresMapFile(obj)) {
186             return new DataMapFile(this, (DataMap) obj);
187         }
188         else if (requiresNodeFile(obj)) {
189             return new DataNodeFile(this, (DataNode) obj);
190         }
191
192         return null;
193     }
194
195     protected boolean requiresProjectFile(Object JavaDoc obj) {
196         return obj == this;
197     }
198
199     protected boolean requiresMapFile(Object JavaDoc obj) {
200         return obj instanceof DataMap;
201     }
202
203     protected boolean requiresNodeFile(Object JavaDoc obj) {
204         if (obj instanceof DataNode) {
205             DataNode node = (DataNode) obj;
206
207             // only driver datasource factory requires a file
208 if (DriverDataSourceFactory
209                 .class
210                 .getName()
211                 .equals(node.getDataSourceFactory())) {
212                 return true;
213             }
214         }
215
216         return false;
217     }
218
219     public ConfigStatus getLoadStatus() {
220         return (configuration != null)
221             ? configuration.getLoadStatus()
222             : new ConfigStatus();
223     }
224 }
225
Popular Tags