File: WorkspaceSaver.java

package info (click to toggle)
libgrinvin-core-java 1.2-1
  • links: PTS, VCS
  • area: contrib
  • in suites: squeeze
  • size: 3,904 kB
  • ctags: 5,009
  • sloc: java: 23,494; xml: 423; makefile: 15
file content (145 lines) | stat: -rw-r--r-- 5,413 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/* WorkspaceSaver.java
 * =========================================================================
 * This file is part of the GrInvIn project - http://www.grinvin.org
 * 
 * Copyright (C) 2005-2008 Universiteit Gent
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * A copy of the GNU General Public License can be found in the file
 * LICENSE.txt provided with the source distribution of this program (see
 * the META-INF directory in the source jar). This license can also be
 * found on the GNU website at http://www.gnu.org/licenses/gpl.html.
 * 
 * If you did not receive a copy of the GNU General Public License along
 * with this program, contact the lead developer, or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

package org.grinvin.io;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ListIterator;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.zip.ZipOutputStream;

import org.grinvin.util.IOHelper;
import org.grinvin.workspace.Workspace;
import org.grinvin.workspace.WorkspaceException;

import org.jdom.DocType;
import org.jdom.Element;

/**
 * Saves workspaces to disk.
 */
public class WorkspaceSaver {
    
    //
    private static final Logger LOGGER
            = Logger.getLogger("org.grinvin.workspace", "org.grinvin.workspace.resources");
    
    //
    private static final String ZIPFILE_COMMENT =
            "Grinvin Workspace -- Saved by org.grinvin.io.WorkspaceSaver";
    
    //
    private Workspace workspace;
    
    //
    private SectionSaver ssaver;
    
    //
    private WorkspaceSaver(Workspace workspace, SectionSaver ssaver) {
        this.workspace = workspace;
        this.ssaver = ssaver;
    }
    
    private void saveMeta() throws IOException {
        Properties meta = new Properties();
        meta.setProperty("version", "1.1");
        OutputStream out = ssaver.createSection("meta-info.xml");
        meta.storeToXML(out, null);
    }

    
    /**
     * Save the workspace into the current workspace directory.
     */
    private void save() throws WorkspaceException, IOException {
        Element root = new Element("workspace");
        // in reverse order
        for (ListIterator<Subsystem> iter = workspace.subsystems.listIterator(workspace.subsystems.size());
        iter.hasPrevious(); )
            iter.previous().save(root, ssaver);
        DocType docType = new DocType("workspace", "-//GrInvIn IO//Workspace 1.1//EN", "http://downloads.grinvin.org/dtds/io/workspace-1.1.dtd");
        LoaderSaverHelper.outputXML(root, docType, ssaver.createSection("workspace.xml"));
        saveMeta();
    }
    
    /**
     * Save the workspace into a new workspace file. If the location
     * already exists, it is replaced.
     */
    public static void saveAs(Workspace workspace, File location) throws WorkspaceException {
        workspace.setLocation(location);
        save(workspace);
        LOGGER.log(Level.INFO, "log.created.workspace", location);
    }
    
    public static void save(Workspace workspace) throws WorkspaceException {
        File file = workspace.getLocation();
        assert file != null : "save called without location";
        if (file.isDirectory()) {
            saveToDirectory(workspace, file);
        } else {
            saveToZipFile(workspace, file);
        }
    }
        
    private static void saveToZipFile(Workspace workspace, File file) throws WorkspaceException {
        try {
            FileOutputStream out = new FileOutputStream(file);
            ZipOutputStream zip = new ZipOutputStream(out);
            zip.setComment(ZIPFILE_COMMENT);
            WorkspaceSaver saver = new WorkspaceSaver(workspace, new ZipOutputStreamSectionSaver(zip));
            saver.save();
            zip.finish();
            out.close();
            LOGGER.log(Level.INFO, "log.saved.workspace", file);
        } catch (IOException ex) {
            throw new WorkspaceException("I/O error while saving workspace", file, ex);
        }
    }
    
    private static void saveToDirectory(Workspace workspace, File directory) throws WorkspaceException {
        if (directory.exists()) {
            if (! IOHelper.deleteDirectory(directory))
                throw new WorkspaceException("Directory could not be removed", directory);
        }
        if (! directory.mkdir())
            throw new WorkspaceException("Could not create directory", directory);
        
        WorkspaceSaver saver = new WorkspaceSaver(workspace, new DirectorySectionSaver(directory));
        try {
            saver.save();
        } catch (IOException ex) {
            throw new WorkspaceException("I/O error while saving workspace", directory, ex);
        }
        LOGGER.log(Level.INFO, "log.created.workspace", directory);
    }
}