SearchIndexer


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;
108 
109 import java.util.Date  ;
110 
111 /**
112  * Defines properties of the Yazd indexer for searching. Indexing can either
113  * be done real-time by calling indexMessage() every time a new message is
114  * created, or by running the indexer in timed update mode. The latter mode
115  * is probably preferable since it allows for faster message posting.
116  * <p>
117  * The automated updating mode can be adjusted by setting how often batch
118  * indexing is done. You can adjust this interval to suit the needs of your
119  * forums. Frequent updates mean that messages will be searchable more quickly.
120  * Less frequent updates use fewer system resources.
121  *
122  * @see ForumFactory#getSearchIndexer()
123  */
124 public interface SearchIndexer {
125 
126     /**
127      * Returns the number of hours that the indexer waits between each update.
128      *
129      * @return the number of hours between automatic index updates.
130      */
131     public int getHoursUpdateInterval();
132 
133     /**
134      * Returns the number of minutes that the indexer waits between each update.
135      *
136      * @return the number of minutes between automatic index updates.
137      */
138     public int getMinutesUpdateInterval();
139 
140     /**
141      * Sets the amount of time that indexer should wait between updating the
142      * index.
143      *
144      * @param minutes the number of minutes between automatic index updates.
145      * @param hours the number of hours between automatic index updates.
146      */
147     public void setUpdateInterval(int minutes, int hours);
148 
149     /**
150      * Returns true if auto indexing is turned on. When auto indexing is on, it
151      * will update the search index at the interval specified by the
152      * setUpdateInterval method.
153      *
154      * @return true if auto indexing is turned on.
155      */
156     public boolean isAutoIndexEnabled();
157 
158     /**
159      * Enables or disables auto indexing. When auto indexing is on, it
160      * will update the search index at the interval specified by the
161      * setUpdateInterval method.
162      *
163      * @param value true to turn auto indexing on, false to turn it off.
164      */
165     public void setAutoIndexEnabled(boolean value);
166 
167     /**
168      * Returns the date that the last update to the index was made.
169      */
170     public Date   getLastIndexedDate();
171 
172     /**
173      * Adds an individual message to the index. This method is useful for doing
174      * real-time indexing. However, for maximum posting speed this method can
175      * be ignored. In that case, the automatic indexer will pick up all new
176      * messages at the next index interval.
177      *
178      * @param message the message to add to the index.
179      */
180     public void addToIndex(ForumMessage message);
181 
182     /**
183      * Removes an individual message from the index.
184      *
185      * @param message the message to remove from the index.
186      */
187     public void removeFromIndex(ForumMessage message);
188 
189     /**
190      * Manually update the index to include all new messages since the last
191      * update.
192      */
193     public void updateIndex();
194 
195     /**
196      * Manually rebuild the entire index. This operation can be slow if the
197      * index is large.
198      */
199     public void rebuildIndex();
200 }
201
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags