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
|
/**
* Arara, the cool TeX automation tool
* Copyright (c) 2012 -- 2018, Paulo Roberto Massa Cereda
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the project's author nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.github.cereda.arara.utils;
import com.github.cereda.arara.controller.ConfigurationController;
import com.github.cereda.arara.controller.LanguageController;
import com.github.cereda.arara.model.AraraException;
import com.github.cereda.arara.model.Database;
import com.github.cereda.arara.model.Messages;
import java.io.File;
import org.simpleframework.xml.Serializer;
import org.simpleframework.xml.core.Persister;
/**
* Implements database utilitary methods.
* @author Paulo Roberto Massa Cereda
* @version 4.0
* @since 4.0
*/
public class DatabaseUtils {
// the application messages obtained from the
// language controller
private static final LanguageController messages =
LanguageController.getInstance();
/**
* Loads the XML file representing the database.
* @return The database object.
* @throws AraraException Something wrong happened, to be caught in the
* higher levels.
*/
public static Database load() throws AraraException {
if (!exists()) {
return new Database();
} else {
File file = new File(getPath());
try {
Serializer serializer = new Persister();
Database database = serializer.read(Database.class, file);
return database;
} catch (Exception exception) {
throw new AraraException(
messages.getMessage(
Messages.ERROR_LOAD_COULD_NOT_LOAD_XML,
file.getName()
),
exception
);
}
}
}
/**
* Saves the database on a XML file.
* @param database The database object.
* @throws AraraException Something wrong happened, to be caught in the
* higher levels.
*/
public static void save(Database database) throws AraraException {
File file = new File(getPath());
try {
Serializer serializer = new Persister();
serializer.write(database, file);
} catch (Exception exception) {
throw new AraraException(
messages.getMessage(
Messages.ERROR_SAVE_COULD_NOT_SAVE_XML,
file.getName()
),
exception
);
}
}
/**
* Checks if the XML file representing the database exists.
* @return A boolean value indicating if the XML file exists.
* @throws AraraException Something wrong happened, to be caught in the
* higher levels.
*/
private static boolean exists() throws AraraException {
File file = new File(getPath());
return file.exists();
}
/**
* Gets the path to the XML file representing the database.
* @return A string representing the path to the XML file.
* @throws AraraException Something wrong happened, to be caught in the
* higher levels.
*/
private static String getPath() throws AraraException {
String name = ((String) ConfigurationController.
getInstance().get("execution.database.name")).concat(".xml");
String path = CommonUtils.getParentCanonicalPath(getReference());
return CommonUtils.buildPath(path, name);
}
/**
* Gets the main file reference.
* @return The main file reference.
*/
private static File getReference() {
return (File) ConfigurationController.
getInstance().get("execution.reference");
}
}
|