Source code: org/objectstyle/cayenne/project/DataMapFile.java
1 /* ====================================================================
2 *
3 * The ObjectStyle Group Software License, Version 1.0
4 *
5 * Copyright (c) 2002-2003 The ObjectStyle Group
6 * and individual authors of the software. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * 3. The end-user documentation included with the redistribution, if
21 * any, must include the following acknowlegement:
22 * "This product includes software developed by the
23 * ObjectStyle Group (http://objectstyle.org/)."
24 * Alternately, this acknowlegement may appear in the software itself,
25 * if and wherever such third-party acknowlegements normally appear.
26 *
27 * 4. The names "ObjectStyle Group" and "Cayenne"
28 * must not be used to endorse or promote products derived
29 * from this software without prior written permission. For written
30 * permission, please contact andrus@objectstyle.org.
31 *
32 * 5. Products derived from this software may not be called "ObjectStyle"
33 * nor may "ObjectStyle" appear in their names without prior written
34 * permission of the ObjectStyle Group.
35 *
36 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39 * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * SUCH DAMAGE.
48 * ====================================================================
49 *
50 * This software consists of voluntary contributions made by many
51 * individuals on behalf of the ObjectStyle Group. For more
52 * information on the ObjectStyle Group, please see
53 * <http://objectstyle.org/>.
54 *
55 */
56 package org.objectstyle.cayenne.project;
57
58 import java.io.PrintWriter;
59
60 import org.objectstyle.cayenne.map.DataMap;
61 import org.objectstyle.cayenne.map.MapLoader;
62
63 /**
64 * DataMapFile is a ProjectFile abstraction of the
65 * DataMap file in a Cayenne project.
66 *
67 * @author Andrei Adamchik
68 */
69 public class DataMapFile extends ProjectFile {
70 public static final String LOCATION_SUFFIX = ".map.xml";
71
72 protected DataMap map;
73
74 public DataMapFile() {}
75
76 /**
77 * Constructor for DataMapFile.
78 */
79 public DataMapFile(Project project, DataMap map) {
80 super(project, map.getLocation());
81 this.map = map;
82 }
83
84 /**
85 * Returns DataMap associated with this project.
86 */
87 public Object getObject() {
88 return map;
89 }
90
91 /**
92 * @see org.objectstyle.cayenne.project.ProjectFile#getObjectName()
93 */
94 public String getObjectName() {
95 return map.getName();
96 }
97
98 public void save(PrintWriter out) throws Exception {
99 MapLoader saver = new MapLoader();
100 saver.storeDataMap(out, map);
101 }
102
103 /**
104 * @see org.objectstyle.cayenne.project.ProjectFile#canHandle(Object)
105 */
106 public boolean canHandle(Object obj) {
107 return obj instanceof DataMap;
108 }
109
110 /**
111 * Updates map location to match the name before save.
112 */
113 public void willSave() {
114 super.willSave();
115
116 if (map != null) {
117 map.setLocation(getLocation());
118 }
119 }
120
121 /**
122 * Returns ".map.xml" that should be used as a file suffix for DataMaps.
123 */
124 public String getLocationSuffix() {
125 return LOCATION_SUFFIX;
126 }
127 }