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

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

public class IndexedUserQueryBuilder
extends Object

A builder of queries on users that are indexed with the Silverpeas indexation engine. The builder provides several methods to specify the values of the fields the users to query must have. Either the exact value can be passed or just a pattern the users must satisfy in order to be sent back. Currently, only the patterns supported by the Lucene search engine are supported; for example the more common pattern is the following: TEXT* where the star is used as a widcard character and meaning starting by the text TEXT.

Constructor Summary

protected

IndexedUserQueryBuilder(String userId)

Method Summary

IndexedUserQueryBuilder	and()
QueryDescription	build()
IndexedUserQueryBuilder	firstName(String name) The query on the first name of a user.
IndexedUserQueryBuilder	lastName(String name)
IndexedUserQueryBuilder	or()
static IndexedUserQueryBuilder	queriedBy(String userId)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedUserQueryBuilder

protected IndexedUserQueryBuilder(String userId)

Method Detail

queriedBy

public static IndexedUserQueryBuilder queriedBy(String userId)

or

public IndexedUserQueryBuilder or()

and

public IndexedUserQueryBuilder and()

firstName

public IndexedUserQueryBuilder firstName(String name)

The query on the first name of a user.

Parameters:

name -

Returns:

lastName

public IndexedUserQueryBuilder lastName(String name)

build

public QueryDescription build()