Author: echatellier Date: 2012-01-25 14:14:06 +0100 (Wed, 25 Jan 2012) New Revision: 1365 Url: http://nuiton.org/repositories/revision/wikitty/1365 Log: Fix doc Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java 2012-01-25 13:09:17 UTC (rev 1364) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java 2012-01-25 13:14:06 UTC (rev 1365) @@ -29,22 +29,6 @@ import java.lang.reflect.Field; import java.lang.reflect.Method; import java.math.BigDecimal; - -import org.apache.commons.lang.StringUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.nuiton.util.ApplicationConfig; -import org.nuiton.util.TimeLog; -import org.nuiton.wikitty.entities.BusinessEntity; -import org.nuiton.wikitty.entities.BusinessEntityImpl; -import org.nuiton.wikitty.entities.Wikitty; -import org.nuiton.wikitty.entities.WikittyExtension; -import org.nuiton.wikitty.entities.WikittyGroup; -import org.nuiton.wikitty.entities.WikittyUser; -import org.nuiton.wikitty.services.WikittyEvent; -import org.nuiton.wikitty.services.WikittySecurityUtil; -import org.nuiton.wikitty.services.WikittyServiceEnhanced; - import java.util.ArrayList; import java.util.Collection; import java.util.Collections; @@ -55,25 +39,38 @@ import java.util.List; import java.util.Map; import java.util.Set; + import org.apache.commons.collections.CollectionUtils; +import org.apache.commons.lang.StringUtils; +import org.nuiton.util.ApplicationConfig; +import org.nuiton.util.TimeLog; +import org.nuiton.wikitty.entities.BusinessEntity; +import org.nuiton.wikitty.entities.BusinessEntityImpl; +import org.nuiton.wikitty.entities.ElementField; +import org.nuiton.wikitty.entities.Wikitty; +import org.nuiton.wikitty.entities.WikittyExtension; import org.nuiton.wikitty.entities.WikittyField; +import org.nuiton.wikitty.entities.WikittyGroup; import org.nuiton.wikitty.entities.WikittyTokenHelper; +import org.nuiton.wikitty.entities.WikittyUser; import org.nuiton.wikitty.query.WikittyQuery; import org.nuiton.wikitty.query.WikittyQueryMaker; import org.nuiton.wikitty.query.WikittyQueryResult; import org.nuiton.wikitty.query.WikittyQueryResultTreeNode; -import org.nuiton.wikitty.entities.ElementField; import org.nuiton.wikitty.query.conditions.Select; +import org.nuiton.wikitty.services.WikittyEvent; import org.nuiton.wikitty.services.WikittyExtensionMigrationRegistry; +import org.nuiton.wikitty.services.WikittySecurityUtil; +import org.nuiton.wikitty.services.WikittyServiceEnhanced; /** * Wikitty client is object used in client side to access WikittyService. * It is used to transform wikitty object used by {@link WikittyService} * into business objects used by applications. * - * It also manage {@link #securityToken} for {@link org.nuiton.wikitty.services.WikittyService}. + * It also manage {@link #securityToken} for {@link org.nuiton.wikitty.WikittyService}. * - * All method that need {@link #securityToken} and {@link org.nuiton.wikitty.services.WikittyService} + * All method that need {@link #securityToken} and {@link org.nuiton.wikitty.WikittyService} * must be in this class and not in {@link WikittyUtil} * * @author poussin @@ -86,7 +83,6 @@ public class WikittyClient { /** to use log facility, just put in your code: log.info(\"...\"); */ - final static private Log log = LogFactory.getLog(WikittyClient.class); final static private TimeLog timeLog = new TimeLog(WikittyClient.class); protected ApplicationConfig config = null; @@ -131,6 +127,7 @@ * * @param config * @param wikittyService + * @param securityToken */ public WikittyClient(ApplicationConfig config, WikittyService wikittyService, String securityToken) { if (config != null) { @@ -532,7 +529,7 @@ * @return */ public <E extends BusinessEntityImpl> WikittyQueryResult<E> findAllByExample(E e, - int first, int limit, ElementField ... fieldFacet ) { + int first, int limit, ElementField ... fieldFacet) { long start = TimeLog.getTime(); WikittyQuery query = new WikittyQueryMaker().wikitty(e).end() @@ -985,12 +982,12 @@ } /** - * Converti un id en son object WikittyTreeNode + * Converti un id en son object WikittyTreeNode. * @since 3.1 */ static private class IdToObjectConverter<T> implements ConvertTreeVisitor.Converter<String, T> { protected Map<String, T> objects = new HashMap<String, T>(); - protected String securityToken; + public IdToObjectConverter(List<String> ids, List<T> objectList) { for (int i = 0; i < ids.size(); i++) { @@ -1231,6 +1228,8 @@ /** * Use with caution : It will delete ALL indexes from search engine ! * This operation should be disabled in production environment. + * + * @return clear event */ public WikittyEvent clear() { long start = TimeLog.getTime();