org.tigris.eyebrowse
Class IndexMaint

java.lang.Object
  |
  +--org.tigris.eyebrowse.IndexMaint

public class IndexMaint
extends java.lang.Object

Methods for creating and accessing the Indexer objects associated with a list.

Since:
1.0
Author:
Brian Goetz - Quiotix Corp

Field Summary
protected static org.tigris.eyebrowse.util.EyebrowseLogger log
          Log file to write to.
 
Constructor Summary
IndexMaint()
           
 
Method Summary
static void addIndex(java.lang.String list, java.lang.String indexFile)
          Adds an index to a list and creates the associated index store.
static void deleteIndex(java.lang.String list)
          Mark a list as non-indexed.
static IIndexer getIndexer(java.lang.String indexFile)
          Static method for obtaining an Indexer object associated with a particular index file.
static void updateIndex(EyebrowseDb.ListInfo list, int max)
          Examine the list for messages that have arrived since the last time the list was indexed, and add the first N new messages to the index.
static void updateIndex(java.lang.String list)
          Examine the list for messages that have arrived since the last time the list was indexed, and add the new messages to the index.
static void updateIndex(java.lang.String listName, int max)
          Method to be called from UpdateIndex.java.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static org.tigris.eyebrowse.util.EyebrowseLogger log
Log file to write to.
Constructor Detail

IndexMaint

public IndexMaint()
Method Detail

getIndexer

public static IIndexer getIndexer(java.lang.String indexFile)
                           throws EyebrowseException,
                                  IndexerException
Static method for obtaining an Indexer object associated with a particular index file.
Parameters:
indexFile -  
Throws:
EyebrowseException -  
IndexerException -  

addIndex

public static void addIndex(java.lang.String list,
                            java.lang.String indexFile)
                     throws EyebrowseException,
                            IndexerException
Adds an index to a list and creates the associated index store.
Parameters:
list - The name of the mailing list to index.
indexFile - The path to a file or directory where the index store should be stored. This file or directory will be created or overwritten.
Throws:
EyebrowseException -  
IndexerException -  

deleteIndex

public static void deleteIndex(java.lang.String list)
                        throws EyebrowseException
Mark a list as non-indexed. Does not delete the underlying index store.
Parameters:
list -  
Throws:
EyebrowseException -  

updateIndex

public static void updateIndex(java.lang.String list)
                        throws EyebrowseException,
                               IndexerException
Examine the list for messages that have arrived since the last time the list was indexed, and add the new messages to the index. Note that updateIndex works differently from updateList, in that it doesn't care what the active message file is. Once the message information has been stored in the database, updateIndex will find it. So it is not necessary to run updateIndex when adding a new mailbox file to the database, as it is when you run updateList.
Parameters:
list -  
Throws:
EyebrowseException -  
IndexerException -  

updateIndex

public static void updateIndex(java.lang.String listName,
                               int max)
                        throws EyebrowseException,
                               IndexerException
Method to be called from UpdateIndex.java. Finds list by name and calls update on said list.

updateIndex

public static void updateIndex(EyebrowseDb.ListInfo list,
                               int max)
                        throws EyebrowseException,
                               IndexerException
Examine the list for messages that have arrived since the last time the list was indexed, and add the first N new messages to the index.
Parameters:
list -  
max - The maximum number of new messages to index at this time.
Throws:
EyebrowseException -  
IndexerException -  


Copyright © 2000 Quiotix Corp. All Rights Reserved.