| 1 |
============================================================== |
| 2 |
=== SCHMITZM README (2012-09-25, Martin Schmitz) === |
| 3 |
=== === |
| 4 |
=== http://wald.intevation.org/projects/xulu/ === |
| 5 |
=== http://wald.intevation.org/projects/schmitzm/ === |
| 6 |
============================================================== |
| 7 |
|
| 8 |
This file contains some informations about... |
| 9 |
|
| 10 |
(1) the structure of the SCHMITZM library |
| 11 |
(2) the dependencies of the SCHMITZM library |
| 12 |
(3) localization in SCHMITZM |
| 13 |
|
| 14 |
----------------------------------------------------------- |
| 15 |
(1) Structure of the SCHMITZM library |
| 16 |
----------------------------------------------------------- |
| 17 |
SCHMITZM is not an executable program, but an library with |
| 18 |
many extensions for standard JDK, Geotools, JFreeChart and |
| 19 |
many more. |
| 20 |
To confine library dependencies for the use in other (application) |
| 21 |
projects the SCHMITZM library is divided into 4 modules, since |
| 22 |
version 2.5-SNAPSHOT: |
| 23 |
|
| 24 |
* schmitzm-core |
| 25 |
Contains core functionalities with only dependencies to |
| 26 |
JDK and (small) core libraries (e.g. MigLayout, Log4J, |
| 27 |
JDom, ...). |
| 28 |
|
| 29 |
* schmitzm-db |
| 30 |
Contains extensions and utilities for Postgres DB with |
| 31 |
depencency to schmitzm-core and Postgres. |
| 32 |
|
| 33 |
* schmitzm-excelcsv |
| 34 |
Contains extensions for Excel/CSV work with depencency to |
| 35 |
schmitzm-core, SuperCSV and JExcelApi. |
| 36 |
|
| 37 |
* schmitzm-gt |
| 38 |
Contains extensions for Geotools with depencency to |
| 39 |
schmitzm-core and Geotools. |
| 40 |
|
| 41 |
* schmitzm-jfree |
| 42 |
COntains extensions for core JFreeChart with depencency |
| 43 |
to schmitzm-core and JFreeChart. |
| 44 |
|
| 45 |
* schmitzm-jfree-gt |
| 46 |
Contains geo-extensions for JFreeChart (create chart from |
| 47 |
shapefile) so there are depencencies to schmitzm-core, |
| 48 |
schmitzm-jfree and schmitzm-gt. |
| 49 |
|
| 50 |
* schmitzm-addresses |
| 51 |
Utility methods for address maintainance with dependencies |
| 52 |
to schmitzm-core and schmitzm-excelcsv. |
| 53 |
|
| 54 |
* schmitzm-parent |
| 55 |
Technical parent project to implement commen dependencies |
| 56 |
for all sub-projects: |
| 57 |
- JUnit |
| 58 |
- Log4j |
| 59 |
|
| 60 |
|
| 61 |
----------------------------------------------------------- |
| 62 |
(2) Dependencies to other libraries |
| 63 |
----------------------------------------------------------- |
| 64 |
Because SCHMITZM is not an executable application, but an |
| 65 |
library for experienced programmers, I renounced to put all |
| 66 |
necessary libraries to the project. |
| 67 |
Since SCHMITZM is compatible with MAVEN from version 2.1 upward, |
| 68 |
this should no longer be a big problem. |
| 69 |
For these users who do not want to use MAVEN (I also resist for |
| 70 |
a long time!), here is an overview. I expect that the SCHMITZM |
| 71 |
developer/builder is able to include these dependencies to its |
| 72 |
individual Java (Eclipse) project: |
| 73 |
|
| 74 |
* schmitzm-core |
| 75 |
- JRE/JDK 1.6 (http://www.oracle.com/technetwork/java) |
| 76 |
- JAI plus ImageIO (if not already included in your JRE/JDK) |
| 77 |
- JavaX-Mail (http://www.oracle.com/technetwork/java/javamail/index.html) |
| 78 |
- JNLP (http://www.oracle.com/technetwork/java/javase/javawebstart/index.html) |
| 79 |
- JINI (jini-ext-2.1.jar) |
| 80 |
- Apache Log4j (http://logging.apache.org/log4j/) |
| 81 |
- Apache Commons CLI (http://commons.apache.org/cli/) |
| 82 |
- Apache Commons IO (http://commons.apache.org/io/) |
| 83 |
- Apache Commons Lang (http://commons.apache.org/lang/) |
| 84 |
- Apache Lucene (http://lucene.apache.org/solr/) |
| 85 |
- JDom (http://www.jdom.org/) |
| 86 |
- MigLayout (http://www.miglayout.com/) |
| 87 |
- JCalendar (http://www.toedter.com/en/jcalendar/) |
| 88 |
|
| 89 |
* schmitzm-db |
| 90 |
- schmitzm-core |
| 91 |
- PostgreSQL (http://jdbc.postgresql.org/) |
| 92 |
|
| 93 |
* schmitzm-excelcsv |
| 94 |
- schmitzm-core |
| 95 |
- JExcelApi (http://jexcelapi.sourceforge.net/) |
| 96 |
- SuperCSV (http://supercsv.sourceforge.net/) |
| 97 |
|
| 98 |
* schmitzm-gt |
| 99 |
- schmitzm-core |
| 100 |
- Geotools 2.7.5 (http://www.geotools.org) |
| 101 |
- Colt (http://acs.lbl.gov/~hoschek/colt/) |
| 102 |
Note: Because gt2-2.7.x already includes jai_codec-1.1.3.jar and |
| 103 |
jai_imageio-1.1.jar it is recommended only to include from |
| 104 |
JAI: |
| 105 |
- clipwrapper_jiio.jar |
| 106 |
- jai_core.jar |
| 107 |
- mlibwrapper_jai.jar |
| 108 |
|
| 109 |
* schmitzm-jfree |
| 110 |
- schmitzm-core |
| 111 |
- jFreeChart (http://www.jfree.org/jfreechart/) |
| 112 |
|
| 113 |
* schmitzm-jfree-gt |
| 114 |
- schmitzm-core |
| 115 |
- schmitzm-jfree |
| 116 |
- schmitzm-gt |
| 117 |
|
| 118 |
* schmitzm-addresses |
| 119 |
- schmitzm-core |
| 120 |
- schmitzm-excelcsv |
| 121 |
|
| 122 |
----------------------------------------------------------- |
| 123 |
(3) Localization in SCHMITZM library |
| 124 |
----------------------------------------------------------- |
| 125 |
Localization is done by the SCHMITZM class ResourceProvider, which is |
| 126 |
an extension to standard Java ResourceBundle. |
| 127 |
For example ResourceProvider.getString(..) allowes to specify |
| 128 |
additional parameters to fill wildcards ${0}, ${1}, ${2}, ... in the |
| 129 |
localization strings (see ResourceProvider class for more details). |
| 130 |
|
| 131 |
The SCHMITZM library contains resource bundles in the following |
| 132 |
packages, each located in sub-folders <package>/resource/locales (below |
| 133 |
src/main/resources of each module): |
| 134 |
|
| 135 |
- de.schmitzm.data -> DataResourceBundle |
| 136 |
- de.schmitzm.lang -> LangResourceBundle |
| 137 |
- de.schmitzm.swing -> SwingResourceBundle |
| 138 |
- de.schmitzm.net.mail -> MailResourceBundle |
| 139 |
- de.schmitzm.geotools.feature -> FeatureResourceBundle |
| 140 |
- de.schmitzm.geotools.gui -> GTResourceBundle |
| 141 |
- de.schmitzm.jfree -> JFreeResourceBundle |
| 142 |
|
| 143 |
If you want SCHMITZM to provide an additional language, you have to |
| 144 |
translate all of these ResourceBundles. |
| 145 |
|
| 146 |
|
| 147 |
=========================================================== |
| 148 |
http://wald.intevation.org/projects/xulu/ |
| 149 |
http://wald.intevation.org/projects/schmitzm/ |
| 150 |
=========================================================== |
| 151 |
|
| 152 |
|
Parent Directory
| 
Revision Log