/[schmitzm]/trunk/readme.txt
ViewVC logotype

Annotation of /trunk/readme.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1444 - (hide annotations)
Thu Jan 27 13:24:34 2011 UTC (14 years, 1 month ago) by mojays
File MIME type: text/plain
File size: 4704 byte(s)


1 mojays 1441 ==============================================================
2     === SCHMITZM README (2011-01-27, 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 mojays 1442 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 mojays 1441
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-gt
30     Contains extensions for Geotools with depencency to
31     schmitzm-core and Geotools.
32    
33     * schmitzm-jfree
34     COntains extensions for core JFreeChart with depencency
35     to schmitzm-core and JFreeChart.
36    
37     * schmitzm-jfree-gt
38     Contains geo-extensions for JFreeChart (create chart from
39     shapefile) so there are depencencies to schmitzm-core,
40     schmitzm-jfree and schmitzm-gt.
41    
42    
43     -----------------------------------------------------------
44     (2) Dependencies to other libraries
45     -----------------------------------------------------------
46     Because SCHMITZM is not an executable application, but an
47     library for experienced programmers, I renounced to put all
48     necessary libraries to the project.
49     Since SCHMITZM is compatible with MAVEN from version 2.1 upward,
50 mojays 1444 this should no longer be a big problem.
51     For these users who do not want to use MAVEN (I also resist for
52     a long time!), here is an overview. I expect that the SCHMITZM
53     developer/builder is able to include these dependencies to its
54     individual Java (Eclipse) project:
55 mojays 1441
56     * schmitzm-core
57     - JRE/JDK 1.6 (http://www.oracle.com/technetwork/java)
58     - JAI plus ImageIO (if not already included in your JRE/JDK)
59     - JavaX-Mail (http://www.oracle.com/technetwork/java/javamail/index.html)
60     - JNLP (http://www.oracle.com/technetwork/java/javase/javawebstart/index.html)
61     - JINI (jini-ext-2.1.jar)
62     - Apache Log4j (http://logging.apache.org/log4j/)
63     - Apache Commons CLI (http://commons.apache.org/cli/)
64     - Apache Commons IO (http://commons.apache.org/io/)
65     - JDom (http://www.jdom.org/)
66     - MigLayout (http://www.miglayout.com/)
67    
68     * schmitzm-gt
69     - schmitzm-core
70     - Geotools 2.6.5 (http://www.geotools.org)
71     - Colt (http://acs.lbl.gov/~hoschek/colt/)
72     Note: Because gt2-2.6.5 already includes jai_codec-1.1.3.jar and
73     jai_imageio-1.1.jar it is recommended only to include from
74     JAI:
75     - clipwrapper_jiio.jar
76     - jai_core.jar
77     - mlibwrapper_jai.jar
78    
79     * schmitzm-jfree
80     - schmitzm-core
81     - jFreeChart (http://www.jfree.org/jfreechart/)
82    
83     * schmitzm-jfree-gt
84     - schmitzm-core
85     - schmitzm-jfree
86     - schmitzm-gt
87    
88     -----------------------------------------------------------
89     (3) Localization in SCHMITZM library
90     -----------------------------------------------------------
91     Localization is done by the SCHMITZM class ResourceProvider, which is
92     an extension to standard Java ResourceBundle.
93     For example ResourceProvider.getString(..) allowes to specify
94     additional parameters to fill wildcards ${0}, ${1}, ${2}, ... in the
95     localization strings (see ResourceProvider class for more details).
96    
97     The SCHMITZM library contains resource bundles in the following
98     packages, each located in sub-folders <package>/resource/locales (below
99     src/main/resources of each module):
100    
101     - de.schmitzm.data -> DataResourceBundle
102     - de.schmitzm.lang -> LangResourceBundle
103     - de.schmitzm.swing -> SwingResourceBundle
104     - de.schmitzm.geotools.feature -> FeatureResourceBundle
105     - de.schmitzm.geotools.gui -> GTResourceBundle
106     - de.schmitzm.jfree -> JFreeResourceBundle
107    
108     If you want SCHMITZM to provide an additional language, you have to
109     translate all of these ResourceBundles.
110    
111    
112     ===========================================================
113     http://wald.intevation.org/projects/xulu/
114     http://wald.intevation.org/projects/schmitzm/
115     ===========================================================

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26