KickJava   Java API By Example, From Geeks To Geeks.

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


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.PrintWriter JavaDoc;
59
60 import org.objectstyle.cayenne.conf.ConfigSaver;
61 import org.objectstyle.cayenne.conf.ConfigSaverDelegate;
62 import org.objectstyle.cayenne.conf.Configuration;
63 import org.objectstyle.cayenne.conf.RuntimeSaveDelegate;
64
65 /**
66  * ApplicationProjectFile is a ProjectFile abstraction of the
67  * main project file in a Cayenne project. Right now Cayenne
68  * projects can not be renamed, so all the name tracking functionality
69  * is pretty much noop.
70  *
71  * @author Andrei Adamchik
72  */
73 public class ApplicationProjectFile extends ProjectFile {
74     protected ConfigSaverDelegate saveDelegate;
75
76     private String JavaDoc objectName = null;
77
78     private ApplicationProjectFile() {
79         super();
80     }
81
82     /**
83      * Constructor for default ApplicationProjectFile.
84      */
85     public ApplicationProjectFile(Project project) {
86         this(project, Configuration.DEFAULT_DOMAIN_FILE);
87     }
88
89     /**
90      * Constructor for ApplicationProjectFile with an existing file.
91      */
92     public ApplicationProjectFile(Project project, String JavaDoc fileName) {
93         super(project, fileName);
94         this.objectName = fileName.substring(0, fileName.lastIndexOf(this.getLocationSuffix()));
95     }
96
97     /**
98      * Returns suffix to append to object name when
99      * creating a file name. Default implementation
100      * returns empty string.
101      */
102     public String JavaDoc getLocationSuffix() {
103         return ".xml";
104     }
105
106     /**
107      * Returns a project.
108      */
109     public Object JavaDoc getObject() {
110         return getProject();
111     }
112
113     /**
114      * @see org.objectstyle.cayenne.project.ProjectFile#getObjectName()
115      */
116     public String JavaDoc getObjectName() {
117         return this.objectName;
118     }
119
120     public void save(PrintWriter JavaDoc out) throws Exception JavaDoc {
121         ConfigSaverDelegate localDelegate =
122             (saveDelegate != null)
123                 ? saveDelegate
124                 : new RuntimeSaveDelegate(((ApplicationProject) projectObj).getConfiguration());
125         new ConfigSaver(localDelegate).storeDomains(out);
126     }
127
128     public boolean canHandle(Object JavaDoc obj) {
129         return obj instanceof ApplicationProject;
130     }
131     
132     /**
133      * Returns the saveDelegate.
134      * @return ConfigSaverDelegate
135      */
136     public ConfigSaverDelegate getSaveDelegate() {
137         return saveDelegate;
138     }
139
140     /**
141      * Sets the saveDelegate.
142      * @param saveDelegate The saveDelegate to set
143      */
144     public void setSaveDelegate(ConfigSaverDelegate saveDelegate) {
145         this.saveDelegate = saveDelegate;
146     }
147 }
148
Popular Tags