KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > reports > ReportAxis


1 package org.tigris.scarab.reports;
2
3 /* ================================================================
4  * Copyright (c) 2000-2002 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  */
41
42 import java.util.List JavaDoc;
43 import java.util.ArrayList JavaDoc;
44 import org.apache.fulcrum.intake.Retrievable;
45
46 /**
47  *
48  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
49  * @version $Id: ReportAxis.java 9104 2004-05-10 21:04:51Z dabbous $
50  */
51 public class ReportAxis
52     implements java.io.Serializable JavaDoc,
53                Retrievable
54 {
55     private List JavaDoc reportHeadings;
56
57     private String JavaDoc queryKey;
58
59     /**
60      * Gets the heading at the given index.
61      * if headingIndex is negative, a new ReportHeading is returned
62      * that is
63      *
64      * @param headingIndex an <code>int</code> value
65      * @return a <code>ReportHeading</code> value
66      */
67     public ReportHeading getHeading(int headingIndex)
68     {
69         ReportHeading heading;
70         List JavaDoc headings = getReportHeadings();
71         if (headingIndex >= 0)
72         {
73             if (headings == null || headings.size() <= headingIndex)
74             {
75                 throw new IllegalArgumentException JavaDoc(headingIndex +
76                     " is larger than the number of headings"); //EXCEPTION
77 }
78             else
79             {
80                 heading = (ReportHeading)headings.get(headingIndex);
81             }
82         }
83         else
84         {
85             heading = new ReportHeading();
86             addReportHeading(heading);
87         }
88         return heading;
89     }
90
91     /**
92      * Get the ReportHeadings value.
93      * @return the ReportHeadings value.
94      */
95     public List JavaDoc getReportHeadings()
96     {
97         return reportHeadings;
98     }
99
100     /**
101      * Set the ReportHeadings value.
102      * @param newReportHeadings The new ReportHeadings value.
103      */
104     public void setReportHeadings(List JavaDoc newReportHeadings)
105     {
106         this.reportHeadings = newReportHeadings;
107     }
108
109     /**
110      * Add a ReportHeading value.
111      * @param newReportHeading The new ReportHeading value.
112      */
113     public void addReportHeading(ReportHeading newReportHeading)
114     {
115         if (reportHeadings == null)
116         {
117             reportHeadings = new ArrayList JavaDoc();
118         }
119         reportHeadings.add(newReportHeading);
120     }
121
122     /**
123      * Get the QueryKey value.
124      * @return the QueryKey value.
125      */
126     public String JavaDoc getQueryKey()
127     {
128         return queryKey == null ? "" : queryKey;
129     }
130     
131     /**
132      * Set the QueryKey value.
133      * @param newQueryKey The new QueryKey value.
134      */
135     public void setQueryKey(String JavaDoc newQueryKey)
136     {
137         this.queryKey = newQueryKey;
138     }
139 }
140
Popular Tags