|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
interface IIndexer Interface used to separate the implementation of the text indexing engine from the rest of Eyebrowse. Clients will create an object implementing Indexer for searching, updating, or creating the index. The location of the index store will be specified through the constructor.
Method Summary | |
void |
close()
Close the indexer, and write any unsaved information to the index. |
void |
createIndex()
Create the text index store. |
void |
indexMessage(java.lang.String msgName,
org.tigris.eyebrowse.MimeMessage message)
Called when IndexMaint.updateIndex finds a new message. |
java.lang.String[] |
search(java.lang.String searchText)
Search the index for text matching the specified search text from message bodies. |
java.lang.String[] |
search(java.lang.String searchText,
java.lang.String defaultField)
Search the index for text matching the specified search text. |
Method Detail |
public void indexMessage(java.lang.String msgName, org.tigris.eyebrowse.MimeMessage message) throws IndexerException
msgName
- The name which identifies the message to eyebrowse. This is
the name that should be returned by the search method when
identifying search results.message
- A JavaMail MimeMessage message.IndexerException
- public void close() throws IndexerException
IndexerException
- public java.lang.String[] search(java.lang.String searchText) throws IndexerException
searchText
- A search query, the format of which is specific to the search
engine being used.IndexerException
- public java.lang.String[] search(java.lang.String searchText, java.lang.String defaultField) throws IndexerException
searchText
- A list of message names which match the query, in relevance
order (if the search engine supports relevance matching.)defaultField
- If the search engine supports multiple field searching, this
specifies the name of the default field to search.IndexerException
- public void createIndex() throws IndexerException
IndexerException
-
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |