KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > Yasna > forum > database > DbThreadIterator


1 /**
2  * Copyright (C) 2001 Yasna.com. All rights reserved.
3  *
4  * ===================================================================
5  * The Apache Software License, Version 1.1
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by
22  * Yasna.com (http://www.yasna.com)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Yazd" and "Yasna.com" must not be used to
27  * endorse or promote products derived from this software without
28  * prior written permission. For written permission, please
29  * contact yazd@yasna.com.
30  *
31  * 5. Products derived from this software may not be called "Yazd",
32  * nor may "Yazd" appear in their name, without prior written
33  * permission of Yasna.com.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL YASNA.COM OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of Yasna.com. For more information
51  * on Yasna.com, please see <http://www.yasna.com>.
52  */

53
54 /**
55  * Copyright (C) 2000 CoolServlets.com. All rights reserved.
56  *
57  * ===================================================================
58  * The Apache Software License, Version 1.1
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  * notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  * notice, this list of conditions and the following disclaimer in
69  * the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3. The end-user documentation included with the redistribution,
73  * if any, must include the following acknowledgment:
74  * "This product includes software developed by
75  * CoolServlets.com (http://www.coolservlets.com)."
76  * Alternately, this acknowledgment may appear in the software itself,
77  * if and wherever such third-party acknowledgments normally appear.
78  *
79  * 4. The names "Jive" and "CoolServlets.com" must not be used to
80  * endorse or promote products derived from this software without
81  * prior written permission. For written permission, please
82  * contact webmaster@coolservlets.com.
83  *
84  * 5. Products derived from this software may not be called "Jive",
85  * nor may "Jive" appear in their name, without prior written
86  * permission of CoolServlets.com.
87  *
88  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
89  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
90  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
91  * DISCLAIMED. IN NO EVENT SHALL COOLSERVLETS.COM OR
92  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
93  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
94  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
95  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
96  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
97  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
98  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
99  * SUCH DAMAGE.
100  * ====================================================================
101  *
102  * This software consists of voluntary contributions made by many
103  * individuals on behalf of CoolServlets.com. For more information
104  * on CoolServlets.com, please see <http://www.coolservlets.com>.
105  */

106
107 package com.Yasna.forum.database;
108
109 import java.util.Iterator JavaDoc;
110 import java.sql.*;
111
112 import com.Yasna.forum.*;
113
114 /**
115  * Database implementation of Iterator for ForumMesages in a ForumThread.
116  */

117 public class DbThreadIterator implements Iterator JavaDoc {
118
119     /** DATABASE QUERIES **/
120     private static final String JavaDoc MESSAGE_COUNT =
121         "SELECT count(messageID) FROM yazdMessage WHERE threadID=?";
122     private static final String JavaDoc GET_MESSAGES =
123         "SELECT messageID, creationDate FROM yazdMessage WHERE threadID=? " +
124         "ORDER BY creationDate ASC";
125
126     private ForumThread thread;
127     private int [] messages;
128     private int currentIndex = -1;
129
130     private ForumMessage nextMessage = null;
131
132     protected DbThreadIterator(ForumThread thread) {
133         this.thread = thread;
134         Connection con = null;
135         PreparedStatement pstmt = null;
136         try {
137             con = DbConnectionManager.getConnection();
138             pstmt = con.prepareStatement(MESSAGE_COUNT);
139             pstmt.setInt(1, thread.getID());
140             ResultSet rs = pstmt.executeQuery();
141             rs.next();
142             messages = new int[rs.getInt(1)];
143             pstmt.close();
144
145             pstmt = con.prepareStatement(GET_MESSAGES);
146             pstmt.setInt(1, thread.getID());
147             rs = pstmt.executeQuery();
148             for (int i=0; i<messages.length; i++) {
149                 rs.next();
150                 messages[i] = rs.getInt(1);
151             }
152         }
153         catch( SQLException sqle ) {
154             System.err.println("Error in DbThreadIterator:constructor()-" + sqle);
155         }
156         finally {
157             try { pstmt.close(); }
158             catch (Exception JavaDoc e) { e.printStackTrace(); }
159             try { con.close(); }
160             catch (Exception JavaDoc e) { e.printStackTrace(); }
161         }
162     }
163
164     protected DbThreadIterator(ForumThread thread, int startIndex, int numResults)
165     {
166         this.thread = thread;
167
168         int[] tempMessages = new int[numResults];
169         //It's very possible that there might not be as many messages to get
170
//as we requested. Therefore, we keep track of how many messages we
171
//get by keeping a messageCount.
172
int messageCount = 0;
173
174         Connection con = null;
175         PreparedStatement pstmt = null;
176
177         try {
178             con = DbConnectionManager.getConnection();
179             pstmt = con.prepareStatement(GET_MESSAGES);
180             pstmt.setInt(1, thread.getID());
181             ResultSet rs = pstmt.executeQuery();
182             //Move to start of index
183
for (int i=0; i<startIndex; i++) {
184                 rs.next();
185             }
186             //Now read in desired number of results
187
for (int i=0; i<numResults; i++) {
188                 if (rs.next()) {
189                     tempMessages[messageCount] = rs.getInt("messageID");
190                     messageCount++;
191                 }
192                 else {
193                     break;
194                 }
195             }
196         }
197         catch( SQLException sqle ) {
198             System.err.println("Error in DbThreadIterator:constructor()-" + sqle);
199         }
200         finally {
201             try { pstmt.close(); }
202             catch (Exception JavaDoc e) { e.printStackTrace(); }
203             try { con.close(); }
204             catch (Exception JavaDoc e) { e.printStackTrace(); }
205         }
206         messages = new int[messageCount];
207         for (int i=0; i<messageCount; i++) {
208             messages[i] = tempMessages[i];
209         }
210     }
211
212     /**
213      * Returns true if there are more messages in the list.
214      *
215      * @return true if the iterator has more elements.
216      */

217     public boolean hasNext() {
218         //If we are at the end of the list, there can't be any more messages
219
//to iterate through.
220
if (currentIndex+1 >= messages.length) {
221             return false;
222         }
223         return true;
224
225         /*
226         BUG: this code calls getNextMessage() which will increment the
227         currentIndex variable as a result of calling this message!
228
229         //Otherwise, see if nextMessage is null. If so, try to load the next
230         //message to make sure it exists.
231
232         // hmm, do we really need to do this here? i think it should be left up
233         // to the next() method -- BL
234
235         if (nextMessage == null) {
236             nextMessage = getNextMessage();
237             if (nextMessage == null) {
238                 return false;
239             }
240         }
241         return true;
242         */

243     }
244
245     /**
246      * Returns the next message in the interation.
247      *
248      * @return the next message in the interation.
249      * @throws NoSuchElementException if the iteration has no more elements.
250      */

251     public Object JavaDoc next() throws java.util.NoSuchElementException JavaDoc {
252         ForumMessage message = null;
253         if (nextMessage != null) {
254             message = nextMessage;
255             nextMessage = null;
256         }
257         else {
258             message = getNextMessage();
259             if (message == null) {
260                 throw new java.util.NoSuchElementException JavaDoc();
261             }
262         }
263         return message;
264     }
265
266     /**
267      * Not supported for security reasons. Use the deleteMessage method in the
268      * ForumThread class instead.
269      *
270      * @see ForumThread#deleteMessage(ForumMessage)
271      */

272     public void remove() throws UnsupportedOperationException JavaDoc {
273         throw new UnsupportedOperationException JavaDoc();
274     }
275
276     /**
277      * Returns the next available message, or null if there are no more
278      * messages to return.
279      */

280     private ForumMessage getNextMessage() {
281         while (currentIndex+1 < messages.length) {
282             currentIndex++;
283             try {
284                 ForumMessage message = thread.getMessage(messages[currentIndex]);
285                 return message;
286             }
287             catch (ForumMessageNotFoundException mnfe) { }
288         }
289         return null;
290     }
291 }
292
Popular Tags