KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > speedo > generation > api > SpeedoCompilerParameter


1 /**
2  * Speedo: an implementation of JDO compliant personality on top of JORM generic
3  * I/O sub-system.
4  * Copyright (C) 2001-2004 France Telecom R&D
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  *
21  *
22  * Contact: speedo@objectweb.org
23  *
24  * Authors: S.Chassande-Barrioz.
25  *
26  */
27
28 package org.objectweb.speedo.generation.api;
29
30 import org.apache.tools.ant.taskdefs.Javac;
31 import org.apache.tools.ant.types.Path;
32 import org.objectweb.speedo.metadata.SpeedoMetaInfo;
33 import org.objectweb.speedo.naming.lib.NamingManagerFactory;
34 import org.objectweb.util.monolog.api.LoggerFactory;
35
36 import java.util.ArrayList JavaDoc;
37 import java.util.Collection JavaDoc;
38 import java.util.Map JavaDoc;
39
40 /**
41  * This class groups all parameter of the Speedo generator/compiler/enhancer.
42  *
43  * @author S.Chassande-Barrioz
44  */
45 public class SpeedoCompilerParameter {
46
47     /**
48      * The logging configuration file
49      */
50     public String JavaDoc logPropFile = null;
51
52     /**
53      * The logger factory instance
54      */
55     public LoggerFactory loggerFactory = null;
56
57     /**
58      * The speedo configuration file
59      */
60     public String JavaDoc confFile = null;
61
62     /**
63      * The jorm project name. The default value is an empty string (not nul)
64      */
65     public String JavaDoc projectName = "";
66
67     /**
68      * The jorm mapper name. The default value is null. This field MUST be set
69      */
70     public String JavaDoc mapperName = null;
71
72     /**
73      * indicates if the generated java file must be kept or not
74      */
75     public boolean keepsrc = true;
76
77     /**
78      * the location of the user .class files
79      * the location where the generated files will be produced
80      */
81     public String JavaDoc output;
82
83     /**
84      * The default source directory
85      */
86     public String JavaDoc input;
87
88     public Collection JavaDoc jormclasspath = null;
89     public Path speedoclasspath = null;
90
91     /**
92      * indicates if the .pd files must be generated
93      */
94     public boolean generateNeededJormFile = false;
95
96     /**
97      * The output directory of the .pd files
98      */
99     public String JavaDoc pdoutput;
100
101     /**
102      * The Speedo meta information
103      */
104     public SpeedoMetaInfo smi = new SpeedoMetaInfo();
105
106     /**
107      * the classpath to compile. must include Jorm, Speedo, user classes.
108      */
109     public Path classpath = null;
110
111     /**
112      * The list of .jdo file locations. The location is relative to the value
113      * of the 'jdoDir' variable.
114      */
115     public Collection JavaDoc jdo = null;
116
117     /**
118      * The base directory of the location of .jdo file
119      */
120     public String JavaDoc jdoDir = null;
121
122     /**
123      * The list of .pd file locations. The location is relative to the value
124      * of the 'jormDir' variable.
125      */
126     public Collection JavaDoc jorm = null;
127
128     /**
129      * The base directory of the location of .pd file
130      */
131     public String JavaDoc jormDir = null;
132
133     /**
134      * The list of .class file locations of the aware class. The location is
135      * relative to the value of the 'jormDir' variable.
136      */
137     public Collection JavaDoc awareFiles = null;
138
139     /**
140      * The base directory of the location of .class of aware class
141      */
142     public String JavaDoc awareFilesDir = null;
143
144     /**
145      * list of DTDLocation instance
146      */
147     public ArrayList JavaDoc dtdLocations = new ArrayList JavaDoc();
148
149     /**
150      * The compiler to use
151      */
152     public Javac javac = null;
153
154     /**
155      * The NamingManagerFactory instance to use. It permits to build the jorm
156      * meta information.
157      */
158     public NamingManagerFactory nmf = new NamingManagerFactory();
159
160     public Map JavaDoc getXmldescriptor() {
161         return smi.xmldescriptor;
162     }
163
164     public void setXmldescriptor(Map JavaDoc xmldescriptor) {
165         smi.xmldescriptor = xmldescriptor;
166     }
167
168 }
169
Popular Tags