|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchManager
Manages the search feature of Jive Forums by defining properties of the search indexer. Indexing can either be done real-time by calling indexMessage() every time a new message is created, or by running the indexer in timed update mode. The latter mode is preferable since it allows for faster message posting.
The automated updating mode can be adjusted by setting how often batch indexing is done. You can adjust this interval to suit the needs of your forums. Frequent updates mean that messages will be searchable more quickly. Less frequent updates use fewer system resources.
If you are not using the Jive Forums search system at all (for example, if you have your own search technology that you'd rather use), you should disable the search feature entirely.
The following Jive properties correspond to the search manager settings:
ForumFactory.getSearchManager()
Method Summary | |
---|---|
void |
addTextExtractor(java.lang.String className)
Installs a new class into the list of available text extractors for the system. |
void |
addToIndex(ForumMessage message)
Adds an individual message to the index. |
int |
getAutoIndexInterval()
Returns the number of minutes that the indexer waits between each update. |
int |
getCurrentCount()
Returns the number of entries that have been indexed if an indexing operation is currently active (i.e., isBusy() returns true). |
java.util.Date |
getLastIndexedDate()
Returns the date that the last update to the index was made. |
int |
getPercentComplete()
Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., isBusy() returns
true). |
TextExtractor[] |
getTextExtractors()
Returns the current array of TextExtractor objects. |
int |
getTotalCount()
Returns the total number of entries that are to be indexed if an indexing operation is currently active (i.e., isBusy() returns true). |
boolean |
isAttachmentSearchEnabled()
Returns true if the attachment search feature is turned on. |
boolean |
isAutoIndexEnabled()
Returns true if auto indexing is turned on. |
boolean |
isBusy()
Returns true if the search manager is currently busy with an search indexing task. |
boolean |
isFilterHTMLEnabled()
Determines whether to filter out HTML when indexing and retrieving messages. |
boolean |
isSearchEnabled()
Returns true if the search feature is turned on. |
boolean |
isWildcardIgnored()
Returns true if wildcarding is disabled. |
void |
optimize()
Optimizes the underlying search index for maximum speed. |
void |
rebuildIndex()
Manually rebuild the entire index. |
void |
removeFromIndex(Forum forum)
Removes a forum from the index. |
void |
removeFromIndex(ForumMessage message)
Removes an individual message from the index. |
void |
removeFromIndex(ForumThread thread)
Removes a thread from the index. |
void |
removeTextExtractor(java.lang.String className)
Removes an existing text extractor from the list of current text extractors. |
void |
setAttachmentSearchEnabled(boolean attachmentSearchEnabled)
Enables or disables the attachment search feature. |
void |
setAutoIndexEnabled(boolean value)
Enables or disables auto indexing. |
void |
setAutoIndexInterval(int minutes)
Sets the amount of time that indexer should wait between updating the index. |
void |
setFilterHTMLEnabled(boolean filterHTMLEnabled)
Set whether or not to index and display HTML within messages. |
void |
setSearchEnabled(boolean searchEnabled)
Enables or disables the search feature. |
void |
setWildcardIgnored(boolean value)
Turns on or off wildcarding. |
void |
updateIndex()
Manually update the index to include all new messages since the last update. |
Method Detail |
---|
boolean isSearchEnabled()
void setSearchEnabled(boolean searchEnabled)
searchEnabled
- true to enable the search feature, false to disable.boolean isAttachmentSearchEnabled()
void setAttachmentSearchEnabled(boolean attachmentSearchEnabled)
attachmentSearchEnabled
- true to enable attachment search.TextExtractor[] getTextExtractors()
void addTextExtractor(java.lang.String className) throws java.lang.ClassNotFoundException
className
- the fully qualified name of the text extractor.
java.lang.ClassNotFoundException
- if the class could not be loaded.
java.lang.IllegalArgumentException
- if the classname is not a TextExtractor or cannot be loaded.void removeTextExtractor(java.lang.String className) throws java.lang.ClassNotFoundException
className
- the fully qualified name of the text extractor to remove.
java.lang.ClassNotFoundException
- if the class could not be loaded.
java.lang.IllegalArgumentException
- if the classname is not a TextExtractor or cannot be loaded.boolean isBusy()
rebuildIndex()
will do nothing. If you'd like to query the status
of the indexing operation while the manager is busy, use the
getPercentComplete()
method.
int getPercentComplete()
isBusy()
returns
true). Valid percentages returned are from 0 to 100. If no indexing
operation is active, this method will return -1.
int getTotalCount()
isBusy()
returns true).
int getCurrentCount()
isBusy()
returns true).
boolean isWildcardIgnored()
void setWildcardIgnored(boolean value)
value
- true if wildcards are to be ignored. false enables wildcard
search.boolean isAutoIndexEnabled()
void setAutoIndexEnabled(boolean value)
value
- true to turn auto indexing on, false to turn it off.int getAutoIndexInterval()
void setAutoIndexInterval(int minutes)
minutes
- the number of minutes between automatic index updates.java.util.Date getLastIndexedDate()
void addToIndex(ForumMessage message)
message
- the message to add to the index.void removeFromIndex(ForumMessage message)
message
- the message to remove from the index.void removeFromIndex(ForumThread thread)
thread
- the thread to remove from the index.void removeFromIndex(Forum forum)
forum
- the forum to remove from the index.void updateIndex()
void rebuildIndex()
void optimize()
boolean isFilterHTMLEnabled()
void setFilterHTMLEnabled(boolean filterHTMLEnabled)
filterHTMLEnabled
- true if HTML should be filtered.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |