KickJava   Java API By Example, From Geeks To Geeks.

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


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 com.Yasna.forum.*;
110 import java.io.*;
111 import java.util.*;
112
113 /**
114  * Provides database persistence of ForumMessageFilter properties. When the
115  * database implementation of the forum system is used, all filters are
116  * wrapped with an instance of this class.
117  */
118 public class DbForumMessageFilter extends ForumMessageFilter
119         implements Serializable
120 {
121
122     /**
123      * Reference to the forum object this filter belongs to. It's neeeded so
124      * that we can save the state of the filter properties.
125      */
126     private transient DbForum forum;
127
128     public DbForumMessageFilter(ForumMessage message, DbForum forum) {
129         this.message = message;
130         this.forum = forum;
131     }
132
133     /**
134      * Clones a new filter that will have the same properties and that
135      * will wrap around the specified message.
136      *
137      * @param message the ForumMessage to wrap the new filter around.
138      */
139     public ForumMessageFilter clone(ForumMessage message) {
140         return ((ForumMessageFilter)message).clone(message);
141     }
142
143     /**
144      * Returns the name of the filter.
145      */
146     public String JavaDoc getName() {
147         return ((ForumMessageFilter)message).getName();
148     }
149
150     /**
151      * Returns a description of the filter.
152      */
153     public String JavaDoc getDescription() {
154         return ((ForumMessageFilter)message).getDescription();
155     }
156
157     /**
158      * Returns the author of the filter.
159      */
160     public String JavaDoc getAuthor() {
161         return ((ForumMessageFilter)message).getAuthor();
162     }
163
164     /**
165      * Returns the major version number of the filter.
166      */
167     public int getMajorVersion() {
168         return ((ForumMessageFilter)message).getMajorVersion();
169     }
170
171     /**
172      * Returns the minor version number of the filter.
173      */
174     public int getMinorVersion() {
175         return ((ForumMessageFilter)message).getMinorVersion();
176     }
177
178     /**
179      * Gets a property of the filter by name.
180      *
181      * @param name the name of the property to get.
182      */
183     public String JavaDoc getFilterProperty(String JavaDoc name){
184         return ((ForumMessageFilter)message).getFilterProperty(name);
185     }
186
187     /**
188      * Sets a property of the filter.
189      *
190      * @param name the name of the property to set
191      * @param value the new value for the property
192      */
193     public void setFilterProperty(String JavaDoc name, String JavaDoc value)
194             throws IllegalArgumentException JavaDoc
195     {
196         ((ForumMessageFilter)message).setFilterProperty(name,value);
197         //Save properties to db
198 saveFilterProperties();
199     }
200
201     /**
202      * Returns an iterator for the property names for the filter.
203      */
204     public Enumeration filterPropertyNames() {
205         return ((ForumMessageFilter)message).filterPropertyNames();
206     }
207
208     /**
209      * Saves the state of the filter. Each forum implementation is
210      * responsible for implementing this method.
211      */
212     public void saveFilterProperties() {
213         forum.saveFiltersToDb();
214     }
215
216     /**
217      * Returns a property description.
218      *
219      * @param name the name of the property to get a description of.
220      */
221     public String JavaDoc getFilterPropertyDescription(String JavaDoc name) {
222         return ((ForumMessageFilter)message).getFilterPropertyDescription(name);
223     }
224
225     /**
226      * Converts the object to a String by returning the name of the message.
227      * This functionality is primarily for Java applications that might be
228      * accessing Yazd objects through a GUI.
229      */
230     public String JavaDoc toString() {
231         return message.toString();
232     }
233 }
234
235
Popular Tags