001: /*
002: * This class was automatically generated with
003: * <a href="http://www.castor.org">Castor 0.9.4.3</a>, using an XML
004: * Schema.
005: * $Id$
006: */
007:
008: package com.calipso.reportgenerator.reportdefinitions;
009:
010: //---------------------------------/
011: //- Imported classes and packages -/
012: //---------------------------------/
013:
014: import com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType;
015: import com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType;
016: import java.io.IOException;
017: import java.io.Reader;
018: import java.io.Serializable;
019: import java.io.Writer;
020: import org.exolab.castor.xml.MarshalException;
021: import org.exolab.castor.xml.Marshaller;
022: import org.exolab.castor.xml.Unmarshaller;
023: import org.exolab.castor.xml.ValidationException;
024: import org.xml.sax.ContentHandler;
025:
026: /**
027: * Class DimensionDefinition.
028: *
029: * @version $Revision$ $Date$
030: */
031: public class DimensionDefinition implements java.io.Serializable {
032:
033: //--------------------------/
034: //- Class/Member Variables -/
035: //--------------------------/
036:
037: /**
038: * Field _name
039: */
040: private java.lang.String _name;
041:
042: /**
043: * Field _description
044: */
045: private java.lang.String _description;
046:
047: /**
048: * Field _location
049: */
050: private com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType _location;
051:
052: /**
053: * Field _groups
054: */
055: private boolean _groups;
056:
057: /**
058: * keeps track of state for field: _groups
059: */
060: private boolean _has_groups;
061:
062: /**
063: * Field _groupFooterCaption
064: */
065: private java.lang.String _groupFooterCaption;
066:
067: /**
068: * Field _order
069: */
070: private com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType _order;
071:
072: /**
073: * Field _rankMetricName
074: */
075: private java.lang.String _rankMetricName;
076:
077: //----------------/
078: //- Constructors -/
079: //----------------/
080:
081: public DimensionDefinition() {
082: super ();
083: } //-- com.calipso.reportgenerator.reportdefinitions.DimensionDefinition()
084:
085: //-----------/
086: //- Methods -/
087: //-----------/
088:
089: /**
090: * Method deleteGroups
091: */
092: public void deleteGroups() {
093: this ._has_groups = false;
094: } //-- void deleteGroups()
095:
096: /**
097: * Method getDescriptionReturns the value of field
098: * 'description'.
099: *
100: * @return the value of field 'description'.
101: */
102: public java.lang.String getDescription() {
103: return this ._description;
104: } //-- java.lang.String getDescription()
105:
106: /**
107: * Method getGroupFooterCaptionReturns the value of field
108: * 'groupFooterCaption'.
109: *
110: * @return the value of field 'groupFooterCaption'.
111: */
112: public java.lang.String getGroupFooterCaption() {
113: return this ._groupFooterCaption;
114: } //-- java.lang.String getGroupFooterCaption()
115:
116: /**
117: * Method getGroupsReturns the value of field 'groups'.
118: *
119: * @return the value of field 'groups'.
120: */
121: public boolean getGroups() {
122: return this ._groups;
123: } //-- boolean getGroups()
124:
125: /**
126: * Method getLocationReturns the value of field 'location'.
127: *
128: * @return the value of field 'location'.
129: */
130: public com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType getLocation() {
131: return this ._location;
132: } //-- com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType getLocation()
133:
134: /**
135: * Method getNameReturns the value of field 'name'.
136: *
137: * @return the value of field 'name'.
138: */
139: public java.lang.String getName() {
140: return this ._name;
141: } //-- java.lang.String getName()
142:
143: /**
144: * Method getOrderReturns the value of field 'order'.
145: *
146: * @return the value of field 'order'.
147: */
148: public com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType getOrder() {
149: return this ._order;
150: } //-- com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType getOrder()
151:
152: /**
153: * Method getRankMetricNameReturns the value of field
154: * 'rankMetricName'.
155: *
156: * @return the value of field 'rankMetricName'.
157: */
158: public java.lang.String getRankMetricName() {
159: return this ._rankMetricName;
160: } //-- java.lang.String getRankMetricName()
161:
162: /**
163: * Method hasGroups
164: */
165: public boolean hasGroups() {
166: return this ._has_groups;
167: } //-- boolean hasGroups()
168:
169: /**
170: * Method isValid
171: */
172: public boolean isValid() {
173: try {
174: validate();
175: } catch (org.exolab.castor.xml.ValidationException vex) {
176: return false;
177: }
178: return true;
179: } //-- boolean isValid()
180:
181: /**
182: * Method marshal
183: *
184: * @param out
185: */
186: public void marshal(java.io.Writer out)
187: throws org.exolab.castor.xml.MarshalException,
188: org.exolab.castor.xml.ValidationException {
189:
190: Marshaller.marshal(this , out);
191: } //-- void marshal(java.io.Writer)
192:
193: /**
194: * Method marshal
195: *
196: * @param handler
197: */
198: public void marshal(org.xml.sax.ContentHandler handler)
199: throws java.io.IOException,
200: org.exolab.castor.xml.MarshalException,
201: org.exolab.castor.xml.ValidationException {
202:
203: Marshaller.marshal(this , handler);
204: } //-- void marshal(org.xml.sax.ContentHandler)
205:
206: /**
207: * Method setDescriptionSets the value of field 'description'.
208: *
209: * @param description the value of field 'description'.
210: */
211: public void setDescription(java.lang.String description) {
212: this ._description = description;
213: } //-- void setDescription(java.lang.String)
214:
215: /**
216: * Method setGroupFooterCaptionSets the value of field
217: * 'groupFooterCaption'.
218: *
219: * @param groupFooterCaption the value of field
220: * 'groupFooterCaption'.
221: */
222: public void setGroupFooterCaption(
223: java.lang.String groupFooterCaption) {
224: this ._groupFooterCaption = groupFooterCaption;
225: } //-- void setGroupFooterCaption(java.lang.String)
226:
227: /**
228: * Method setGroupsSets the value of field 'groups'.
229: *
230: * @param groups the value of field 'groups'.
231: */
232: public void setGroups(boolean groups) {
233: this ._groups = groups;
234: this ._has_groups = true;
235: } //-- void setGroups(boolean)
236:
237: /**
238: * Method setLocationSets the value of field 'location'.
239: *
240: * @param location the value of field 'location'.
241: */
242: public void setLocation(
243: com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType location) {
244: this ._location = location;
245: } //-- void setLocation(com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionLocationType)
246:
247: /**
248: * Method setNameSets the value of field 'name'.
249: *
250: * @param name the value of field 'name'.
251: */
252: public void setName(java.lang.String name) {
253: this ._name = name;
254: } //-- void setName(java.lang.String)
255:
256: /**
257: * Method setOrderSets the value of field 'order'.
258: *
259: * @param order the value of field 'order'.
260: */
261: public void setOrder(
262: com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType order) {
263: this ._order = order;
264: } //-- void setOrder(com.calipso.reportgenerator.reportdefinitions.types.DimensionDefinitionOrderType)
265:
266: /**
267: * Method setRankMetricNameSets the value of field
268: * 'rankMetricName'.
269: *
270: * @param rankMetricName the value of field 'rankMetricName'.
271: */
272: public void setRankMetricName(java.lang.String rankMetricName) {
273: this ._rankMetricName = rankMetricName;
274: } //-- void setRankMetricName(java.lang.String)
275:
276: /**
277: * Method unmarshal
278: *
279: * @param reader
280: */
281: public static com.calipso.reportgenerator.reportdefinitions.DimensionDefinition unmarshal(
282: java.io.Reader reader)
283: throws org.exolab.castor.xml.MarshalException,
284: org.exolab.castor.xml.ValidationException {
285: return (com.calipso.reportgenerator.reportdefinitions.DimensionDefinition) Unmarshaller
286: .unmarshal(
287: com.calipso.reportgenerator.reportdefinitions.DimensionDefinition.class,
288: reader);
289: } //-- com.calipso.reportgenerator.reportdefinitions.DimensionDefinition unmarshal(java.io.Reader)
290:
291: /**
292: * Method validate
293: */
294: public void validate()
295: throws org.exolab.castor.xml.ValidationException {
296: org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
297: validator.validate(this );
298: } //-- void validate()
299:
300: }
|