KickJava   Java API By Example, From Geeks To Geeks.

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


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.DimensionDefinitionLocationType;
15 import com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType;
16 import java.io.IOException JavaDoc;
17 import java.io.Reader JavaDoc;
18 import java.io.Serializable JavaDoc;
19 import java.io.Writer JavaDoc;
20 import org.exolab.castor.xml.MarshalException;
21 import org.exolab.castor.xml.Marshaller;
22 import org.exolab.castor.xml.Unmarshaller;
23 import org.exolab.castor.xml.ValidationException;
24 import org.xml.sax.ContentHandler JavaDoc;
25
26 /**
27  * Class DimensionDefinition.
28  *
29  * @version $Revision$ $Date$
30  */
31 public class DimensionDefinition implements java.io.Serializable JavaDoc {
32
33
34       //--------------------------/
35 //- Class/Member Variables -/
36 //--------------------------/
37
38     /**
39      * Field _name
40      */
41     private java.lang.String JavaDoc _name;
42
43     /**
44      * Field _description
45      */
46     private java.lang.String JavaDoc _description;
47
48     /**
49      * Field _location
50      */
51     private com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType _location;
52
53     /**
54      * Field _groups
55      */
56     private boolean _groups;
57
58     /**
59      * keeps track of state for field: _groups
60      */
61     private boolean _has_groups;
62
63     /**
64      * Field _groupFooterCaption
65      */
66     private java.lang.String JavaDoc _groupFooterCaption;
67
68     /**
69      * Field _order
70      */
71     private com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType _order;
72
73     /**
74      * Field _rankMetricName
75      */
76     private java.lang.String JavaDoc _rankMetricName;
77
78
79       //----------------/
80 //- Constructors -/
81 //----------------/
82
83     public DimensionDefinition() {
84         super();
85     } //-- com.calipso.reportgenerator.reportdefinitions.DimensionDefinition()
86
87
88       //-----------/
89 //- Methods -/
90 //-----------/
91
92     /**
93      * Method deleteGroups
94      */
95     public void deleteGroups()
96     {
97         this._has_groups= false;
98     } //-- void deleteGroups()
99
100     /**
101      * Method getDescriptionReturns the value of field
102      * 'description'.
103      *
104      * @return the value of field 'description'.
105      */
106     public java.lang.String JavaDoc getDescription()
107     {
108         return this._description;
109     } //-- java.lang.String getDescription()
110
111     /**
112      * Method getGroupFooterCaptionReturns the value of field
113      * 'groupFooterCaption'.
114      *
115      * @return the value of field 'groupFooterCaption'.
116      */
117     public java.lang.String JavaDoc getGroupFooterCaption()
118     {
119         return this._groupFooterCaption;
120     } //-- java.lang.String getGroupFooterCaption()
121
122     /**
123      * Method getGroupsReturns the value of field 'groups'.
124      *
125      * @return the value of field 'groups'.
126      */
127     public boolean getGroups()
128     {
129         return this._groups;
130     } //-- boolean getGroups()
131
132     /**
133      * Method getLocationReturns the value of field 'location'.
134      *
135      * @return the value of field 'location'.
136      */
137     public com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType getLocation()
138     {
139         return this._location;
140     } //-- com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType getLocation()
141
142     /**
143      * Method getNameReturns the value of field 'name'.
144      *
145      * @return the value of field 'name'.
146      */
147     public java.lang.String JavaDoc getName()
148     {
149         return this._name;
150     } //-- java.lang.String getName()
151
152     /**
153      * Method getOrderReturns the value of field 'order'.
154      *
155      * @return the value of field 'order'.
156      */
157     public com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType getOrder()
158     {
159         return this._order;
160     } //-- com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType getOrder()
161
162     /**
163      * Method getRankMetricNameReturns the value of field
164      * 'rankMetricName'.
165      *
166      * @return the value of field 'rankMetricName'.
167      */
168     public java.lang.String JavaDoc getRankMetricName()
169     {
170         return this._rankMetricName;
171     } //-- java.lang.String getRankMetricName()
172
173     /**
174      * Method hasGroups
175      */
176     public boolean hasGroups()
177     {
178         return this._has_groups;
179     } //-- boolean hasGroups()
180
181     /**
182      * Method isValid
183      */
184     public boolean isValid()
185     {
186         try {
187             validate();
188         }
189         catch (org.exolab.castor.xml.ValidationException vex) {
190             return false;
191         }
192         return true;
193     } //-- boolean isValid()
194
195     /**
196      * Method marshal
197      *
198      * @param out
199      */
200     public void marshal(java.io.Writer JavaDoc out)
201         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
202     {
203         
204         Marshaller.marshal(this, out);
205     } //-- void marshal(java.io.Writer)
206
207     /**
208      * Method marshal
209      *
210      * @param handler
211      */
212     public void marshal(org.xml.sax.ContentHandler JavaDoc handler)
213         throws java.io.IOException JavaDoc, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
214     {
215         
216         Marshaller.marshal(this, handler);
217     } //-- void marshal(org.xml.sax.ContentHandler)
218
219     /**
220      * Method setDescriptionSets the value of field 'description'.
221      *
222      * @param description the value of field 'description'.
223      */
224     public void setDescription(java.lang.String JavaDoc description)
225     {
226         this._description = description;
227     } //-- void setDescription(java.lang.String)
228
229     /**
230      * Method setGroupFooterCaptionSets the value of field
231      * 'groupFooterCaption'.
232      *
233      * @param groupFooterCaption the value of field
234      * 'groupFooterCaption'.
235      */
236     public void setGroupFooterCaption(java.lang.String JavaDoc groupFooterCaption)
237     {
238         this._groupFooterCaption = groupFooterCaption;
239     } //-- void setGroupFooterCaption(java.lang.String)
240
241     /**
242      * Method setGroupsSets the value of field 'groups'.
243      *
244      * @param groups the value of field 'groups'.
245      */
246     public void setGroups(boolean groups)
247     {
248         this._groups = groups;
249         this._has_groups = true;
250     } //-- void setGroups(boolean)
251
252     /**
253      * Method setLocationSets the value of field 'location'.
254      *
255      * @param location the value of field 'location'.
256      */
257     public void setLocation(com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType location)
258     {
259         this._location = location;
260     } //-- void setLocation(com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType)
261
262     /**
263      * Method setNameSets the value of field 'name'.
264      *
265      * @param name the value of field 'name'.
266      */
267     public void setName(java.lang.String JavaDoc name)
268     {
269         this._name = name;
270     } //-- void setName(java.lang.String)
271
272     /**
273      * Method setOrderSets the value of field 'order'.
274      *
275      * @param order the value of field 'order'.
276      */
277     public void setOrder(com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType order)
278     {
279         this._order = order;
280     } //-- void setOrder(com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType)
281
282     /**
283      * Method setRankMetricNameSets the value of field
284      * 'rankMetricName'.
285      *
286      * @param rankMetricName the value of field 'rankMetricName'.
287      */
288     public void setRankMetricName(java.lang.String JavaDoc rankMetricName)
289     {
290         this._rankMetricName = rankMetricName;
291     } //-- void setRankMetricName(java.lang.String)
292
293     /**
294      * Method unmarshal
295      *
296      * @param reader
297      */
298     public static com.calipso.reportgenerator.reportdefinitions.DimensionDefinition unmarshal(java.io.Reader JavaDoc reader)
299         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
300     {
301         return (com.calipso.reportgenerator.reportdefinitions.DimensionDefinition) Unmarshaller.unmarshal(com.calipso.reportgenerator.reportdefinitions.DimensionDefinition.class, reader);
302     } //-- com.calipso.reportgenerator.reportdefinitions.DimensionDefinition unmarshal(java.io.Reader)
303
304     /**
305      * Method validate
306      */
307     public void validate()
308         throws org.exolab.castor.xml.ValidationException
309     {
310         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
311         validator.validate(this);
312     } //-- void validate()
313
314 }
315
Popular Tags