files = new HashSet<>();
170 | final File stateFile = getStateFile();
171 | if(!stateFile.exists()) {
172 | return files;
173 | }
174 | BufferedReader reader = null;
175 | try {
176 | reader = new BufferedReader(new FileReader(stateFile));
177 | while (reader.ready()) {
178 | files.add(reader.readLine());
179 | }
180 | } finally {
181 | if(reader!=null) {
182 | reader.close();
183 | }
184 | }
185 | getLogger().debug("loading new state: " + files.toString());
186 | return files;
187 | }
188 |
189 | private boolean isUsingOrmLite(File file) {
190 | if (file.isDirectory()) {
191 | return false;
192 | }
193 | if (!file.exists()) {
194 | throw new RuntimeException(format("File %s doesn't exist.", file.getAbsolutePath()));
195 | }
196 | BufferedReader reader = null;
197 | boolean found = false;
198 | try {
199 | reader = new BufferedReader(new FileReader(file));
200 | while (reader.ready() && !found) {
201 | if (reader.readLine().contains("com.j256.ormlite")) {
202 | found = true;
203 | }
204 | }
205 | } catch (IOException e) {
206 | e.printStackTrace();
207 | } finally {
208 | if (reader != null) {
209 | try {
210 | reader.close();
211 | } catch (IOException e) {
212 | e.printStackTrace();
213 | }
214 | }
215 | }
216 | return found;
217 | }
218 | }
219 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
203 |
--------------------------------------------------------------------------------
/ormgap-ormlite-extension/src/main/java/com/github/stephanenicolas/ormgap/OrmLiteConfigUtil.java:
--------------------------------------------------------------------------------
1 | package com.github.stephanenicolas.ormgap;
2 |
3 | import com.j256.ormlite.dao.DaoManager;
4 | import com.j256.ormlite.db.DatabaseType;
5 | import com.j256.ormlite.db.SqliteAndroidDatabaseType;
6 | import com.j256.ormlite.field.DatabaseField;
7 | import com.j256.ormlite.field.DatabaseFieldConfig;
8 | import com.j256.ormlite.field.ForeignCollectionField;
9 | import com.j256.ormlite.table.DatabaseTable;
10 | import com.j256.ormlite.table.DatabaseTableConfig;
11 | import com.j256.ormlite.table.DatabaseTableConfigLoader;
12 | import java.io.BufferedReader;
13 | import java.io.BufferedWriter;
14 | import java.io.File;
15 | import java.io.FileFilter;
16 | import java.io.FileOutputStream;
17 | import java.io.FileReader;
18 | import java.io.IOException;
19 | import java.io.OutputStream;
20 | import java.io.OutputStreamWriter;
21 | import java.lang.reflect.Field;
22 | import java.sql.SQLException;
23 | import java.util.ArrayList;
24 | import java.util.List;
25 |
26 | /**
27 | * Database configuration file helper class that is used to write a configuration file into the raw resource
28 | * sub-directory to speed up DAO creation.
29 | *
30 | *
31 | * With help from the user list and especially Ian Dees, we discovered that calls to annotation methods in Android are
32 | * _very_ expensive because Method.equals() was doing a huge toString(). This was causing folks to see 2-3 seconds
33 | * startup time when configuring 10-15 DAOs because of 1000s of calls to @DatabaseField methods. See this Android bug report.
35 | *
36 | *
37 | *
38 | * I added this utility class which writes a configuration file into the raw resource "res/raw" directory inside of your
39 | * project containing the table and field names and associated details. This file can then be loaded into the
40 | * {@link DaoManager} with the help of the
41 | * {@link OrmLiteSqliteOpenHelper#OrmLiteSqliteOpenHelper(android.content.Context, String, android.database.sqlite.SQLiteDatabase.CursorFactory, int, int)}
42 | * constructor. This means that you can configure your classes _without_ any runtime calls to annotations. It seems
43 | * significantly faster.
44 | *
45 | *
46 | *
47 | * WARNING: Although this is fast, the big problem is that you have to remember to regenerate the config file
48 | * whenever you edit one of your database classes. There is no way that I know of to do this automagically.
49 | *
50 | *
51 | * @author graywatson
52 | */
53 | public class OrmLiteConfigUtil {
54 |
55 | /**
56 | * Resource directory name that we are looking for.
57 | */
58 | protected static final String RESOURCE_DIR_NAME = "res";
59 | /**
60 | * Raw directory name that we are looking for.
61 | */
62 | protected static final String RAW_DIR_NAME = "raw";
63 | public static final String HELP_COMMAND = "--help";
64 |
65 | /**
66 | * Maximum recursion level while we are looking for source files.
67 | */
68 | protected static int maxFindSourceLevel = 20;
69 |
70 | private static final DatabaseType databaseType = new SqliteAndroidDatabaseType();
71 |
72 | /**
73 | * A call through to {@link #writeConfigFile(String)} taking the file name from the single command line argument.
74 | */
75 | public static void main(String[] args) throws Exception {
76 | System.out.println("OrmLiteConfigUtil active");
77 | if (args.length > 2) {
78 | throw new IllegalArgumentException("TODO review that : Main can take 1 or 2 file-name argument.");
79 | }
80 |
81 | if (args.length == 0 || args[0].equals(HELP_COMMAND)) {
82 | System.out.println("OrmLiteConfigUtil is a Java app that can create ORM Lite configuration to boost ORMLite performances.\n");
83 | System.out.println("Usages: .\n");
84 | System.out.println("* ..OrmLiteConfigUtil .\n");
85 | System.out.println(" will generate the ORMLite config file and scan current folder for classes and res/raw dir.\n");
86 | System.out.println("* ..OrmLiteConfigUtil .\n");
87 | System.out.println(" will generate the ORMLite config file and scan the search directory for classes and res/raw dir.\n");
88 | }
89 | if (args.length == 1) {
90 | String configFileName = args[0];
91 | writeConfigFile(configFileName);
92 | } else {
93 | File configFile = new File(args[0]);
94 | File searchDir = new File(args[1]);
95 | writeConfigFile(configFile, searchDir);
96 | }
97 | System.out.println("OrmLiteConfigUtil done");
98 | }
99 |
100 | /**
101 | * Finds the annotated classes in the current directory or below and writes a configuration file to the file-name in
102 | * the raw folder.
103 | */
104 | public static void writeConfigFile(String fileName) throws SQLException, IOException {
105 | List> classList = new ArrayList>();
106 | findAnnotatedClasses(classList, new File("."), 0);
107 | writeConfigFile(fileName, classList.toArray(new Class[classList.size()]));
108 | }
109 |
110 | /**
111 | * Writes a configuration fileName in the raw directory with the configuration for classes.
112 | */
113 | public static void writeConfigFile(String fileName, Class>[] classes) throws SQLException, IOException {
114 | File rawDir = findRawDir(new File("."));
115 | if (rawDir == null) {
116 | System.err.println("Could not find " + RAW_DIR_NAME + " directory which is typically in the "
117 | + RESOURCE_DIR_NAME + " directory");
118 | } else {
119 | File configFile = new File(rawDir, fileName);
120 | writeConfigFile(configFile, classes);
121 | }
122 | }
123 |
124 | /**
125 | * Finds the annotated classes in the current directory or below and writes a configuration file.
126 | */
127 | public static void writeConfigFile(File configFile) throws SQLException, IOException {
128 | writeConfigFile(configFile, new File("."));
129 | }
130 |
131 | /**
132 | * Finds the annotated classes in the specified search directory or below and writes a configuration file.
133 | */
134 | public static void writeConfigFile(File configFile, File searchDir) throws SQLException, IOException {
135 | List> classList = new ArrayList>();
136 | findAnnotatedClasses(classList, searchDir, 0);
137 | writeConfigFile(configFile, classList.toArray(new Class[classList.size()]));
138 | }
139 |
140 | /**
141 | * Write a configuration file with the configuration for classes.
142 | */
143 | public static void writeConfigFile(File configFile, Class>[] classes) throws SQLException, IOException {
144 | System.out.println("Writing configurations to " + configFile.getAbsolutePath());
145 | writeConfigFile(new FileOutputStream(configFile), classes);
146 | }
147 |
148 | /**
149 | * Write a configuration file to an output stream with the configuration for classes.
150 | */
151 | public static void writeConfigFile(OutputStream outputStream, File searchDir) throws SQLException, IOException {
152 | List> classList = new ArrayList>();
153 | findAnnotatedClasses(classList, searchDir, 0);
154 | writeConfigFile(outputStream, classList.toArray(new Class[classList.size()]));
155 | }
156 |
157 | /**
158 | * Write a configuration file to an output stream with the configuration for classes.
159 | */
160 | public static void writeConfigFile(OutputStream outputStream, Class>[] classes) throws SQLException, IOException {
161 | BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(outputStream), 4096);
162 | try {
163 | for (Class> clazz : classes) {
164 | writeConfigForTable(writer, clazz);
165 | }
166 | // NOTE: done is here because this is public
167 | System.out.println("Done.");
168 | } finally {
169 | writer.close();
170 | }
171 | }
172 |
173 | /**
174 | * Look for the resource-directory in the current directory or the directories above. Then look for the
175 | * raw-directory underneath the resource-directory.
176 | */
177 | protected static File findRawDir(File dir) {
178 | for (int i = 0; dir != null && i < 20; i++) {
179 | File rawDir = findResRawDir(dir);
180 | if (rawDir != null) {
181 | return rawDir;
182 | }
183 | dir = dir.getParentFile();
184 | }
185 | return null;
186 | }
187 |
188 | private static void findAnnotatedClasses(List> classList, File dir, int level) throws SQLException,
189 | IOException {
190 | for (File file : dir.listFiles()) {
191 | if (file.isDirectory()) {
192 | // recurse if we aren't deep enough
193 | if (level < maxFindSourceLevel) {
194 | findAnnotatedClasses(classList, file, level + 1);
195 | }
196 | continue;
197 | }
198 | // skip non .java files
199 | if (!file.getName().endsWith(".java")) {
200 | continue;
201 | }
202 | String packageName = getPackageOfClass(file);
203 | if (packageName == null) {
204 | System.err.println("Could not find package name for: " + file);
205 | continue;
206 | }
207 | // get the filename and cut off the .java
208 | String name = file.getName();
209 | name = name.substring(0, name.length() - ".java".length());
210 | String className = packageName + "." + name;
211 | Class> clazz;
212 | try {
213 | clazz = Class.forName(className);
214 | } catch (Throwable t) {
215 | // amazingly, this sometimes throws an Error
216 | System.err.println("Could not load class file for: " + file);
217 | System.err.println(" " + t);
218 | continue;
219 | }
220 | if (classHasAnnotations(clazz)) {
221 | classList.add(clazz);
222 | }
223 | // handle inner classes
224 | try {
225 | for (Class> innerClazz : clazz.getDeclaredClasses()) {
226 | if (classHasAnnotations(innerClazz)) {
227 | classList.add(innerClazz);
228 | }
229 | }
230 | } catch (Throwable t) {
231 | // amazingly, this sometimes throws an Error
232 | System.err.println("Could not load inner classes for: " + clazz);
233 | System.err.println(" " + t);
234 | continue;
235 | }
236 | }
237 | }
238 |
239 | private static void writeConfigForTable(BufferedWriter writer, Class> clazz) throws SQLException, IOException {
240 | String tableName = DatabaseTableConfig.extractTableName(clazz);
241 | List fieldConfigs = new ArrayList();
242 | // walk up the classes finding the fields
243 | try {
244 | for (Class> working = clazz; working != null; working = working.getSuperclass()) {
245 | for (Field field : working.getDeclaredFields()) {
246 | DatabaseFieldConfig fieldConfig = DatabaseFieldConfig.fromField(databaseType, tableName, field);
247 | if (fieldConfig != null) {
248 | fieldConfigs.add(fieldConfig);
249 | }
250 | }
251 | }
252 | } catch (Error e) {
253 | System.err.println("Skipping " + clazz + " because we got an error finding its definition: "
254 | + e.getMessage());
255 | return;
256 | }
257 | if (fieldConfigs.isEmpty()) {
258 | System.out.println("Skipping " + clazz + " because no annotated fields found");
259 | return;
260 | }
261 | @SuppressWarnings({"rawtypes", "unchecked"})
262 | DatabaseTableConfig> tableConfig = new DatabaseTableConfig(clazz, tableName, fieldConfigs);
263 | DatabaseTableConfigLoader.write(writer, tableConfig);
264 | writer.append("#################################");
265 | writer.newLine();
266 | System.out.println("Wrote config for " + clazz);
267 | }
268 |
269 | private static boolean classHasAnnotations(Class> clazz) {
270 | while (clazz != null) {
271 | if (clazz.getAnnotation(DatabaseTable.class) != null) {
272 | return true;
273 | }
274 | Field[] fields;
275 | try {
276 | fields = clazz.getDeclaredFields();
277 | } catch (Throwable t) {
278 | // amazingly, this sometimes throws an Error
279 | System.err.println("Could not load get delcared fields from: " + clazz);
280 | System.err.println(" " + t);
281 | return false;
282 | }
283 | for (Field field : fields) {
284 | if (field.getAnnotation(DatabaseField.class) != null
285 | || field.getAnnotation(ForeignCollectionField.class) != null) {
286 | return true;
287 | }
288 | }
289 | try {
290 | clazz = clazz.getSuperclass();
291 | } catch (Throwable t) {
292 | // amazingly, this sometimes throws an Error
293 | System.err.println("Could not get super class for: " + clazz);
294 | System.err.println(" " + t);
295 | return false;
296 | }
297 | }
298 |
299 | return false;
300 | }
301 |
302 | /**
303 | * Returns the package name of a file that has one of the annotations we are looking for.
304 | *
305 | * @return Package prefix string or null or no annotations.
306 | */
307 | private static String getPackageOfClass(File file) throws IOException {
308 | BufferedReader reader = new BufferedReader(new FileReader(file));
309 | try {
310 | while (true) {
311 | String line = reader.readLine();
312 | if (line == null) {
313 | return null;
314 | }
315 | if (line.contains("package")) {
316 | String[] parts = line.split("[ \t;]");
317 | if (parts.length > 1 && parts[0].equals("package")) {
318 | return parts[1];
319 | }
320 | }
321 | }
322 | } finally {
323 | reader.close();
324 | }
325 | }
326 |
327 | /**
328 | * Look for the resource directory with raw beneath it.
329 | */
330 | private static File findResRawDir(File dir) {
331 | for (File file : dir.listFiles()) {
332 | if (file.getName().equals(RESOURCE_DIR_NAME) && file.isDirectory()) {
333 | File[] rawFiles = file.listFiles(new FileFilter() {
334 | public boolean accept(File file) {
335 | return file.getName().equals(RAW_DIR_NAME) && file.isDirectory();
336 | }
337 | });
338 | if (rawFiles.length == 1) {
339 | return rawFiles[0];
340 | }
341 | }
342 | }
343 | return null;
344 | }
345 | }
346 |
--------------------------------------------------------------------------------