|
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 ProfileSearchManager
Manages the search feature of Jive Expert User Search by defining properties of the search indexer. Indexing can either be done real-time by calling addToIndex(...) every time a new object is created, or by running the indexer in timed update mode. The latter mode is preferable since it allows for faster object posting.
The automated updating mode can be adjusted by setting how often batch indexing is done. You can adjust this interval to suit your needs. Frequent updates mean that entries/comments will be searchable more quickly. Less frequent updates use fewer system resources.
If you are not using the Jive Expert User 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 profile search manager settings:
Method Summary | |
---|---|
void |
addToIndex(User user)
Adds an individual user 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). |
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 |
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 |
isEmailVisible()
Determines whether or not user email addresses are visible when performing a user search. |
boolean |
isSearchEnabled()
Returns true if the profile search feature is turned on. |
void |
optimize()
Optimizes the underlying search index for maximum speed. |
void |
rebuildIndex()
Manually rebuild the entire index. |
void |
removeFromIndex(User user)
Removes an individual user from the index. |
org.apache.lucene.search.Hits |
search(ProfileSearchQuery query)
Returns the hits that correspond to the search query. |
void |
setAutoIndexEnabled(boolean value)
Enables or disables auto indexing. |
void |
setAutoIndexInterval(int minutes)
Sets the number of minutes that indexer should wait between updating the index. |
void |
setEmailVisible(boolean emailVisible)
Determines whether or not user email addresses are visible when performing a user search. |
void |
setSearchEnabled(boolean searchEnabled)
Enables or disables the profile search feature. |
void |
updateIndex()
Manually update the index to include all new objects since the last update. |
Method Detail |
---|
boolean isSearchEnabled()
void setSearchEnabled(boolean searchEnabled)
searchEnabled
- true to enable the search feature, false to disable.boolean isEmailVisible()
void setEmailVisible(boolean emailVisible)
emailVisible
- true if user email addresses are visible, false otherwise.org.apache.lucene.search.Hits search(ProfileSearchQuery query)
query
- the profile search query
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 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(User user)
user
- the user to add to the index.void removeFromIndex(User user)
user
- the user to remove from the index.void updateIndex()
void rebuildIndex()
void optimize()
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |