KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.io.IOException JavaDoc;
15 import java.io.Reader JavaDoc;
16 import java.io.Serializable JavaDoc;
17 import java.io.Writer JavaDoc;
18 import java.util.Enumeration JavaDoc;
19 import java.util.Vector 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 MetricDefinitions.
28  *
29  * @version $Revision$ $Date$
30  */
31 public class MetricDefinitions implements java.io.Serializable JavaDoc {
32
33
34       //--------------------------/
35 //- Class/Member Variables -/
36 //--------------------------/
37
38     /**
39      * Field _metricDefinitionList
40      */
41     private java.util.Vector JavaDoc _metricDefinitionList;
42
43
44       //----------------/
45 //- Constructors -/
46 //----------------/
47
48     public MetricDefinitions() {
49         super();
50         _metricDefinitionList = new Vector JavaDoc();
51     } //-- com.calipso.reportgenerator.reportdefinitions.MetricDefinitions()
52
53
54       //-----------/
55 //- Methods -/
56 //-----------/
57
58     /**
59      * Method addMetricDefinition
60      *
61      * @param vMetricDefinition
62      */
63     public void addMetricDefinition(com.calipso.reportgenerator.reportdefinitions.MetricDefinition vMetricDefinition)
64         throws java.lang.IndexOutOfBoundsException JavaDoc
65     {
66         _metricDefinitionList.addElement(vMetricDefinition);
67     } //-- void addMetricDefinition(com.calipso.reportgenerator.reportdefinitions.MetricDefinition)
68
69     /**
70      * Method addMetricDefinition
71      *
72      * @param index
73      * @param vMetricDefinition
74      */
75     public void addMetricDefinition(int index, com.calipso.reportgenerator.reportdefinitions.MetricDefinition vMetricDefinition)
76         throws java.lang.IndexOutOfBoundsException JavaDoc
77     {
78         _metricDefinitionList.insertElementAt(vMetricDefinition, index);
79     } //-- void addMetricDefinition(int, com.calipso.reportgenerator.reportdefinitions.MetricDefinition)
80
81     /**
82      * Method enumerateMetricDefinition
83      */
84     public java.util.Enumeration JavaDoc enumerateMetricDefinition()
85     {
86         return _metricDefinitionList.elements();
87     } //-- java.util.Enumeration enumerateMetricDefinition()
88
89     /**
90      * Method getMetricDefinition
91      *
92      * @param index
93      */
94     public com.calipso.reportgenerator.reportdefinitions.MetricDefinition getMetricDefinition(int index)
95         throws java.lang.IndexOutOfBoundsException JavaDoc
96     {
97         //-- check bounds for index
98 if ((index < 0) || (index > _metricDefinitionList.size())) {
99             throw new IndexOutOfBoundsException JavaDoc();
100         }
101         
102         return (com.calipso.reportgenerator.reportdefinitions.MetricDefinition) _metricDefinitionList.elementAt(index);
103     } //-- com.calipso.reportgenerator.reportdefinitions.MetricDefinition getMetricDefinition(int)
104
105     /**
106      * Method getMetricDefinition
107      */
108     public com.calipso.reportgenerator.reportdefinitions.MetricDefinition[] getMetricDefinition()
109     {
110         int size = _metricDefinitionList.size();
111         com.calipso.reportgenerator.reportdefinitions.MetricDefinition[] mArray = new com.calipso.reportgenerator.reportdefinitions.MetricDefinition[size];
112         for (int index = 0; index < size; index++) {
113             mArray[index] = (com.calipso.reportgenerator.reportdefinitions.MetricDefinition) _metricDefinitionList.elementAt(index);
114         }
115         return mArray;
116     } //-- com.calipso.reportgenerator.reportdefinitions.MetricDefinition[] getMetricDefinition()
117
118     /**
119      * Method getMetricDefinitionCount
120      */
121     public int getMetricDefinitionCount()
122     {
123         return _metricDefinitionList.size();
124     } //-- int getMetricDefinitionCount()
125
126     /**
127      * Method isValid
128      */
129     public boolean isValid()
130     {
131         try {
132             validate();
133         }
134         catch (org.exolab.castor.xml.ValidationException vex) {
135             return false;
136         }
137         return true;
138     } //-- boolean isValid()
139
140     /**
141      * Method marshal
142      *
143      * @param out
144      */
145     public void marshal(java.io.Writer JavaDoc out)
146         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
147     {
148         
149         Marshaller.marshal(this, out);
150     } //-- void marshal(java.io.Writer)
151
152     /**
153      * Method marshal
154      *
155      * @param handler
156      */
157     public void marshal(org.xml.sax.ContentHandler JavaDoc handler)
158         throws java.io.IOException JavaDoc, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
159     {
160         
161         Marshaller.marshal(this, handler);
162     } //-- void marshal(org.xml.sax.ContentHandler)
163
164     /**
165      * Method removeAllMetricDefinition
166      */
167     public void removeAllMetricDefinition()
168     {
169         _metricDefinitionList.removeAllElements();
170     } //-- void removeAllMetricDefinition()
171
172     /**
173      * Method removeMetricDefinition
174      *
175      * @param index
176      */
177     public com.calipso.reportgenerator.reportdefinitions.MetricDefinition removeMetricDefinition(int index)
178     {
179         java.lang.Object JavaDoc obj = _metricDefinitionList.elementAt(index);
180         _metricDefinitionList.removeElementAt(index);
181         return (com.calipso.reportgenerator.reportdefinitions.MetricDefinition) obj;
182     } //-- com.calipso.reportgenerator.reportdefinitions.MetricDefinition removeMetricDefinition(int)
183
184     /**
185      * Method setMetricDefinition
186      *
187      * @param index
188      * @param vMetricDefinition
189      */
190     public void setMetricDefinition(int index, com.calipso.reportgenerator.reportdefinitions.MetricDefinition vMetricDefinition)
191         throws java.lang.IndexOutOfBoundsException JavaDoc
192     {
193         //-- check bounds for index
194 if ((index < 0) || (index > _metricDefinitionList.size())) {
195             throw new IndexOutOfBoundsException JavaDoc();
196         }
197         _metricDefinitionList.setElementAt(vMetricDefinition, index);
198     } //-- void setMetricDefinition(int, com.calipso.reportgenerator.reportdefinitions.MetricDefinition)
199
200     /**
201      * Method setMetricDefinition
202      *
203      * @param metricDefinitionArray
204      */
205     public void setMetricDefinition(com.calipso.reportgenerator.reportdefinitions.MetricDefinition[] metricDefinitionArray)
206     {
207         //-- copy array
208 _metricDefinitionList.removeAllElements();
209         for (int i = 0; i < metricDefinitionArray.length; i++) {
210             _metricDefinitionList.addElement(metricDefinitionArray[i]);
211         }
212     } //-- void setMetricDefinition(com.calipso.reportgenerator.reportdefinitions.MetricDefinition)
213
214     /**
215      * Method unmarshal
216      *
217      * @param reader
218      */
219     public static com.calipso.reportgenerator.reportdefinitions.MetricDefinitions unmarshal(java.io.Reader JavaDoc reader)
220         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
221     {
222         return (com.calipso.reportgenerator.reportdefinitions.MetricDefinitions) Unmarshaller.unmarshal(com.calipso.reportgenerator.reportdefinitions.MetricDefinitions.class, reader);
223     } //-- com.calipso.reportgenerator.reportdefinitions.MetricDefinitions unmarshal(java.io.Reader)
224
225     /**
226      * Method validate
227      */
228     public void validate()
229         throws org.exolab.castor.xml.ValidationException
230     {
231         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
232         validator.validate(this);
233     } //-- void validate()
234
235 }
236
Popular Tags