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.DrillDownDefinitionTypeType;
015: import java.io.IOException;
016: import java.io.Reader;
017: import java.io.Serializable;
018: import java.io.Writer;
019: import java.util.Enumeration;
020: import java.util.Vector;
021: import org.exolab.castor.xml.MarshalException;
022: import org.exolab.castor.xml.Marshaller;
023: import org.exolab.castor.xml.Unmarshaller;
024: import org.exolab.castor.xml.ValidationException;
025: import org.xml.sax.ContentHandler;
026:
027: /**
028: * Class DrillDownDefinition.
029: *
030: * @version $Revision$ $Date$
031: */
032: public class DrillDownDefinition implements java.io.Serializable {
033:
034: //--------------------------/
035: //- Class/Member Variables -/
036: //--------------------------/
037:
038: /**
039: * Field _name
040: */
041: private java.lang.String _name;
042:
043: /**
044: * Field _description
045: */
046: private java.lang.String _description;
047:
048: /**
049: * Field _targetReportDefinitionID
050: */
051: private java.lang.String _targetReportDefinitionID;
052:
053: /**
054: * Field _type
055: */
056: private com.calipso.reportgenerator.reportdefinitions.types.DrillDownDefinitionTypeType _type = com.calipso.reportgenerator.reportdefinitions.types.DrillDownDefinitionTypeType
057: .valueOf("CUBE");
058:
059: /**
060: * Field _parameterBindList
061: */
062: private java.util.Vector _parameterBindList;
063:
064: /**
065: * Field _dimensionBindList
066: */
067: private java.util.Vector _dimensionBindList;
068:
069: //----------------/
070: //- Constructors -/
071: //----------------/
072:
073: public DrillDownDefinition() {
074: super ();
075: setType(com.calipso.reportgenerator.reportdefinitions.types.DrillDownDefinitionTypeType
076: .valueOf("CUBE"));
077: _parameterBindList = new Vector();
078: _dimensionBindList = new Vector();
079: } //-- com.calipso.reportgenerator.reportdefinitions.DrillDownDefinition()
080:
081: //-----------/
082: //- Methods -/
083: //-----------/
084:
085: /**
086: * Method addDimensionBind
087: *
088: * @param vDimensionBind
089: */
090: public void addDimensionBind(
091: com.calipso.reportgenerator.reportdefinitions.DimensionBind vDimensionBind)
092: throws java.lang.IndexOutOfBoundsException {
093: _dimensionBindList.addElement(vDimensionBind);
094: } //-- void addDimensionBind(com.calipso.reportgenerator.reportdefinitions.DimensionBind)
095:
096: /**
097: * Method addDimensionBind
098: *
099: * @param index
100: * @param vDimensionBind
101: */
102: public void addDimensionBind(
103: int index,
104: com.calipso.reportgenerator.reportdefinitions.DimensionBind vDimensionBind)
105: throws java.lang.IndexOutOfBoundsException {
106: _dimensionBindList.insertElementAt(vDimensionBind, index);
107: } //-- void addDimensionBind(int, com.calipso.reportgenerator.reportdefinitions.DimensionBind)
108:
109: /**
110: * Method addParameterBind
111: *
112: * @param vParameterBind
113: */
114: public void addParameterBind(
115: com.calipso.reportgenerator.reportdefinitions.ParameterBind vParameterBind)
116: throws java.lang.IndexOutOfBoundsException {
117: _parameterBindList.addElement(vParameterBind);
118: } //-- void addParameterBind(com.calipso.reportgenerator.reportdefinitions.ParameterBind)
119:
120: /**
121: * Method addParameterBind
122: *
123: * @param index
124: * @param vParameterBind
125: */
126: public void addParameterBind(
127: int index,
128: com.calipso.reportgenerator.reportdefinitions.ParameterBind vParameterBind)
129: throws java.lang.IndexOutOfBoundsException {
130: _parameterBindList.insertElementAt(vParameterBind, index);
131: } //-- void addParameterBind(int, com.calipso.reportgenerator.reportdefinitions.ParameterBind)
132:
133: /**
134: * Method enumerateDimensionBind
135: */
136: public java.util.Enumeration enumerateDimensionBind() {
137: return _dimensionBindList.elements();
138: } //-- java.util.Enumeration enumerateDimensionBind()
139:
140: /**
141: * Method enumerateParameterBind
142: */
143: public java.util.Enumeration enumerateParameterBind() {
144: return _parameterBindList.elements();
145: } //-- java.util.Enumeration enumerateParameterBind()
146:
147: /**
148: * Method getDescriptionReturns the value of field
149: * 'description'.
150: *
151: * @return the value of field 'description'.
152: */
153: public java.lang.String getDescription() {
154: return this ._description;
155: } //-- java.lang.String getDescription()
156:
157: /**
158: * Method getDimensionBind
159: *
160: * @param index
161: */
162: public com.calipso.reportgenerator.reportdefinitions.DimensionBind getDimensionBind(
163: int index) throws java.lang.IndexOutOfBoundsException {
164: //-- check bounds for index
165: if ((index < 0) || (index > _dimensionBindList.size())) {
166: throw new IndexOutOfBoundsException();
167: }
168:
169: return (com.calipso.reportgenerator.reportdefinitions.DimensionBind) _dimensionBindList
170: .elementAt(index);
171: } //-- com.calipso.reportgenerator.reportdefinitions.DimensionBind getDimensionBind(int)
172:
173: /**
174: * Method getDimensionBind
175: */
176: public com.calipso.reportgenerator.reportdefinitions.DimensionBind[] getDimensionBind() {
177: int size = _dimensionBindList.size();
178: com.calipso.reportgenerator.reportdefinitions.DimensionBind[] mArray = new com.calipso.reportgenerator.reportdefinitions.DimensionBind[size];
179: for (int index = 0; index < size; index++) {
180: mArray[index] = (com.calipso.reportgenerator.reportdefinitions.DimensionBind) _dimensionBindList
181: .elementAt(index);
182: }
183: return mArray;
184: } //-- com.calipso.reportgenerator.reportdefinitions.DimensionBind[] getDimensionBind()
185:
186: /**
187: * Method getDimensionBindCount
188: */
189: public int getDimensionBindCount() {
190: return _dimensionBindList.size();
191: } //-- int getDimensionBindCount()
192:
193: /**
194: * Method getNameReturns the value of field 'name'.
195: *
196: * @return the value of field 'name'.
197: */
198: public java.lang.String getName() {
199: return this ._name;
200: } //-- java.lang.String getName()
201:
202: /**
203: * Method getParameterBind
204: *
205: * @param index
206: */
207: public com.calipso.reportgenerator.reportdefinitions.ParameterBind getParameterBind(
208: int index) throws java.lang.IndexOutOfBoundsException {
209: //-- check bounds for index
210: if ((index < 0) || (index > _parameterBindList.size())) {
211: throw new IndexOutOfBoundsException();
212: }
213:
214: return (com.calipso.reportgenerator.reportdefinitions.ParameterBind) _parameterBindList
215: .elementAt(index);
216: } //-- com.calipso.reportgenerator.reportdefinitions.ParameterBind getParameterBind(int)
217:
218: /**
219: * Method getParameterBind
220: */
221: public com.calipso.reportgenerator.reportdefinitions.ParameterBind[] getParameterBind() {
222: int size = _parameterBindList.size();
223: com.calipso.reportgenerator.reportdefinitions.ParameterBind[] mArray = new com.calipso.reportgenerator.reportdefinitions.ParameterBind[size];
224: for (int index = 0; index < size; index++) {
225: mArray[index] = (com.calipso.reportgenerator.reportdefinitions.ParameterBind) _parameterBindList
226: .elementAt(index);
227: }
228: return mArray;
229: } //-- com.calipso.reportgenerator.reportdefinitions.ParameterBind[] getParameterBind()
230:
231: /**
232: * Method getParameterBindCount
233: */
234: public int getParameterBindCount() {
235: return _parameterBindList.size();
236: } //-- int getParameterBindCount()
237:
238: /**
239: * Method getTargetReportDefinitionIDReturns the value of field
240: * 'targetReportDefinitionID'.
241: *
242: * @return the value of field 'targetReportDefinitionID'.
243: */
244: public java.lang.String getTargetReportDefinitionID() {
245: return this ._targetReportDefinitionID;
246: } //-- java.lang.String getTargetReportDefinitionID()
247:
248: /**
249: * Method getTypeReturns the value of field 'type'.
250: *
251: * @return the value of field 'type'.
252: */
253: public com.calipso.reportgenerator.reportdefinitions.types.DrillDownDefinitionTypeType getType() {
254: return this ._type;
255: } //-- com.calipso.reportgenerator.reportdefinitions.types.DrillDownDefinitionTypeType getType()
256:
257: /**
258: * Method isValid
259: */
260: public boolean isValid() {
261: try {
262: validate();
263: } catch (org.exolab.castor.xml.ValidationException vex) {
264: return false;
265: }
266: return true;
267: } //-- boolean isValid()
268:
269: /**
270: * Method marshal
271: *
272: * @param out
273: */
274: public void marshal(java.io.Writer out)
275: throws org.exolab.castor.xml.MarshalException,
276: org.exolab.castor.xml.ValidationException {
277:
278: Marshaller.marshal(this , out);
279: } //-- void marshal(java.io.Writer)
280:
281: /**
282: * Method marshal
283: *
284: * @param handler
285: */
286: public void marshal(org.xml.sax.ContentHandler handler)
287: throws java.io.IOException,
288: org.exolab.castor.xml.MarshalException,
289: org.exolab.castor.xml.ValidationException {
290:
291: Marshaller.marshal(this , handler);
292: } //-- void marshal(org.xml.sax.ContentHandler)
293:
294: /**
295: * Method removeAllDimensionBind
296: */
297: public void removeAllDimensionBind() {
298: _dimensionBindList.removeAllElements();
299: } //-- void removeAllDimensionBind()
300:
301: /**
302: * Method removeAllParameterBind
303: */
304: public void removeAllParameterBind() {
305: _parameterBindList.removeAllElements();
306: } //-- void removeAllParameterBind()
307:
308: /**
309: * Method removeDimensionBind
310: *
311: * @param index
312: */
313: public com.calipso.reportgenerator.reportdefinitions.DimensionBind removeDimensionBind(
314: int index) {
315: java.lang.Object obj = _dimensionBindList.elementAt(index);
316: _dimensionBindList.removeElementAt(index);
317: return (com.calipso.reportgenerator.reportdefinitions.DimensionBind) obj;
318: } //-- com.calipso.reportgenerator.reportdefinitions.DimensionBind removeDimensionBind(int)
319:
320: /**
321: * Method removeParameterBind
322: *
323: * @param index
324: */
325: public com.calipso.reportgenerator.reportdefinitions.ParameterBind removeParameterBind(
326: int index) {
327: java.lang.Object obj = _parameterBindList.elementAt(index);
328: _parameterBindList.removeElementAt(index);
329: return (com.calipso.reportgenerator.reportdefinitions.ParameterBind) obj;
330: } //-- com.calipso.reportgenerator.reportdefinitions.ParameterBind removeParameterBind(int)
331:
332: /**
333: * Method setDescriptionSets the value of field 'description'.
334: *
335: * @param description the value of field 'description'.
336: */
337: public void setDescription(java.lang.String description) {
338: this ._description = description;
339: } //-- void setDescription(java.lang.String)
340:
341: /**
342: * Method setDimensionBind
343: *
344: * @param index
345: * @param vDimensionBind
346: */
347: public void setDimensionBind(
348: int index,
349: com.calipso.reportgenerator.reportdefinitions.DimensionBind vDimensionBind)
350: throws java.lang.IndexOutOfBoundsException {
351: //-- check bounds for index
352: if ((index < 0) || (index > _dimensionBindList.size())) {
353: throw new IndexOutOfBoundsException();
354: }
355: _dimensionBindList.setElementAt(vDimensionBind, index);
356: } //-- void setDimensionBind(int, com.calipso.reportgenerator.reportdefinitions.DimensionBind)
357:
358: /**
359: * Method setDimensionBind
360: *
361: * @param dimensionBindArray
362: */
363: public void setDimensionBind(
364: com.calipso.reportgenerator.reportdefinitions.DimensionBind[] dimensionBindArray) {
365: //-- copy array
366: _dimensionBindList.removeAllElements();
367: for (int i = 0; i < dimensionBindArray.length; i++) {
368: _dimensionBindList.addElement(dimensionBindArray[i]);
369: }
370: } //-- void setDimensionBind(com.calipso.reportgenerator.reportdefinitions.DimensionBind)
371:
372: /**
373: * Method setNameSets the value of field 'name'.
374: *
375: * @param name the value of field 'name'.
376: */
377: public void setName(java.lang.String name) {
378: this ._name = name;
379: } //-- void setName(java.lang.String)
380:
381: /**
382: * Method setParameterBind
383: *
384: * @param index
385: * @param vParameterBind
386: */
387: public void setParameterBind(
388: int index,
389: com.calipso.reportgenerator.reportdefinitions.ParameterBind vParameterBind)
390: throws java.lang.IndexOutOfBoundsException {
391: //-- check bounds for index
392: if ((index < 0) || (index > _parameterBindList.size())) {
393: throw new IndexOutOfBoundsException();
394: }
395: _parameterBindList.setElementAt(vParameterBind, index);
396: } //-- void setParameterBind(int, com.calipso.reportgenerator.reportdefinitions.ParameterBind)
397:
398: /**
399: * Method setParameterBind
400: *
401: * @param parameterBindArray
402: */
403: public void setParameterBind(
404: com.calipso.reportgenerator.reportdefinitions.ParameterBind[] parameterBindArray) {
405: //-- copy array
406: _parameterBindList.removeAllElements();
407: for (int i = 0; i < parameterBindArray.length; i++) {
408: _parameterBindList.addElement(parameterBindArray[i]);
409: }
410: } //-- void setParameterBind(com.calipso.reportgenerator.reportdefinitions.ParameterBind)
411:
412: /**
413: * Method setTargetReportDefinitionIDSets the value of field
414: * 'targetReportDefinitionID'.
415: *
416: * @param targetReportDefinitionID the value of field
417: * 'targetReportDefinitionID'.
418: */
419: public void setTargetReportDefinitionID(
420: java.lang.String targetReportDefinitionID) {
421: this ._targetReportDefinitionID = targetReportDefinitionID;
422: } //-- void setTargetReportDefinitionID(java.lang.String)
423:
424: /**
425: * Method setTypeSets the value of field 'type'.
426: *
427: * @param type the value of field 'type'.
428: */
429: public void setType(
430: com.calipso.reportgenerator.reportdefinitions.types.DrillDownDefinitionTypeType type) {
431: this ._type = type;
432: } //-- void setType(com.calipso.reportgenerator.reportdefinitions.types.DrillDownDefinitionTypeType)
433:
434: /**
435: * Method unmarshal
436: *
437: * @param reader
438: */
439: public static com.calipso.reportgenerator.reportdefinitions.DrillDownDefinition unmarshal(
440: java.io.Reader reader)
441: throws org.exolab.castor.xml.MarshalException,
442: org.exolab.castor.xml.ValidationException {
443: return (com.calipso.reportgenerator.reportdefinitions.DrillDownDefinition) Unmarshaller
444: .unmarshal(
445: com.calipso.reportgenerator.reportdefinitions.DrillDownDefinition.class,
446: reader);
447: } //-- com.calipso.reportgenerator.reportdefinitions.DrillDownDefinition unmarshal(java.io.Reader)
448:
449: /**
450: * Method validate
451: */
452: public void validate()
453: throws org.exolab.castor.xml.ValidationException {
454: org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
455: validator.validate(this );
456: } //-- void validate()
457:
458: }
|