KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > roller > model > IndexManager


1 package org.roller.model;
2
3 import org.roller.RollerException;
4 import org.roller.business.search.operations.IndexOperation;
5 import org.roller.pojos.UserData;
6 import org.roller.pojos.WeblogEntryData;
7
8 /**
9  * Interface to Roller's Lucene-based search facility.
10  * @author Dave Johnson
11  */

12 public interface IndexManager
13 {
14     /** Does index need to be rebuild */
15     public abstract boolean isInconsistentAtStartup();
16     
17     /** Rebuild index, returns immediately and operates in background */
18     public void rebuildUserIndex() throws RollerException;
19     
20     /** Remove user from index, returns immediately and operates in background */
21     public void removeUserIndex(UserData user) throws RollerException;
22     
23     /** Remove entry from index, returns immediately and operates in background */
24     public void removeEntryIndexOperation(WeblogEntryData entry) throws RollerException;
25     
26     /** Add entry to index, returns immediately and operates in background */
27     public void addEntryIndexOperation(WeblogEntryData entry) throws RollerException;
28     
29     /** R-index entry, returns immediately and operates in background */
30     public void addEntryReIndexOperation(WeblogEntryData entry) throws RollerException;
31     
32     /** Execute operation immediately */
33     public abstract void executeIndexOperationNow(final IndexOperation op);
34     
35     /**
36      * Release all resources associated with Roller session.
37      */

38     public abstract void release();
39     
40     /** Shutdown to be called on application shutdown */
41     public abstract void shutdown();
42 }
Popular Tags