com.stratelia.webactiv.beans.admin.indexation
Class UserIndexation

java.lang.Object
  com.stratelia.webactiv.beans.admin.indexation.UserIndexation

public class UserIndexation
extends Object

Indexation of the users in Silverpeas. It uses the indexer and searcher API to provide a way to index and to search in a transparently way the users.

Field Summary

static String

OBJECT_TYPE

Constructor Summary

UserIndexation()

Method Summary

List<UserDetail>	findUserFromQuery(QueryDescription queryDescription) Finds the users that match the specified query.
void	indexUser(String userId) Indexes the specified user.
void	unindexUser(String userId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OBJECT_TYPE

public static final String OBJECT_TYPE

See Also:

Constant Field Values

Constructor Detail

UserIndexation

public UserIndexation()

Method Detail

indexUser

public void indexUser(String userId)

Indexes the specified user. If no user exist with the specified unique identifier, nothing is done.

Parameters:

userId - the unique identifier of the user to index.

unindexUser

public void unindexUser(String userId)

findUserFromQuery

public List<UserDetail> findUserFromQuery(QueryDescription queryDescription)

Finds the users that match the specified query. The query is ran by the index searcher in order to find the indexes matching the request. Then the details about the found users are fetched from the data source.

Parameters:

queryDescription - a description of the query to pass to the index and search engine.

Returns:

a list of users matching the query.