KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > calipso > reportgenerator > reportdefinitions > MetricSourceDefinition


1 /*
2  * This class was automatically generated with
3  * <a HREF="http://www.castor.org">Castor 0.9.4.3</a>, using an XML
4  * Schema.
5  * $Id$
6  */

7
8 package com.calipso.reportgenerator.reportdefinitions;
9
10   //---------------------------------/
11
//- Imported classes and packages -/
12
//---------------------------------/
13

14 import com.calipso.reportgenerator.reportdefinitions.types.CalculationType;
15 import java.io.IOException JavaDoc;
16 import java.io.Reader JavaDoc;
17 import java.io.Serializable JavaDoc;
18 import java.io.Writer JavaDoc;
19 import org.exolab.castor.xml.MarshalException;
20 import org.exolab.castor.xml.Marshaller;
21 import org.exolab.castor.xml.Unmarshaller;
22 import org.exolab.castor.xml.ValidationException;
23 import org.xml.sax.ContentHandler JavaDoc;
24
25 /**
26  * Class MetricSourceDefinition.
27  *
28  * @version $Revision$ $Date$
29  */

30 public class MetricSourceDefinition implements java.io.Serializable JavaDoc {
31
32
33       //--------------------------/
34
//- Class/Member Variables -/
35
//--------------------------/
36

37     /**
38      * Field _name
39      */

40     private java.lang.String JavaDoc _name;
41
42     /**
43      * Field _description
44      */

45     private java.lang.String JavaDoc _description;
46
47     /**
48      * Field _aggregateType
49      */

50     private com.calipso.reportgenerator.reportdefinitions.types.CalculationType _aggregateType;
51
52     /**
53      * Field _groupFooterType
54      */

55     private com.calipso.reportgenerator.reportdefinitions.types.CalculationType _groupFooterType;
56
57     /**
58      * Field _calculated
59      */

60     private boolean _calculated;
61
62     /**
63      * keeps track of state for field: _calculated
64      */

65     private boolean _has_calculated;
66
67     /**
68      * Field _aggregateFunction
69      */

70     private java.lang.String JavaDoc _aggregateFunction;
71
72     /**
73      * Field _groupFooterFunction
74      */

75     private java.lang.String JavaDoc _groupFooterFunction;
76
77     /**
78      * Field _externalData
79      */

80     private java.lang.String JavaDoc _externalData;
81
82     /**
83      * Field _externalCalculated
84      */

85     private boolean _externalCalculated;
86
87     /**
88      * keeps track of state for field: _externalCalculated
89      */

90     private boolean _has_externalCalculated;
91
92
93       //----------------/
94
//- Constructors -/
95
//----------------/
96

97     public MetricSourceDefinition() {
98         super();
99     } //-- com.calipso.reportgenerator.reportdefinitions.MetricSourceDefinition()
100

101
102       //-----------/
103
//- Methods -/
104
//-----------/
105

106     /**
107      * Method deleteCalculated
108      */

109     public void deleteCalculated()
110     {
111         this._has_calculated= false;
112     } //-- void deleteCalculated()
113

114     /**
115      * Method deleteExternalCalculated
116      */

117     public void deleteExternalCalculated()
118     {
119         this._has_externalCalculated= false;
120     } //-- void deleteExternalCalculated()
121

122     /**
123      * Method getAggregateFunctionReturns the value of field
124      * 'aggregateFunction'.
125      *
126      * @return the value of field 'aggregateFunction'.
127      */

128     public java.lang.String JavaDoc getAggregateFunction()
129     {
130         return this._aggregateFunction;
131     } //-- java.lang.String getAggregateFunction()
132

133     /**
134      * Method getAggregateTypeReturns the value of field
135      * 'aggregateType'.
136      *
137      * @return the value of field 'aggregateType'.
138      */

139     public com.calipso.reportgenerator.reportdefinitions.types.CalculationType getAggregateType()
140     {
141         return this._aggregateType;
142     } //-- com.calipso.reportgenerator.reportdefinitions.types.CalculationType getAggregateType()
143

144     /**
145      * Method getCalculatedReturns the value of field 'calculated'.
146      *
147      * @return the value of field 'calculated'.
148      */

149     public boolean getCalculated()
150     {
151         return this._calculated;
152     } //-- boolean getCalculated()
153

154     /**
155      * Method getDescriptionReturns the value of field
156      * 'description'.
157      *
158      * @return the value of field 'description'.
159      */

160     public java.lang.String JavaDoc getDescription()
161     {
162         return this._description;
163     } //-- java.lang.String getDescription()
164

165     /**
166      * Method getExternalCalculatedReturns the value of field
167      * 'externalCalculated'.
168      *
169      * @return the value of field 'externalCalculated'.
170      */

171     public boolean getExternalCalculated()
172     {
173         return this._externalCalculated;
174     } //-- boolean getExternalCalculated()
175

176     /**
177      * Method getExternalDataReturns the value of field
178      * 'externalData'.
179      *
180      * @return the value of field 'externalData'.
181      */

182     public java.lang.String JavaDoc getExternalData()
183     {
184         return this._externalData;
185     } //-- java.lang.String getExternalData()
186

187     /**
188      * Method getGroupFooterFunctionReturns the value of field
189      * 'groupFooterFunction'.
190      *
191      * @return the value of field 'groupFooterFunction'.
192      */

193     public java.lang.String JavaDoc getGroupFooterFunction()
194     {
195         return this._groupFooterFunction;
196     } //-- java.lang.String getGroupFooterFunction()
197

198     /**
199      * Method getGroupFooterTypeReturns the value of field
200      * 'groupFooterType'.
201      *
202      * @return the value of field 'groupFooterType'.
203      */

204     public com.calipso.reportgenerator.reportdefinitions.types.CalculationType getGroupFooterType()
205     {
206         return this._groupFooterType;
207     } //-- com.calipso.reportgenerator.reportdefinitions.types.CalculationType getGroupFooterType()
208

209     /**
210      * Method getNameReturns the value of field 'name'.
211      *
212      * @return the value of field 'name'.
213      */

214     public java.lang.String JavaDoc getName()
215     {
216         return this._name;
217     } //-- java.lang.String getName()
218

219     /**
220      * Method hasCalculated
221      */

222     public boolean hasCalculated()
223     {
224         return this._has_calculated;
225     } //-- boolean hasCalculated()
226

227     /**
228      * Method hasExternalCalculated
229      */

230     public boolean hasExternalCalculated()
231     {
232         return this._has_externalCalculated;
233     } //-- boolean hasExternalCalculated()
234

235     /**
236      * Method isValid
237      */

238     public boolean isValid()
239     {
240         try {
241             validate();
242         }
243         catch (org.exolab.castor.xml.ValidationException vex) {
244             return false;
245         }
246         return true;
247     } //-- boolean isValid()
248

249     /**
250      * Method marshal
251      *
252      * @param out
253      */

254     public void marshal(java.io.Writer JavaDoc out)
255         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
256     {
257         
258         Marshaller.marshal(this, out);
259     } //-- void marshal(java.io.Writer)
260

261     /**
262      * Method marshal
263      *
264      * @param handler
265      */

266     public void marshal(org.xml.sax.ContentHandler JavaDoc handler)
267         throws java.io.IOException JavaDoc, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
268     {
269         
270         Marshaller.marshal(this, handler);
271     } //-- void marshal(org.xml.sax.ContentHandler)
272

273     /**
274      * Method setAggregateFunctionSets the value of field
275      * 'aggregateFunction'.
276      *
277      * @param aggregateFunction the value of field
278      * 'aggregateFunction'.
279      */

280     public void setAggregateFunction(java.lang.String JavaDoc aggregateFunction)
281     {
282         this._aggregateFunction = aggregateFunction;
283     } //-- void setAggregateFunction(java.lang.String)
284

285     /**
286      * Method setAggregateTypeSets the value of field
287      * 'aggregateType'.
288      *
289      * @param aggregateType the value of field 'aggregateType'.
290      */

291     public void setAggregateType(com.calipso.reportgenerator.reportdefinitions.types.CalculationType aggregateType)
292     {
293         this._aggregateType = aggregateType;
294     } //-- void setAggregateType(com.calipso.reportgenerator.reportdefinitions.types.CalculationType)
295

296     /**
297      * Method setCalculatedSets the value of field 'calculated'.
298      *
299      * @param calculated the value of field 'calculated'.
300      */

301     public void setCalculated(boolean calculated)
302     {
303         this._calculated = calculated;
304         this._has_calculated = true;
305     } //-- void setCalculated(boolean)
306

307     /**
308      * Method setDescriptionSets the value of field 'description'.
309      *
310      * @param description the value of field 'description'.
311      */

312     public void setDescription(java.lang.String JavaDoc description)
313     {
314         this._description = description;
315     } //-- void setDescription(java.lang.String)
316

317     /**
318      * Method setExternalCalculatedSets the value of field
319      * 'externalCalculated'.
320      *
321      * @param externalCalculated the value of field
322      * 'externalCalculated'.
323      */

324     public void setExternalCalculated(boolean externalCalculated)
325     {
326         this._externalCalculated = externalCalculated;
327         this._has_externalCalculated = true;
328     } //-- void setExternalCalculated(boolean)
329

330     /**
331      * Method setExternalDataSets the value of field
332      * 'externalData'.
333      *
334      * @param externalData the value of field 'externalData'.
335      */

336     public void setExternalData(java.lang.String JavaDoc externalData)
337     {
338         this._externalData = externalData;
339     } //-- void setExternalData(java.lang.String)
340

341     /**
342      * Method setGroupFooterFunctionSets the value of field
343      * 'groupFooterFunction'.
344      *
345      * @param groupFooterFunction the value of field
346      * 'groupFooterFunction'.
347      */

348     public void setGroupFooterFunction(java.lang.String JavaDoc groupFooterFunction)
349     {
350         this._groupFooterFunction = groupFooterFunction;
351     } //-- void setGroupFooterFunction(java.lang.String)
352

353     /**
354      * Method setGroupFooterTypeSets the value of field
355      * 'groupFooterType'.
356      *
357      * @param groupFooterType the value of field 'groupFooterType'.
358      */

359     public void setGroupFooterType(com.calipso.reportgenerator.reportdefinitions.types.CalculationType groupFooterType)
360     {
361         this._groupFooterType = groupFooterType;
362     } //-- void setGroupFooterType(com.calipso.reportgenerator.reportdefinitions.types.CalculationType)
363

364     /**
365      * Method setNameSets the value of field 'name'.
366      *
367      * @param name the value of field 'name'.
368      */

369     public void setName(java.lang.String JavaDoc name)
370     {
371         this._name = name;
372     } //-- void setName(java.lang.String)
373

374     /**
375      * Method unmarshal
376      *
377      * @param reader
378      */

379     public static com.calipso.reportgenerator.reportdefinitions.MetricSourceDefinition unmarshal(java.io.Reader JavaDoc reader)
380         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
381     {
382         return (com.calipso.reportgenerator.reportdefinitions.MetricSourceDefinition) Unmarshaller.unmarshal(com.calipso.reportgenerator.reportdefinitions.MetricSourceDefinition.class, reader);
383     } //-- com.calipso.reportgenerator.reportdefinitions.MetricSourceDefinition unmarshal(java.io.Reader)
384

385     /**
386      * Method validate
387      */

388     public void validate()
389         throws org.exolab.castor.xml.ValidationException
390     {
391         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
392         validator.validate(this);
393     } //-- void validate()
394

395 }
396
Popular Tags