KickJava   Java API By Example, From Geeks To Geeks.

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


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.map.DataMap;
61
62 /**
63  * DataMapFile is a ProjectFile abstraction of the
64  * DataMap file in a Cayenne project.
65  *
66  * @author Andrei Adamchik
67  */
68 public class DataMapFile extends ProjectFile {
69     public static final String JavaDoc LOCATION_SUFFIX = ".map.xml";
70     
71     protected DataMap map;
72     
73     public DataMapFile() {}
74
75     /**
76      * Constructor for DataMapFile.
77      */
78     public DataMapFile(Project project, DataMap map) {
79         super(project, map.getLocation());
80         this.map = map;
81     }
82
83     /**
84      * Returns DataMap associated with this project.
85      */
86     public Object JavaDoc getObject() {
87         return map;
88     }
89
90     /**
91      * @see org.objectstyle.cayenne.project.ProjectFile#getObjectName()
92      */
93     public String JavaDoc getObjectName() {
94         return map.getName();
95     }
96
97     public void save(PrintWriter JavaDoc out) throws Exception JavaDoc {
98         map.encodeAsXML(out);
99     }
100
101     /**
102      * @see org.objectstyle.cayenne.project.ProjectFile#canHandle(Object)
103      */
104     public boolean canHandle(Object JavaDoc obj) {
105         return obj instanceof DataMap;
106     }
107
108     /**
109      * Updates map location to match the name before save.
110      */
111     public void willSave() {
112         super.willSave();
113
114         if (map != null) {
115             map.setLocation(getLocation());
116         }
117     }
118
119     /**
120      * Returns ".map.xml" that should be used as a file suffix for DataMaps.
121      */
122     public String JavaDoc getLocationSuffix() {
123         return LOCATION_SUFFIX;
124     }
125 }
126
Popular Tags