[Wikitty-commits] 03/06: Fix javadoc 8

This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository wikitty. See http://git.nuiton.org/wikitty.git commit fc4353114a90ccd94861b1d3db30663fa61d1ec7 Author: Eric Chatellier <chatellier@codelutin.com> Date: Thu Feb 25 16:40:45 2016 +0100 Fix javadoc 8 --- .../java/org/nuiton/wikitty/DateMathParser.java | 32 ++-- .../java/org/nuiton/wikitty/WikittyClient.java | 9 +- .../java/org/nuiton/wikitty/WikittyConfig.java | 26 +-- .../java/org/nuiton/wikitty/WikittyException.java | 4 +- .../main/java/org/nuiton/wikitty/WikittyProxy.java | 4 +- .../java/org/nuiton/wikitty/WikittyService.java | 26 +-- .../main/java/org/nuiton/wikitty/WikittyUtil.java | 55 ++++--- .../wikitty/addons/WikittyImportExportService.java | 5 +- .../nuiton/wikitty/addons/WikittyLabelUtil.java | 10 +- .../addons/importexport/ImportExportMethod.java | 17 +- .../org/nuiton/wikitty/entities/ElementNode.java | 10 +- .../org/nuiton/wikitty/entities/FieldType.java | 4 +- .../java/org/nuiton/wikitty/entities/Wikitty.java | 2 +- .../wikitty/entities/WikittyCopyOnWrite.java | 22 +-- .../nuiton/wikitty/entities/WikittyExtension.java | 7 +- .../org/nuiton/wikitty/entities/WikittyImpl.java | 10 +- .../wikitty/query/FacetTopicCountComparator.java | 4 +- .../org/nuiton/wikitty/query/ListObjectOrMap.java | 6 +- .../org/nuiton/wikitty/query/WikittyQuery.java | 12 +- .../wikitty/query/WikittyQueryMakerAbstract.java | 183 +++++++++++---------- .../nuiton/wikitty/query/WikittyQueryParser.java | 10 +- .../nuiton/wikitty/query/WikittyQueryResult.java | 22 ++- .../wikitty/query/WikittyQueryVisitorCopy.java | 6 +- .../query/conditions/AbstractCondition.java | 4 +- .../nuiton/wikitty/query/conditions/Equals.java | 6 +- .../nuiton/wikitty/query/conditions/Keyword.java | 8 +- .../nuiton/wikitty/query/conditions/NotEquals.java | 10 +- .../wikitty/query/conditions/package-info.java | 84 +++++----- .../java/org/nuiton/wikitty/search/Criteria.java | 4 +- .../nuiton/wikitty/search/RestrictionHelper.java | 8 +- .../java/org/nuiton/wikitty/search/Search.java | 8 +- .../org/nuiton/wikitty/search/operators/And.java | 5 +- .../nuiton/wikitty/search/operators/Between.java | 5 +- .../wikitty/search/operators/BinaryOperator.java | 5 +- .../nuiton/wikitty/search/operators/Contains.java | 5 +- .../nuiton/wikitty/search/operators/EndsWith.java | 5 +- .../nuiton/wikitty/search/operators/Equals.java | 5 +- .../nuiton/wikitty/search/operators/Greater.java | 5 +- .../wikitty/search/operators/GreaterOrEqual.java | 5 +- .../org/nuiton/wikitty/search/operators/In.java | 5 +- .../org/nuiton/wikitty/services/WikittyEvent.java | 20 ++- .../wikitty/services/WikittySecurityUtil.java | 7 +- .../wikitty/services/WikittyServiceAccessStat.java | 5 +- .../services/WikittyServiceAuthorisation.java | 4 +- .../wikitty/services/WikittyServiceCached.java | 4 +- .../wikitty/services/WikittyServiceSecurity.java | 3 +- .../wikitty/services/WikittyServiceStorage.java | 22 ++- .../services/WikittyServiceTransaction.java | 5 +- .../wikitty/services/XMPPNotifierTransporter.java | 17 +- .../org/nuiton/wikitty/storage/WikittyStorage.java | 4 +- .../nuiton/wikitty/WikittyClientAbstractTest.java | 2 +- .../java/org/nuiton/wikitty/WikittyUtilTest.java | 12 +- .../org/nuiton/wikitty/query/WikittyQueryTest.java | 5 +- 53 files changed, 394 insertions(+), 379 deletions(-) diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/DateMathParser.java b/wikitty-api/src/main/java/org/nuiton/wikitty/DateMathParser.java index e4abff8..a5152f7 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/DateMathParser.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/DateMathParser.java @@ -21,7 +21,7 @@ package org.nuiton.wikitty; * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2013 CodeLutin + * Copyright (C) 2009 - 2016 CodeLutin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -103,7 +103,7 @@ import org.apache.commons.lang3.StringUtils; * distinct calls to parse (Assuming no other thread calls * "<code>setNow</code>" in the interim). The default value of 'now' is * the time at the moment the <code>DateMathParser</code> instance is - * constructed, unless overridden by the {@link CommonParams#NOW NOW} + * constructed, unless overridden by the {@code CommonParams#NOW} * request param. * </p> * @@ -113,12 +113,12 @@ import org.apache.commons.lang3.StringUtils; * day starts. This not only impacts rounding/adding of DAYs, but also * cascades to rounding of HOUR, MIN, MONTH, YEAR as well. The default * <code>TimeZone</code> used is <code>UTC</code> unless overridden by the - * {@link CommonParams#TZ TZ} + * {@code CommonParams#TZ} * request param. * </p> * - * @see SolrRequestInfo#getClientTimeZone - * @see SolrRequestInfo#getNOW + * See SolrRequestInfo#getClientTimeZone + * See SolrRequestInfo#getNOW */ public class DateMathParser { @@ -180,9 +180,11 @@ public class DateMathParser { /** * Set date with pattern like 2013??01 - * <li>ex: now=201311 conserve le jour et l'heure mais change le mois et l'annee a novembre 2013 - * <li>ex: now=????1131 conserve l'annee mais change le mois et le jour 31 novembre - * <li>ex: now=???????? ne change rien + * <ul> + * <li>ex: now=201311 conserve le jour et l'heure mais change le mois et l'annee a novembre 2013</li> + * <li>ex: now=????1131 conserve l'annee mais change le mois et le jour 31 novembre</li> + * <li>ex: now=???????? ne change rien</li> + * </ul> * * @param c * @param pattern @@ -205,9 +207,11 @@ public class DateMathParser { /** * Set hour with pattern hhmmss - * <li>now:1200 conserve le jour mais change l'heure a 12:00 - * <li>now:?????? ne change rien - * + * <ul> + * <li>now:1200 conserve le jour mais change l'heure a 12:00</li> + * <li>now:?????? ne change rien</li> + * </ul> + * * @param c * @param pattern */ @@ -299,7 +303,7 @@ public class DateMathParser { * Default constructor that assumes UTC should be used for rounding unless * otherwise specified in the SolrRequestInfo * - * @see SolrRequestInfo#getClientTimeZone + * See SolrRequestInfo#getClientTimeZone * @see #DEFAULT_MATH_LOCALE */ public DateMathParser() { @@ -314,7 +318,7 @@ public class DateMathParser { * @see #DEFAULT_MATH_TZ * @see #DEFAULT_MATH_LOCALE * @see Calendar#getInstance(TimeZone,Locale) - * @see SolrRequestInfo#getClientTimeZone + * See SolrRequestInfo#getClientTimeZone */ public DateMathParser(TimeZone tz, Locale l) { loc = (null != l) ? l : DEFAULT_MATH_LOCALE; @@ -337,7 +341,7 @@ public class DateMathParser { * exists -- otherwise it uses a new Date instance at the moment getNow() * is first called. * @see #setNow - * @see SolrRequestInfo#getNOW + * See SolrRequestInfo#getNOW */ public Date getNow() { if (now == null) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java index 0ef17fd..c95cad5 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyClient.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -26,7 +26,6 @@ import java.lang.reflect.Array; import java.lang.reflect.Field; import java.lang.reflect.Method; import java.math.BigDecimal; -import java.math.BigInteger; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; @@ -34,7 +33,6 @@ import java.util.Collections; import java.util.Date; import java.util.HashMap; import java.util.HashSet; -import java.util.Iterator; import java.util.LinkedHashMap; import java.util.LinkedHashSet; import java.util.LinkedList; @@ -43,7 +41,6 @@ import java.util.Map; import java.util.Set; import java.util.regex.Pattern; import org.apache.commons.collections.CollectionUtils; -import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.StringUtils; import org.nuiton.config.ApplicationConfig; import org.nuiton.util.TimeLog; @@ -63,7 +60,6 @@ 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.query.conditions.Aggregate; import org.nuiton.wikitty.query.conditions.Select; import org.nuiton.wikitty.services.WikittyEvent; import org.nuiton.wikitty.services.WikittyExtensionMigrationRegistry; @@ -372,7 +368,6 @@ public class WikittyClient { * @param available available wikitty (restored) * @param loaded already loaded wikitties + field couple * @param preloadPattern pattern used to load - * @return return w with preloaded link */ protected void preload(Wikitty w, Map<String, Wikitty> available, Set<String> loaded, String preloadPattern) { @@ -1421,7 +1416,7 @@ public class WikittyClient { * Delete specified tree node and all sub nodes. * * @param treeNodeId tree node id to delete - * @return {@true} if at least one node has been deleted + * @return {@code true} if at least one node has been deleted */ public WikittyEvent deleteTree(String treeNodeId) { long start = TimeLog.getTime(); diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyConfig.java b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyConfig.java index 0dee382..34560b2 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyConfig.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyConfig.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -34,19 +34,25 @@ import static org.nuiton.i18n.I18n.t; * Configuration de tous les modules Wikitty. La configuration par defaut doit * permettre un bon fonctionnement de wikitty pour quelqu'un souhaitant faire un * essaie rapide. La configuration actuelle: - * <li> wikitty-config.properties comme fichier de configuration - * <li> WikittyServiceInMemory - * <li> pas de notification reseau - * <li> /tmp pour les exports + * <ul> + * <li> wikitty-config.properties comme fichier de configuration</li> + * <li> WikittyServiceInMemory</li> + * <li> pas de notification reseau</li> + * <li> /tmp pour les exports</li> + * </ul> * * Si on utilise WikittyServiceStorage au lieu de WikittyServiceInMemory par defaut - * <li> base h2 embarque - * <li> solr + * <ul> + * <li> base h2 embarque</li> + * <li> solr</li> + * </ul> * * Si on utilise la notification des events - * <li> transporter XMPPNotifierTransporter - * <li> serveur im.codelutin.com - * <li> room test@conference.im.codelutin.com + * <ul> + * <li> transporter XMPPNotifierTransporter</li> + * <li> serveur im.codelutin.com</li> + * <li> room test@conference.im.codelutin.com</li> + * </ul> * * Des la creation de l'objet les fichiers de configuration sont recherches. * diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyException.java b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyException.java index e387cc5..83a3030 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyException.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyException.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -40,7 +40,7 @@ public class WikittyException extends RuntimeException { } /** - * TODO EC20100921 add message with cause use {@link WikittyException(String, Throwable)} + * TODO EC20100921 add message with cause use {@link #WikittyException(String, Throwable)} */ @Deprecated public WikittyException(Throwable cause) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java index 6cd837a..d8719c9 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -1131,7 +1131,7 @@ public class WikittyProxy { * Delete specified tree node and all sub nodes. * * @param treeNodeId tree node id to delete - * @return {@true} if at least one node has been deleted + * @return {@code true} if at least one node has been deleted */ public WikittyEvent deleteTree(String treeNodeId) { long start = TimeLog.getTime(); diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java index 8b8f210..24ce1cc 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -131,7 +131,7 @@ public interface WikittyService { * Recherche si l'utilisateur n'a pas deja un token, et dans ce cas on * retourne le meme token. Sinon on en cree un nouveau * - * @param user l'utilisateur pour l'equel il faut recherche/creer le token + * @param userId l'utilisateur pour l'equel il faut recherche/creer le token * @return le token de l'utilisateur */ public String getToken(String userId); @@ -341,7 +341,7 @@ public interface WikittyService { * associated with the same index. * * @param securityToken security token - * @param query + * @param queries * @return * @since 3.3 */ @@ -397,10 +397,12 @@ public interface WikittyService { * Returned wikitty must include the 'WikittyTreeNode' extension. * * depth ask the recursively level: - * <li> 0 return only wikittyId passed in argument - * <li> 1 return wikittyId passed in argument, and his children - * <li> ... - * <li> negative value return all node + * <ul> + * <li> 0 return only wikittyId passed in argument</li> + * <li> 1 return wikittyId passed in argument, and his children</li> + * <li> ...</li> + * <li> negative value return all node</li> + * </ul> * * if count is true, integer in return map is number of attachment in subtree * (recursively). If filter is not null only attachments that satisfy filter @@ -426,10 +428,12 @@ public interface WikittyService { * Returned wikitty must include the 'WikittyTreeNode' extension. * * depth ask the recursively level: - * <li> 0 return only wikittyId passed in argument - * <li> 1 return wikittyId passed in argument, and his children - * <li> ... - * <li> negative value return all node + * <ul> + * <li> 0 return only wikittyId passed in argument</li> + * <li> 1 return wikittyId passed in argument, and his children</li> + * <li> ...</li> + * <li> negative value return all node</li> + * </ul> * * if count is true, integer in return map is number of attachment in subtree * (recursively). If filter is not null only attachments that satisfy filter diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyUtil.java b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyUtil.java index 8834c9b..ffab79c 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyUtil.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyUtil.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -176,14 +176,16 @@ public class WikittyUtil implements WikittyConstants { tagValuesPatternString, Pattern.DOTALL); /** * Field pattern parser - * <li>group 1: type (string) - * <li>group 2: name (string) - * <li>group 3: lower bound (number) can be null - * <li>group 4: upper bound (number) can be null, mutually exclusive with group 5 - * <li>group 5: upper bound (n or *) can be null - * <li>group 6: unique can be null (legacy configuration, prefer use of {@code unique="true"} - * <li>group 7: not null can be null (legacy configuration, prefer use of {@code notNull="true"} - * <li>group 8: all tag/value (toto=titi tutu=tata;lala tata="truc bidulle") + * <ul> + * <li>group 1: type (string)</li> + * <li>group 2: name (string)</li> + * <li>group 3: lower bound (number) can be null</li> + * <li>group 4: upper bound (number) can be null, mutually exclusive with group 5</li> + * <li>group 5: upper bound (n or *) can be null</li> + * <li>group 6: unique can be null (legacy configuration, prefer use of {@code unique="true"}</li> + * <li>group 7: not null can be null (legacy configuration, prefer use of {@code notNull="true"}</li> + * <li>group 8: all tag/value (toto=titi tutu=tata;lala tata="truc bidulle")</li> + * </ul> */ static protected Pattern fieldPattern = Pattern .compile( @@ -308,7 +310,7 @@ public class WikittyUtil implements WikittyConstants { /** * if version if null return 0 else version If version is not in format - * <major>.<minor>, ".0" is added to the version + * <major>.<minor>, ".0" is added to the version * * @param version version * @return the normalized version @@ -345,7 +347,7 @@ public class WikittyUtil implements WikittyConstants { * * @param v1 version * @param v2 version - * @return {@code true} if v1 > v2 + * @return {@code true} if v1 > v2 */ public static boolean versionGreaterThan(String v1, String v2) { if (v1 != null && v2 == null) { @@ -370,7 +372,7 @@ public class WikittyUtil implements WikittyConstants { * Increment minor version. * * @param v version as 3.1 where 1 is minor and 3 major - * @return incremented minor number (3.1 -> 3.2) + * @return incremented minor number (3.1 -> 3.2) */ static public String incrementMinorRevision(String v) { String result; @@ -394,7 +396,7 @@ public class WikittyUtil implements WikittyConstants { * increment major version. * * @param v version as 3.2 where 2 is minor and 3 major - * @return incremented major number and reset minor number (3.2 -> 4.0) + * @return incremented major number and reset minor number (3.2 -> 4.0) */ static public String incrementMajorRevision(String v) { String result; @@ -410,8 +412,9 @@ public class WikittyUtil implements WikittyConstants { return result; } - /** Pattern de recherche des field dans les chaines de formatage - * @see {@link Formatter#formatSpecifier} + /** + * Pattern de recherche des field dans les chaines de formatage. + * {@code Formatter#formatSpecifier} */ static protected Pattern formatMatcher = Pattern.compile("%([^0-9][^|$]*)(?:\\|(.*?))?(\\$(:?[-#+ 0,(\\<]*)?(:?\\d+)?(:?\\.\\d+)?[tT]?[a-zA-Z])"); @@ -419,11 +422,13 @@ public class WikittyUtil implements WikittyConstants { /** * Format wikitty for string representation. * exemple: - * <li> "%Person.lastName$s %Person.firstName$s: %Person.birthday$tm %Person.birthday$te,%Person.birthday$tY" - * <li> "Hello %Person.firstName|unknown$s" if firstName field doesn't exist, unknow is used - * <li> "My company %Employee.company,Company.name|unknown$s" if employee has company field and this company has name field + * <ul> + * <li> "%Person.lastName$s %Person.firstName$s: %Person.birthday$tm %Person.birthday$te,%Person.birthday$tY"</li> + * <li> "Hello %Person.firstName|unknown$s" if firstName field doesn't exist, unknow is used</li> + * <li> "My company %Employee.company,Company.name|unknown$s" if employee has company field and this company has name field</li> + * </ul> * - * @param format format as {@link http://download.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax} + * @param formatWikitty format as <a href="http://download.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax">Syntax</a> * except that position is replace with fq field name. * @param w wikitty to format * @return String that represent the wikitty @@ -622,8 +627,8 @@ public class WikittyUtil implements WikittyConstants { /** * Convert object to boolean: * <ul> - * <li>- null => false - 0 => false - numeric => true - * <li>- object.toString() == false => false - other => true + * <li>- null => false - 0 => false - numeric => true + * <li>- object.toString() == false => false - other => true * </ul> * * @param value value @@ -683,8 +688,10 @@ public class WikittyUtil implements WikittyConstants { * Date et Calendar sont directement supporte, tous les autres types sont * transformer en String et parser pour construire la Date. * - * <li>Si la chaine est 'NOW', la date courante est utilisee avec l'heure courant - * <li>Si la chaine est 'TODAY', la date courante est utilisee avec l'heure a 0 + * <ul> + * <li>Si la chaine est 'NOW', la date courante est utilisee avec l'heure courant</li> + * <li>Si la chaine est 'TODAY', la date courante est utilisee avec l'heure a 0</li> + * </ul> * * L'implantation de cette methode n'est pas satisfaisante, il faudrait * trouver un meilleur algo. Le but est de parser la date suivant different @@ -904,7 +911,7 @@ public class WikittyUtil implements WikittyConstants { * Convert object o for export CSV/XML. * * @param field field description - * @param o field value + * @param s field value * @return solr representation */ static public Object fromStringForExport(FieldType field, String s) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyImportExportService.java b/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyImportExportService.java index 4ae750a..e03bf95 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyImportExportService.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyImportExportService.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -209,7 +209,6 @@ public class WikittyImportExportService { * * @param format export format * @param e sample - * @return export string */ public void syncExportAllByExample(FORMAT format, BusinessEntityImpl e, Writer writer) { @@ -262,7 +261,6 @@ public class WikittyImportExportService { * * @param format export format * @param query criteria - * @return export as string */ public void syncExportAllByQuery(FORMAT format, WikittyQuery query, Writer writer) { ExportQueryTask task = new ExportQueryTask(client, format, query, writer); @@ -319,7 +317,6 @@ public class WikittyImportExportService { * * @param format export format * @param criteria criteria - * @return export as string * @deprecated since 3.4 user {@link #syncExportAllByQuery(org.nuiton.wikitty.addons.WikittyImportExportService.FORMAT, org.nuiton.wikitty.query.WikittyQuery, java.io.Writer) } */ @Deprecated diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyLabelUtil.java b/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyLabelUtil.java index 432cb39..92a4538 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyLabelUtil.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/addons/WikittyLabelUtil.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin + * Copyright (C) 2009 - 2016 CodeLutin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -80,8 +80,6 @@ public class WikittyLabelUtil { * version in WikittyService. If you have Wikitty present in your space, your * wikitty become obsolete and you lose your change :( * - * If you have wikitty or business entity you must used {@link #} - * * @param proxy * @param wikittyId object'id * @param label label to add @@ -101,8 +99,6 @@ public class WikittyLabelUtil { * version in WikittyService. If you have Wikitty present in your space, your * wikitty become obsolete and you lose your change :( * - * If you have wikitty or business entity you must used {@link #} - * * @param client * @param wikittyId object'id * @param label label to add @@ -142,7 +138,7 @@ public class WikittyLabelUtil { * * @param client * @param label - * @param first + * @param firstIndex * @param limit * @return */ @@ -206,7 +202,7 @@ public class WikittyLabelUtil { /** * Retrieve all labels applied on a wikitty object. * - * @param client + * @param proxy * @param wikittyId * @return set of label */ diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/addons/importexport/ImportExportMethod.java b/wikitty-api/src/main/java/org/nuiton/wikitty/addons/importexport/ImportExportMethod.java index 3c3b2e2..52da6d3 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/addons/importexport/ImportExportMethod.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/addons/importexport/ImportExportMethod.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -30,7 +30,6 @@ import org.nuiton.wikitty.search.PagedResult; import org.nuiton.wikitty.entities.Wikitty; import org.nuiton.wikitty.WikittyService; import org.nuiton.wikitty.query.WikittyQueryResult; -import org.nuiton.wikitty.services.WikittyTransaction; /** * Import / export interface. @@ -46,11 +45,8 @@ public interface ImportExportMethod { /** * Import data from reader. * - * @param securityToken security token + * @param client client * @param reader reader - * @param ws wikitty service - * @param transaction current transaction - * @param batchUpdate wikitty batch update helper * * @throws Exception */ @@ -62,8 +58,6 @@ public interface ImportExportMethod { * @param securityToken security token * @param reader reader * @param ws wikitty service - * @param transaction current transaction - * @param batchUpdate wikitty batch update helper * * @throws Exception * @deprecated since 3.4 use {@link #importReader(org.nuiton.wikitty.WikittyClient, java.io.Reader) } @@ -74,11 +68,9 @@ public interface ImportExportMethod { /** * Export data to writer. * - * @param securityToken security token + * @param client client * @param writer writer - * @param ws wikitty service - * @param transaction current transaction - * @param pagedResult paged result + * @param queryResult paged result * * @throws Exception */ @@ -91,7 +83,6 @@ public interface ImportExportMethod { * @param securityToken security token * @param writer writer * @param ws wikitty service - * @param transaction current transaction * @param pagedResult paged result * * @throws Exception diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/ElementNode.java b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/ElementNode.java index cef4e4c..dd0658d 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/ElementNode.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/ElementNode.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -23,9 +23,11 @@ package org.nuiton.wikitty.entities; /** * Represente un element pour les recherches sur les arbres. Vous devez utiliser - * <li> {@link ElementNode#FIELD_NODE_ROOT} utilise pour creer une condition sur le noeud root de l'arbre - * <li> {@link ElementNode#FIELD_NODE_PATH} utilise pour creer une condition sur un noeud ou un de ses peres - * <li> {@link ElementNode#FIELD_NODE_DEPTH} utilise pour creer une condition sur la profondeur d'un noeud (root=1) + * <ul> + * <li> {@link ElementNode#FIELD_NODE_ROOT} utilise pour creer une condition sur le noeud root de l'arbre</li> + * <li> {@link ElementNode#FIELD_NODE_PATH} utilise pour creer une condition sur un noeud ou un de ses peres</li> + * <li> {@link ElementNode#FIELD_NODE_DEPTH} utilise pour creer une condition sur la profondeur d'un noeud (root=1)</li> + * </ul> * @author poussin * @version $Revision$ * diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/FieldType.java b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/FieldType.java index 2cb4ccb..aea5b33 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/FieldType.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/FieldType.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -96,7 +96,7 @@ public class FieldType implements WikittyTagValue, Serializable { } /** - * Return true if this field have upperBound > 1. + * Return true if this field have upperBound > 1. * * @return {@code true} is field is collection */ diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java index b0f014d..847b162 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java @@ -501,7 +501,7 @@ public interface Wikitty extends Cloneable, Serializable { /** * Return String representation of this wikitty with toString specific * format of extension passed in argument. If this extension doesn't have - * specifique toString, normal toString is called {@link #toString()} + * specifique toString, normal toString is called {@link Object#toString()} */ public String toString(String extName); diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyCopyOnWrite.java b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyCopyOnWrite.java index 5bbb377..d67f8a4 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyCopyOnWrite.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyCopyOnWrite.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -45,7 +45,7 @@ import org.nuiton.wikitty.WikittyException; * if change are cancelled, next restore will restore the original and not * the modified version (until the modified version is stored). * - * used in {@link WikittyServiceCached} + * used in {@link org.nuiton.wikitty.services.WikittyServiceCached} */ public class WikittyCopyOnWrite implements Wikitty { @@ -424,7 +424,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#addToField(String, Object) + * @see org.nuiton.wikitty.entities.Wikitty#addToField(String, Object) */ @Override public void addToField(String fqFieldName, Object value) { @@ -433,7 +433,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#removeFromField(String, Object) + * @see org.nuiton.wikitty.entities.Wikitty#removeFromField(String, Object) */ @Override public void removeFromField(String fqFieldName, Object value) { @@ -442,7 +442,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#clearField(String) + * @see org.nuiton.wikitty.entities.Wikitty#clearField(String) */ @Override public void clearField(String fqFieldName) { @@ -493,7 +493,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#getDirty() + * @see org.nuiton.wikitty.entities.Wikitty#getDirty() */ @Override public Set<String> getDirty() { @@ -501,7 +501,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#clearDirty() + * @see org.nuiton.wikitty.entities.Wikitty#clearDirty() */ @Override public void clearDirty() { @@ -510,7 +510,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#setFqField(String, Object) + * @see org.nuiton.wikitty.entities.Wikitty#setFqField(String, Object) */ @Override public void setFqField(String fieldName, Object value) { @@ -524,7 +524,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#hasMetaExtension(String, String) + * @see org.nuiton.wikitty.entities.Wikitty#hasMetaExtension(String, String) */ @Override public boolean hasMetaExtension(String metaExtensionName, @@ -533,7 +533,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#addMetaExtension(WikittyExtension, WikittyExtension) + * @see org.nuiton.wikitty.entities.Wikitty#addMetaExtension(WikittyExtension, WikittyExtension) */ @Override public void addMetaExtension(WikittyExtension metaExtension, @@ -543,7 +543,7 @@ public class WikittyCopyOnWrite implements Wikitty { } /** - * @see org.nuiton.wikitty.Wikitty#addMetaExtension(WikittyExtension, String) + * @see org.nuiton.wikitty.entities.Wikitty#addMetaExtension(WikittyExtension, String) */ @Override public void addMetaExtension(WikittyExtension metaExtension, diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyExtension.java b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyExtension.java index d79ffaa..f20063f 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyExtension.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyExtension.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -243,7 +243,7 @@ public class WikittyExtension implements Serializable { * * @param fqFieldName fully qualified field name like 'WikittyUser.login' * @return return extension name. Example 'WikittyUser' - * @throws WikittyException if bad fqFieldName format + * @throws org.nuiton.wikitty.WikittyException if bad fqFieldName format */ static public String extractExtensionName(String fqFieldName) { int i = fqFieldName.indexOf(WikittyUtil.FQ_FIELD_NAME_SEPARATOR); @@ -340,8 +340,7 @@ public class WikittyExtension implements Serializable { /** * Cette methode ne doit-etre utilise que par des methodes qui tri par la * suite la Map de champs, car celle-ci ne le fait pas - * @param fieldName - * @param type + * @param newFields */ protected void addField(Map<String, FieldType> newFields) { // check fieldname and fieldType diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyImpl.java b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyImpl.java index 5a22fbd..f2c1b9e 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyImpl.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/entities/WikittyImpl.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -54,8 +54,10 @@ import java.util.Set; * Wikitty implementation. * * {@link #getDirty()} contains 2 types of info : + * <ul> * <li>the name of a modified field (extension.field)</li> * <li>an extension added or deleted (extension)</li> + * </ul> * * @author poussin * @version $Revision$ @@ -115,8 +117,10 @@ public class WikittyImpl implements Wikitty { /** * Ensemble des liens vers des Wikitty precharge. Cette map peut-etre null * si aucun prechargement n'existe. - * <li> key: wikitty id - * <li> value: wikitty + * <ul> + * <li> key: wikitty id</li> + * <li> value: wikitty</li> + * </ul> */ // poussin 20120305 peut-etre mettre transient le champs ? a voir a l'usage protected Map<String, Wikitty> preloaded; diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/FacetTopicCountComparator.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/FacetTopicCountComparator.java index 7f97934..e8a292c 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/FacetTopicCountComparator.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/FacetTopicCountComparator.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -44,7 +44,7 @@ public class FacetTopicCountComparator implements Comparator<FacetTopic> { final static public Comparator<FacetTopic> instance = new FacetTopicCountComparator(); /** - * You must use {@link instance} + * You must use {@link #instance} */ public FacetTopicCountComparator() { } diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/ListObjectOrMap.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/ListObjectOrMap.java index 6db963b..6b7df69 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/ListObjectOrMap.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/ListObjectOrMap.java @@ -4,7 +4,7 @@ package org.nuiton.wikitty.query; * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2013 CodeLutin + * Copyright (C) 2009 - 2016 CodeLutin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -38,13 +38,13 @@ import org.apache.commons.logging.LogFactory; * Encapsule une liste pour permettre une iteration et une modification facile * des valeurs de cette listes. Les valeurs peuvent etre dans des maps, il est * donc penible de parcourrir la liste, puis les maps, puis de modifier les - * valeurs de ces maps. La method {@link iter} retourne un iterator qui permet + * valeurs de ces maps. La method {@link #iter()} retourne un iterator qui permet * d'avance aussi bien dans la liste si celle-ci ne contient pas de Map ou dans * les valeurs des Map si la liste est constituee de Map. * Il est alors possible de recupere la valeur courante, modifier la valeur * courante ou recuperer une Key qui permettra de mettre a jour l'element * plus tard. Cette Class est surtout utilise pour la methode - * {@link WikittyClient#castTo} + * {@link org.nuiton.wikitty.WikittyClient#castTo} * * @author poussin * @version $Revision$ diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQuery.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQuery.java index dd3af3e..5676c24 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQuery.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQuery.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -90,7 +90,7 @@ public class WikittyQuery implements Serializable { /** * if true facet is done on extension name. Extention facet can be found * in {@link WikittyQueryResult#getFacets()} with key - * {@link Element.EXTENSION#getValue()} + * {@link org.nuiton.wikitty.entities.Element#EXTENSION} */ protected boolean facetExtension = false; @@ -130,9 +130,11 @@ public class WikittyQuery implements Serializable { * n'est pas un select on remonte les objets non lisible * * si checkAuthorisation est: - * <li>true alors filtre actif - * <li>false et requete sans select alors filtre inactif - * <li>false et requete select alors filtre <strong>actif</strong> + * <ul> + * <li>true alors filtre actif</li> + * <li>false et requete sans select alors filtre inactif</li> + * <li>false et requete select alors filtre <strong>actif</strong></li> + * </ul> */ public boolean isCheckAuthorisation() { boolean result = checkAuthorisation || condition instanceof Select; diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryMakerAbstract.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryMakerAbstract.java index cc7b1f0..2bc8349 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryMakerAbstract.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryMakerAbstract.java @@ -100,7 +100,6 @@ import org.nuiton.wikitty.query.function.WikittyQueryFunctionWrapper; * * // ... constructeurs et methodes supplementaires ... * - * @Override * MonMaker asM() { * return this; * } @@ -574,7 +573,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr /** * Ajoute une condition, cette condition est prise comme une condition terminal * Si l'on veut continuer a construire la requete, il faut avoir ajouter - * avant une {@link #and()}, {@link #or()}, {@link #not()}, {@link #containsOne()} + * avant une {@link #and()}, {@link #or()}, {@link #not()}, {@link #containsOne(String)} * @param c la condition a ajouter * @return {@code this} with the {@code c} restriction added. */ @@ -587,7 +586,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Parse et ajoute un bout de requete. Cette requete est prise comme une * condition terminal si l'on veut continuer a construire la requete, il * faut avoir ajouter avant une - * {@link #and()}, {@link #or()}, {@link #not()}, {@link #containsOne()} + * {@link #and()}, {@link #or()}, {@link #not()}, {@link #containsOne(String)} * @param query la requete a ajouter (peut-etre vide ou nul, dans ce cas, la * condition utiliser est "true") * @param includeExtra copy offset, limit, depth found in query if true @@ -613,7 +612,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Parse et ajoute un bout de requete. Cette requete est prise comme une * condition terminal si l'on veut continuer a construire la requete, il * faut avoir ajouter avant une - * {@link #and()}, {@link #or()}, {@link #not()}, {@link #containsOne()} + * {@link #and()}, {@link #or()}, {@link #not()}, {@link #containsOne(String)} * @param query la requete a ajouter (peut-etre vide ou nul, dans ce cas, la * condition utiliser est "true") * @return {@code this} with the {@code c} restriction added. @@ -666,7 +665,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link ContainsAll} + * @see #containsAll(Element) */ public M containsAll(Element element) { addCondition(new ContainsAll(element)); @@ -674,7 +673,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link ContainsAll} + * @see #containsAll(String) */ public M containsAll(String element) { return containsAll(Element.get(element)); @@ -692,10 +691,10 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Force l'ajout du containsAll en terminal (il n'y a pas besoin de faire * de {@link #close()} * - * @param element the element on which the restriction is put + * @param fqfield the element on which the restriction is put * @param values the values to search in the element * @return {@code this} with the {@code contains} restriction added. - * @see {@link ContainsAll} + * @see #containsAll(Element) */ public <E> M containsAll(String fqfield, Collection<E> values) { return containsAll(Element.get(fqfield), values); @@ -705,7 +704,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Force l'ajout du containsAll en terminal (il n'y a pas besoin de faire * de {@link #close()} * - * @see {@link ContainsAll} + * @see #containsAll(Element) */ public <E> M containsAll(Element element, Collection<E> values) { containsAll(element); @@ -728,11 +727,11 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Force l'ajout du containsAll en terminal (il n'y a pas besoin de faire * de {@link #close()} * - * @param element the element on which the restriction is put + * @param fqfield the element on which the restriction is put * @param value1 first value to search in the field * @param values list of values to search in the field * @return {@code this} with the {@code contains} restriction added. - * @see {@link ContainsAll} + * @see #containsAll(String) */ public <E> M containsAll(String fqfield, E value1, E ... values) { List<E> l = new LinkedList<E>(); @@ -742,7 +741,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link ContainsOne} + * @see #containsOne(Element) */ public M containsOne(Element element) { addCondition(new ContainsOne(element)); @@ -750,7 +749,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link ContainsOne} + * @see #containsOne(Element) */ public M containsOne(String element) { return containsOne(Element.get(element)); @@ -765,10 +764,10 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Force l'ajout du containsOne en terminal (il n'y a pas besoin de faire * de {@link #close()} * - * @param element the element on which the restriction is put + * @param fqfield the element on which the restriction is put * @param values list of values the field must be in * @return {@code this} with the {@code in} restriction added. - * @see {@link ContainsOne} + * @see #containsOne(Element) */ public <E> M containsOne(String fqfield, Collection<E> values) { return containsOne(Element.get(fqfield), values); @@ -778,7 +777,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Force l'ajout du containsOne en terminal (il n'y a pas besoin de faire * de {@link #close()} * - * @see {@link ContainsOne} + * @see #containsOne(Element) */ public <E> M containsOne(Element element, Collection<E> values) { containsOne(element); @@ -800,11 +799,11 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Force l'ajout du containsAll en terminal (il n'y a pas besoin de faire * de {@link #close()} * - * @param element the element on which the restriction is put + * @param fqfield the element on which the restriction is put * @param value1 first value the field must be in * @param values list of values the field must be in * @return {@code this} with the {@code in} restriction added. - * @see {@link ContainsOne} + * @see #containsOne(String) */ public <E> M containsOne(String fqfield, E value1, E ... values) { List<E> l = new LinkedList<E>(); @@ -814,7 +813,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link Equals} + * @see Equals */ public M eq(Element element) { addCondition(new Equals(element)); @@ -828,17 +827,17 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * You might use patterns in your equality. * - * @param element the field on which the search is made + * @param fqfield the field on which the search is made * @param value the value the element must be equals to * @return {@code this} - * @see {@link Equals} + * @see Equals */ public M eq(String fqfield, Object value) { return eq(Element.get(fqfield), value); } /** - * @see {@link Equals} + * @see Equals */ public M eq(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -847,7 +846,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link Equals} + * @see Equals */ public M eqIgnoreCaseAndAccent(Element element) { addCondition(new Equals(element, true)); @@ -861,17 +860,17 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * You might use patterns in your equality. * - * @param element the field on which the search is made + * @param fqfield the field on which the search is made * @param value the value the element must be equals to * @return {@code this} - * @see {@link Equals} + * @see Equals */ public M eqIgnoreCaseAndAccent(String fqfield, Object value) { return eqIgnoreCaseAndAccent(Element.get(fqfield), value); } /** - * @see {@link Equals} + * @see Equals */ public M eqIgnoreCaseAndAccent(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -884,9 +883,9 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * Restrict search to wikitties that got the extension in parameter. * - * @param s the extension to restrict the results to + * @param extensionName the extension to restrict the results to * @return {@code this} with the {@code exteq} restriction added. - * @see {@link Equals} + * @see Equals */ public M exteq(String extensionName) { return eq(Element.EXTENSION, extensionName); @@ -897,9 +896,9 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * Restrict search to wikitties that got the id in parameter. * - * @param value the id or wikitty to restrict the results to + * @param idOrWikitty the id or wikitty to restrict the results to * @return {@code this} with the {@code ideq} restriction added. - * @see {@link Equals} + * @see Equals */ public M ideq(Object idOrWikitty) { return eq(Element.ID, idOrWikitty); @@ -912,14 +911,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param extensionNames list of the extension to restrict the results to * @return {@code this} with the {@code exteq} restriction added. - * @see {@link ContainsAll} + * @see #containsAll(Element) */ public M extContainsAll(Collection<String> extensionNames) { return containsAll(Element.EXTENSION, extensionNames); } /** - * @see {@link ContainsAll} + * @see #containsAll(Element) */ public M extContainsAll(String ext1, String ... exts) { List<String> l = new LinkedList<String>(); @@ -935,14 +934,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param extensionNames list of the extension to restrict the results to * @return {@code this} with the {@code exteq} restriction added. - * @see {@link ContainsAll} + * @see #containsOne(Element) */ public M extContainsOne(Collection<String> extensionNames) { return containsOne(Element.EXTENSION, extensionNames); } /** - * @see {@link ContainsOne} + * @see #containsOne(Element) */ public M extContainsOne(String ext1, String ... exts) { List<String> l = new LinkedList<String>(); @@ -952,7 +951,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link NotEquals} + * @see NotEquals */ public M ne(Element element) { addCondition(new NotEquals(element)); @@ -968,14 +967,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put * @param value the value the element must not be equals to. * @return {@code this} with the {@code neq} restriction added. - * @see {@link NotEquals} + * @see NotEquals */ public M ne(String fqfield, Object value) { return ne(Element.get(fqfield), value); } /** - * @see {@link NotEquals} + * @see NotEquals */ public M ne(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -984,7 +983,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link NotEquals} + * @see NotEquals */ public M neIgnoreCaseAndAccent(Element element) { addCondition(new NotEquals(element, true)); @@ -1000,14 +999,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put * @param value the value the element must not be equals to. * @return {@code this} with the {@code neq} restriction added. - * @see {@link NotEquals} + * @see NotEquals */ public M neIgnoreCaseAndAccent(String fqfield, Object value) { return neIgnoreCaseAndAccent(Element.get(fqfield), value); } /** - * @see {@link NotEquals} + * @see NotEquals */ public M neIgnoreCaseAndAccent(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -1023,7 +1022,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param extensionName the extension that the wikitties must not have. * @return {@code this} with the {@code extneq} restriction added. - * @see {@link NotEquals} + * @see NotEquals */ public M extne(String extensionName) { return ne(Element.EXTENSION, extensionName); @@ -1036,14 +1035,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param idOrWikitty the id the wikitties must not have. * @return {@code this} with the {@code idne} restriction added. - * @see {@link NotEquals} + * @see NotEquals */ public M idne(Object idOrWikitty) { return ne(Element.ID, idOrWikitty); } /** - * @see {@link Greater} + * @see Greater */ public M gt(Element element) { addCondition(new Greater(element)); @@ -1058,14 +1057,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put * @param value the value to be compared to * @return {@code this} with the {@code gt} restriction added. - * @see {@link Greater} + * @see Greater */ public M gt(String fqfield, Object value) { return gt(Element.get(fqfield), value); } /** - * @see {@link Greater} + * @see Greater */ public M gt(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -1074,7 +1073,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link GreaterOrEquals} + * @see GreaterOrEquals */ public M ge(Element element) { addCondition(new GreaterOrEquals(element)); @@ -1089,14 +1088,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the field on which the search is made * @param value the value to be compared to * @return {@code this} with the {@code ge} restriction added. - * @see {@link GreaterOrEquals} + * @see GreaterOrEquals */ public M ge(String fqfield, Object value) { return ge(Element.get(fqfield), value); } /** - * @see {@link GreaterOrEquals} + * @see GreaterOrEquals */ public M ge(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -1105,7 +1104,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link Less} + * @see Less */ public M lt(Element element) { addCondition(new Less(element)); @@ -1120,14 +1119,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put * @param value the value to be compared to * @return {@code this} with the {@code lt} restriction added. - * @see {@link Less} + * @see Less */ public M lt(String fqfield, Object value) { return lt(Element.get(fqfield), value); } /** - * @see {@link Less} + * @see Less */ public M lt(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -1136,7 +1135,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link LessOrEquals} + * @see LessOrEquals */ public M le(Element element) { addCondition(new LessOrEquals(element)); @@ -1151,14 +1150,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put. * @param value the value to be compared to. * @return {@code this} with the {@code le} restriction added. - * @see {@link LessOrEquals} + * @see LessOrEquals */ public M le(String fqfield, Object value) { return le(Element.get(fqfield), value); } /** - * @see {@link LessOrEquals} + * @see LessOrEquals */ public M le(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -1167,7 +1166,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link Between} + * @see Between */ public M bw(Element element) { addCondition(new Between(element)); @@ -1184,14 +1183,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param lowerValue the lower bound. * @param upperValue the upper bound. * @return {@code this} with the {@code le} restriction added. - * @see {@link Between} + * @see Between */ public M bw(String fqfield, Object lowerValue, Object upperValue) { return bw(Element.get(fqfield), lowerValue, upperValue); } /** - * @see {@link Between} + * @see Between */ public M bw(Element element, Object lowerValue, Object upperValue) { ConditionValue min = convertToConditionValue(lowerValue); @@ -1208,14 +1207,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put. * @param value the value the element must start with. * @return {@code this} with the {@code sw} restriction added. - * @see {@link Equals} + * @see Equals */ public M sw(String fqfield, String value) { return sw(Element.get(fqfield), value); } /** - * @see {@link Equals} + * @see Equals */ public M sw(Element element, String value) { addCondition(new Equals(element, value + "*")); @@ -1230,14 +1229,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put. * @param value the value the element must not start with. * @return {@code this} with the {@code nsw} restriction added. - * @see {@link NotEquals} + * @see NotEquals */ public M notsw(String fqfield, String value) { return notsw(Element.get(fqfield), value); } /** - * @see {@link NotEquals} + * @see NotEquals */ public M notsw(Element element, String value) { addCondition(new NotEquals(element, value + "*")); @@ -1252,14 +1251,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put * @param value the value the element must ends with. * @return {@code this} with the {@code ew} restriction added. - * @see {@link Equals} + * @see Equals */ public M ew(String fqfield, Object value) { return ew(Element.get(fqfield), value); } /** - * @see {@link Equals} + * @see Equals */ public M ew(Element element, Object value) { addCondition(new Equals(element, "*" + value)); @@ -1274,14 +1273,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put * @param value the value the element must not ends with. * @return {@code this} with the {@code notew} restriction added. - * @see {@link NotEquals} + * @see NotEquals */ public M notew(String fqfield, Object value) { return notew(Element.get(fqfield), value); } /** - * @see {@link NotEquals} + * @see NotEquals */ public M notew(Element element, Object value) { addCondition(new NotEquals(element, "*" + value)); @@ -1294,9 +1293,8 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Search if the value in parameter is present in any field of any * extension. * - * @param value the value to find. * @return {@code this} with the {@code keyword} restriction added. - * @see {@link Keyword} + * @see Keyword */ public M keyword() { addCondition(new Keyword()); @@ -1311,7 +1309,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param value the value to find. * @return {@code this} with the {@code keyword} restriction added. - * @see {@link Keyword} + * @see Keyword */ public M keyword(Object value) { ConditionValue s = convertToConditionValue(value); @@ -1326,14 +1324,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param fqfield the field that must be null. * @return {@code this} with the {@code isNull} restriction added. - * @see {@link Null} + * @see Null */ public M isNull(String fqfield) { return isNull(Element.get(fqfield)); } /** - * @see {@link Null} + * @see Null */ public M isNull(Element element) { addCondition(new Null(element)); @@ -1347,14 +1345,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param fqfield the field that must not be null. * @return {@code this} with the {@code isNotNull} restriction added. - * @see {@link NotNull} + * @see NotNull */ public M isNotNull(String fqfield) { return isNotNull(Element.get(fqfield)); } /** - * @see {@link NotNull} + * @see NotNull */ public M isNotNull(Element element) { addCondition(new NotNull(element)); @@ -1367,7 +1365,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Add a restriction that always return false. * * @return {@code this} with the {@code rFalse} restriction added. - * @see {@link False} + * @see False */ public M rFalse() { addCondition(new False()); @@ -1380,7 +1378,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * Add a restriction that always return true. * * @return {@code this} with the {@code rTrue} restriction added. - * @see {@link True} + * @see True */ public M rTrue() { addCondition(new True()); @@ -1388,7 +1386,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link Like} + * @see Like */ public M like(Element element) { addCondition(new Like(element)); @@ -1404,14 +1402,14 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * @param fqfield the element on which the restriction is put * @param value * @return {@code this} - * @see {@link Like} + * @see Like */ public M like(String fqfield, Object value) { return like(Element.get(fqfield), value); } /** - * @see {@link Like} + * @see Like */ public M like(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -1421,7 +1419,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr } /** - * @see {@link Unlike} + * @see Unlike */ public M unlike(Element element) { addCondition(new Unlike(element)); @@ -1433,16 +1431,15 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr * * @param fqfield the element on which the restriction is put * @param value - * @param searchAs * @return {@code this} - * @see {@link Unlike} + * @see Unlike */ public M unlike(String fqfield, Object value) { return unlike(Element.get(fqfield), value); } /** - * @see {@link Unlike} + * @see Unlike */ public M unlike(Element element, Object value) { ConditionValue s = convertToConditionValue(value); @@ -1453,9 +1450,11 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr /** * Not (sub query). To close this sub query you must used {@link #close()} - * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close(); + * <ul> + * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close();</li> + * </ul> * - * @see {@link Not} + * @see Not */ public M not() { Condition child = new Not(); @@ -1465,9 +1464,11 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr /** * Or (sub query). To close this sub query you must used {@link #close()} - * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close(); + * <ul> + * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close();</li> + * </ul> * - * @see {@link Or} + * @see Or */ public M or() { Condition child = new Or(); @@ -1477,9 +1478,11 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr /** * And (sub query). To close this sub query you must used {@link #close()} - * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close(); + * <ul> + * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close();</li> + * </ul> * - * @see {@link And} + * @see And */ public M and() { Condition child = new And(); @@ -1488,7 +1491,7 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr return this.asM(); } - /** + /* * Add {@link Select}, this condition must be first or * @param element le champs dont il faut extraire les donnees * @return {@code this} @@ -1536,7 +1539,9 @@ public abstract class WikittyQueryMakerAbstract<M extends WikittyQueryMakerAbstr /** * Close last non terminal condition (or, and, not, in). Or Last Function in select clause - * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close(); + * <ul> + * <li>ex: WikittyQueryMaker().not().rTrue().close().and().rTrue().rFalse().close().or().rTrue().rFalse().close();</li> + * </ul> * @return */ public M close() { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryParser.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryParser.java index 9ec78e3..be56d48 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryParser.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryParser.java @@ -293,10 +293,12 @@ public class WikittyQueryParser extends BaseParser<Object> { /** * Remove quote at beginning and ending of String in parameter if necessary * - * <li>"toto" return toto - * <li>"toto return "toto - * <li> toto return toto" - * <li> to"to return to"to + * <ul> + * <li>"toto" return toto</li> + * <li>"toto return "toto</li> + * <li> toto return toto"</li> + * <li> to"to return to"to</li> + * </ul> * * @param s * @return diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryResult.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryResult.java index 81b1047..f338297 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryResult.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryResult.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -120,7 +120,7 @@ public class WikittyQueryResult<T> implements Serializable, Iterable<T> { } /** - * if this WikittyQueryResult contains Map<String, Object>, and + * if this WikittyQueryResult contains Map<String, Object>, and * each Map contains only one value, this methode return * new WikittyQueryResult with value only (no more map). * @@ -423,8 +423,10 @@ public class WikittyQueryResult<T> implements Serializable, Iterable<T> { * Get map represent facets. * * return map of list - * <li>key is facet name - * <li>value is topic liste une this facet + * <ul> + * <li>key is facet name</li> + * <li>value is topic liste une this facet</li> + * </ul> * * @return all facets */ @@ -436,9 +438,11 @@ public class WikittyQueryResult<T> implements Serializable, Iterable<T> { * Get map represent facets. * * return map of map - * <li>primary key is facet name - * <li>secondary key is topic name - * <li>value is topic + * <ul> + * <li>primary key is facet name</li> + * <li>secondary key is topic name</li> + * <li>value is topic</li> + * </ul> * * @return */ @@ -557,7 +561,7 @@ public class WikittyQueryResult<T> implements Serializable, Iterable<T> { * result don't have the right extension (clazz) this extension is * automatically added. * - * @param queryResult result to convert + * @param client result to convert * @param target to cast into. * Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[] * @return new WikittyQueryResult with element in right class or Exception @@ -591,7 +595,7 @@ public class WikittyQueryResult<T> implements Serializable, Iterable<T> { * result don't have the right extension (clazz) this extension is * automatically added. * - * @param queryResult result to convert + * @param client result to convert * @param target to cast into. * Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[] * @return new WikittyQueryResult with element in right class or Exception diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryVisitorCopy.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryVisitorCopy.java index e649234..7c7b094 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryVisitorCopy.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/WikittyQueryVisitorCopy.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -22,7 +22,6 @@ package org.nuiton.wikitty.query; import java.util.ArrayList; -import java.util.Deque; import java.util.List; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; @@ -49,7 +48,6 @@ import org.nuiton.wikitty.query.conditions.Or; import org.nuiton.wikitty.query.conditions.Select; import org.nuiton.wikitty.query.conditions.True; import org.nuiton.wikitty.query.conditions.Unlike; -import org.nuiton.wikitty.query.function.FunctionFusion; import org.nuiton.wikitty.query.function.FunctionValue; import org.nuiton.wikitty.query.function.WikittyQueryFunction; @@ -62,7 +60,7 @@ import org.nuiton.wikitty.query.function.WikittyQueryFunction; * * Last update: $Date$ * by : $Author$ - * @see {@link WikittyQuery#copy()} + * @see WikittyQuery#copy() */ public class WikittyQueryVisitorCopy extends WikittyQueryVisitor { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java index 13b3c95..551203d 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -53,7 +53,7 @@ public abstract class AbstractCondition implements Condition { * For non terminal condition this method add subCondition. * For terminal this method must return an exception * - * When you override this method, you must call {@link #checkAddCondition} + * When you override this method, you must call {@code #checkAddCondition()} * in first * * @param c diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java index 106af1d..8d476f0 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -33,7 +33,9 @@ import org.nuiton.wikitty.query.WikittyQueryMaker; * This operator used for String check strict equality (case sensitive) * You can used '*' in expression at beginning or ending for String equality. * - * <li> {@link WikittyQueryMaker}.eq("myext.myfield", "*jour") match field "bonjour" but not "BONJOUR" + * <ul> + * <li> {@link WikittyQueryMaker}.eq("myext.myfield", "*jour") match field "bonjour" but not "BONJOUR"</li> + * </ul> * * <p> * You can specify ignoreCaseAndAccent to check equality. This mode diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Keyword.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Keyword.java index 2482cd2..2662059 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Keyword.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Keyword.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -31,8 +31,10 @@ import org.nuiton.wikitty.WikittyException; * contains value the wikitty must be returned. * * ex: - * <li>field value is 'bonjour le monde' - * <li>keyword is 'le' or 'bon' or 'nde' + * <ul> + * <li>field value is 'bonjour le monde'</li> + * <li>keyword is 'le' or 'bon' or 'nde'</li> + * </ul> * * wikitty with this field must be returned * diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java index fc0af99..b998d4d 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -34,13 +34,17 @@ import org.nuiton.wikitty.query.WikittyQueryMaker; * This operator used for String check strict equality (case sensitive) * You can used '*' in expression at beginning or ending for String equality. * - * <li> {@link WikittyQueryMaker}.ne("myext.myfield", "*jour") not match field "bonjour" but match "BONJOUR" + * <ul> + * <li> {@link WikittyQueryMaker}.ne("myext.myfield", "*jour") not match field "bonjour" but match "BONJOUR"</li> + * </ul> * * <p> * You can specify ignoreCaseAndAccent to check equality. This mode * ignore case and accent. * - * <li> {@link WikittyQueryMaker}.neIgnoreCaseAndAccent("myext.myfield", "*jour") not match field "bonjour" and not match "BONJOUR" + * <ul> + * <li> {@link WikittyQueryMaker}.neIgnoreCaseAndAccent("myext.myfield", "*jour") not match field "bonjour" and not match "BONJOUR"</li> + * </ul> * * @author poussin * @version $Revision$ diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/package-info.java b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/package-info.java index f78c106..9b9a770 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/package-info.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/package-info.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -22,65 +22,67 @@ /** * Hierarchie * <ul> - * <li> {@link Condition} + * <li> {@link org.nuiton.wikitty.query.conditions.Condition} * <ul> - * <li> {@link ContainerOperator} les operateurs qui contiennent d'autre operateur + * <li> {@link org.nuiton.wikitty.query.conditions.ContainerOperator} les operateurs qui contiennent d'autre operateur * <ul> - * <li> {@link ContainerUnaryOperator} ne contient qu'un fils + * <li> {@link org.nuiton.wikitty.query.conditions.ContainerUnaryOperator} ne contient qu'un fils * <ul> - * <li> {@link Not} - * <li> {@link Select} - * </ul> - * <li> {@link ContainerNaryOperator} contient N fils, et doivent + * <li> {@link org.nuiton.wikitty.query.conditions.Not}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.Select}</li> + * </ul></li> + * <li> {@link org.nuiton.wikitty.query.conditions.ContainerNaryOperator} contient N fils, et doivent * explicitement etre ferme via un close dans * {@link org.nuiton.wikitty.query.WikittyQueryMaker#close} * <ul> - * <li> {@link And} - * <li> {@link Or} - * </ul> - * </ul> - * </ul> + * <li> {@link org.nuiton.wikitty.query.conditions.And}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.Or}</li> + * </ul></li> + * </ul></li> + * </ul></li> * </ul> * <ul> - * <li> {@link TerminalOperator} ni champs, ni valeur - * <li> {@link True} - * <li> {@link False} - * <li> {@link TerminalUnaryOperator} un champs seulement + * <li> {@link org.nuiton.wikitty.query.conditions.TerminalOperator} ni champs, ni valeur + * <ul> + * <li> {@link org.nuiton.wikitty.query.conditions.True}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.False}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.TerminalUnaryOperator} un champs seulement * <ul> - * <li> {@link Null} - * <li> {@link NotNull} - * </ul> - * <li> {@link TerminalBinaryOperator} un champs et une valeur + * <li> {@link org.nuiton.wikitty.query.conditions.Null}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.NotNull}</li> + * </ul></li> + * <li> {@link org.nuiton.wikitty.query.conditions.TerminalBinaryOperator} un champs et une valeur * <ul> - * <li> {@link Equals} - * <li> {@link Greater} - * <li> {@link GreaterOrEquals} - * <li> {@link Keyword} binary car automatiquement sur tous les champs - * <li> {@link Less} - * <li> {@link LessOrEquals} - * <li> {@link Like} - * <li> {@link NotEquals} - * </ul> - * <li> {@link TerminalTernaryOperator} un champs, et deux valeur + * <li> {@link org.nuiton.wikitty.query.conditions.Equals}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.Greater}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.GreaterOrEquals}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.Keyword} binary car automatiquement sur tous les champs</li> + * <li> {@link org.nuiton.wikitty.query.conditions.Less}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.LessOrEquals}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.Like}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.NotEquals}</li> + * </ul></li> + * <li> {@link org.nuiton.wikitty.query.conditions.TerminalTernaryOperator} un champs, et deux valeur * <ul> - * <li> {@link Between} - * </ul> - * <li> {@link TerminalNaryOperator} un champs et N valeurs, et doivent + * <li> {@link org.nuiton.wikitty.query.conditions.Between}</li> + * </ul></li> + * <li> {@link org.nuiton.wikitty.query.conditions.TerminalNaryOperator} un champs et N valeurs, et doivent * explicitement etre ferme via un close dans * {@link org.nuiton.wikitty.query.WikittyQueryMaker#close} si les * valeur ne sont pas passee au moment de la construction * <ul> - * <li> {@link ContainsAll} - * <li> {@link ContainsOne} - * </ul> + * <li> {@link org.nuiton.wikitty.query.conditions.ContainsAll}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.ContainsOne}</li> + * </ul></li> * </ul> * <ul> - * <li> {@link ConditionValue} les valeurs possibles pour un champs + * <li> {@link org.nuiton.wikitty.query.conditions.ConditionValue} les valeurs possibles pour un champs * <ul> - * <li> {@link ConditionValueString} - * <li> {@link Select} - * </ul> + * <li> {@link org.nuiton.wikitty.query.conditions.ConditionValueString}</li> + * <li> {@link org.nuiton.wikitty.query.conditions.Select}</li> + * </ul></li> * </ul> + * </li> * </ul> */ package org.nuiton.wikitty.query.conditions; diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/Criteria.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/Criteria.java index 37c9b4a..051cb6b 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/Criteria.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/Criteria.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -42,7 +42,7 @@ import org.nuiton.wikitty.search.operators.Restriction; * For search multiple extension use ALL_EXTENSIONS as extension name and * specify field type. * <p> - * Example : Criteria.ALL_EXTENSIONS + Criteria.SEPARATOR + <fieldName> + Criteria.SEPARATOR + FieldType.TYPE.<fieldType> + * Example : Criteria.ALL_EXTENSIONS + Criteria.SEPARATOR + <fieldName> + Criteria.SEPARATOR + FieldType.TYPE.<fieldType> * * @author poussin * @version $Revision$ diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/RestrictionHelper.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/RestrictionHelper.java index b73bb96..5ac9be7 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/RestrictionHelper.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/RestrictionHelper.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -51,10 +51,10 @@ import org.nuiton.wikitty.search.operators.True; import org.nuiton.wikitty.search.operators.Unlike; /** - * @author "Nicolas Chapurlat" <nicolas.chapurlat@logica.com> + * @author "Nicolas Chapurlat" <nicolas.chapurlat@logica.com> * * This class allow you to simply create restriction. - * <p/> + * * Examples : * <pre> * RestrictionHelper.and( @@ -66,7 +66,7 @@ import org.nuiton.wikitty.search.operators.Unlike; * RestrictionHelper.DATE_FORMAT.format (new Date(2008,6,15)))) * ); * </pre> - * <p/> + * * example 2 : I search all content witch content definition id is * "myContentDefId" and attribute def 'ref' witch id is ATT_REF_ID is not equals * to "REF1234567890" diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java index aae9d1f..2cf72c0 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/Search.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -41,10 +41,10 @@ import org.nuiton.wikitty.WikittyUtil; * methods. * * Element : - * * <extensionName>.<fieldName>[.<fieldType>] : search on an extension and field with specific type (optional) - * * Criteria.ALL_EXTENSIONS.<fieldName>.<fieldType> : search on all extension and field name with specific type + * * <extensionName>.<fieldName>[.<fieldType>] : search on an extension and field with specific type (optional) + * * Criteria.ALL_EXTENSIONS.<fieldName>.<fieldType> : search on all extension and field name with specific type * - * <fieldType> specify search on field as NUMERIC, STRING, WIKITTY, BOOLEAN, DATE. Use Element.ElementType to specify type. + * <fieldType> specify search on field as NUMERIC, STRING, WIKITTY, BOOLEAN, DATE. Use Element.ElementType to specify type. * * Some patterns might be available depending on the restriction used. They are : * * '*' replace any number of characters diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/And.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/And.java index 108789e..dd30623 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/And.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/And.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -83,8 +83,7 @@ public class And extends Restriction implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Between.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Between.java index f6b46b1..5fe98e7 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Between.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Between.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -117,8 +117,7 @@ public class Between extends Restriction implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/BinaryOperator.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/BinaryOperator.java index da4b644..cbcabf3 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/BinaryOperator.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/BinaryOperator.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -94,8 +94,7 @@ public class BinaryOperator extends Restriction implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Contains.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Contains.java index 1de64cc..5bebf56 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Contains.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Contains.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -105,8 +105,7 @@ public class Contains extends Restriction implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/EndsWith.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/EndsWith.java index 4e42e5b..97cd492 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/EndsWith.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/EndsWith.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -47,8 +47,7 @@ public class EndsWith extends BinaryOperator implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Equals.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Equals.java index 17cea5a..ccbaed5 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Equals.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Equals.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -47,8 +47,7 @@ public class Equals extends BinaryOperator implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Greater.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Greater.java index 0cfb7b9..f72de1e 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Greater.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/Greater.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -47,8 +47,7 @@ public class Greater extends BinaryOperator implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/GreaterOrEqual.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/GreaterOrEqual.java index c4ede23..d1e7b70 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/GreaterOrEqual.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/GreaterOrEqual.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -47,8 +47,7 @@ public class GreaterOrEqual extends BinaryOperator implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/In.java b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/In.java index 707509c..bc43772 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/In.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/search/operators/In.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -107,8 +107,7 @@ public class In extends Restriction implements Serializable { /** * Equality test based attributes values * - * @param value - * Value to compare + * @param other Value to compare */ public boolean equals(Object other) { if (this == other) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyEvent.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyEvent.java index 92e8af0..5738607 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyEvent.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyEvent.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -41,10 +41,10 @@ import org.nuiton.wikitty.entities.WikittyExtension; * * Contains : * <ul> - * <li>Wikitty service as source - * <li>wikitties : wikitty added if type contains PUT_WIKITTY - * <li>ids & remove date : if type contains REMOVE_WIKITTY - * <li>extensions : extension added if type contains PUT_EXTENSION + * <li>Wikitty service as source</li> + * <li>wikitties : wikitty added if type contains PUT_WIKITTY</li> + * <li>ids & remove date : if type contains REMOVE_WIKITTY</li> + * <li>extensions : extension added if type contains PUT_EXTENSION</li> * </ul> * * @author chatellier @@ -228,10 +228,12 @@ public class WikittyEvent extends EventObject { /** * Merge this event with event passed in arguement. Merged datas are: - * <li> type - * <li> wikitties - * <li> extensions - * <li> removeDate + * <ul> + * <li> type</li> + * <li> wikitties</li> + * <li> extensions</li> + * <li> removeDate</li> + * </ul> * * @param e */ diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittySecurityUtil.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittySecurityUtil.java index 44948fd..0fc4912 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittySecurityUtil.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittySecurityUtil.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2011 CodeLutin + * Copyright (C) 2009 - 2016 CodeLutin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -36,7 +36,6 @@ 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; /** * @@ -57,8 +56,8 @@ public class WikittySecurityUtil { * Si l'option n'est pas presente dans la config retourne toujours false * (donc le token a une validite permanente) * - * @param date la date a verifier - * @return vrai si la date est depassee + * @param tokenId le token a verifier + * @return vrai si la token est depasse */ public static boolean isOutdated( ApplicationConfig config, WikittyService ws, String tokenId) { diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAccessStat.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAccessStat.java index df0aae0..73f6035 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAccessStat.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAccessStat.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -21,7 +21,6 @@ */ package org.nuiton.wikitty.services; - import java.util.ArrayList; import java.util.Collection; import java.util.Collections; @@ -57,7 +56,7 @@ public class WikittyServiceAccessStat extends WikittyServiceDelegator { /** * @param ws service that ask stockage * @param securityToken - * @param stat WikittyAccessStat wikitty + * @param stats WikittyAccessStat wikitty */ public void store(WikittyServiceAccessStat ws, String securityToken, Collection<Wikitty> stats); diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAuthorisation.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAuthorisation.java index 6292fb8..9bcaf29 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAuthorisation.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceAuthorisation.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin + * Copyright (C) 2009 - 2016 CodeLutin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -252,7 +252,6 @@ public class WikittyServiceAuthorisation extends WikittyServiceDelegator { * de ce qu'a le droit l'utilisateur courant. * * @param securityToken - * @param queries * @return */ @Override @@ -284,7 +283,6 @@ public class WikittyServiceAuthorisation extends WikittyServiceDelegator { * * @param securityToken * @param wikitties - * @return */ protected void checkStore(String securityToken, Collection<Wikitty> wikitties) { String userId = getUserId(securityToken); diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceCached.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceCached.java index edfdf55..f0b6cbf 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceCached.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceCached.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2011 CodeLutin, Benjamin Poussin, Chatellier Eric + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -65,7 +65,7 @@ public class WikittyServiceCached extends WikittyServiceDelegator { * wikitty is modified ({@link WikittyCopyOnWrite} instances) * * default set to false. To change this value, use - * {@link WikittyServiceCached#WikittyServiceCached(WikittyService, Properties)} + * {@link WikittyServiceCached#WikittyServiceCached(ApplicationConfig, WikittyService, WikittyCache)} * and set the good property. */ protected boolean allwaysRestoreCopies = false; diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceSecurity.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceSecurity.java index 2588e7a..2c51a48 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceSecurity.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceSecurity.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin + * Copyright (C) 2009 - 2016 CodeLutin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -290,7 +290,6 @@ public class WikittyServiceSecurity extends WikittyServiceDelegator { * * @param securityToken * @param wikitties - * @return */ protected void checkStore(String securityToken, Collection<Wikitty> wikitties) { String userId = getUserId(securityToken); diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceStorage.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceStorage.java index 2eb00e2..30e8549 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceStorage.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceStorage.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2012 CodeLutin, Benjamin Poussin, Chatellier Eric + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -93,7 +93,7 @@ public class WikittyServiceStorage implements WikittyService { * TODO poussin 20101027 remove it when all used WikittyServiceHelper.build * * Used by specific child - * {@link org.nuiton.wikitty.storage.solr.WikittyServiceSolr} + * {@code org.nuiton.wikitty.storage.solr.WikittyServiceSolr} */ protected WikittyServiceStorage(ApplicationConfig config) { this.config = config; @@ -171,10 +171,12 @@ public class WikittyServiceStorage implements WikittyService { /** * Check les contraintes sur les champs: - * <li> notNull: exception - * <li> pattern: exception - * <li> extensionAllowed: exception - * <li> default: changement de la valeur null par default + * <ul> + * <li> notNull: exception</li> + * <li> pattern: exception</li> + * <li> extensionAllowed: exception</li> + * <li> default: changement de la valeur null par default</li> + * </ul> * * @param wikitties */ @@ -323,9 +325,11 @@ public class WikittyServiceStorage implements WikittyService { /** * Check some constraint on extension - * <li> extension name (ex: '#--AAA' is invalide name) - * <li> extension version (ex: '-1.0' is invalide version) - * <li> extension field name (ex: '=na' is invalide name) + * <ul> + * <li> extension name (ex: '#--AAA' is invalide name)</li> + * <li> extension version (ex: '-1.0' is invalide version)</li> + * <li> extension field name (ex: '=na' is invalide name)</li> + * </ul> * * @see WikittyUtil#extensionNamePattern * @see WikittyUtil#extensionFieldNamePattern diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceTransaction.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceTransaction.java index d219967..d8c2f6f 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceTransaction.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/WikittyServiceTransaction.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -21,7 +21,6 @@ */ package org.nuiton.wikitty.services; - import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; @@ -71,7 +70,7 @@ public class WikittyServiceTransaction implements WikittyService { protected List<WikittyEvent> events; - /** if autoCommit > 0 all time events numbers element equals to this + /** if autoCommit > 0 all time events numbers element equals to this * autoCommit commit is call */ protected int autoCommit = -1; diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/services/XMPPNotifierTransporter.java b/wikitty-api/src/main/java/org/nuiton/wikitty/services/XMPPNotifierTransporter.java index a99ceda..ddef92d 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/services/XMPPNotifierTransporter.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/services/XMPPNotifierTransporter.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -22,7 +22,6 @@ package org.nuiton.wikitty.services; - import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.jivesoftware.smack.PacketListener; @@ -32,7 +31,6 @@ import org.jivesoftware.smack.packet.Packet; import org.jivesoftware.smackx.muc.DiscussionHistory; import org.jivesoftware.smackx.muc.MultiUserChat; import org.nuiton.config.ApplicationConfig; -import org.nuiton.wikitty.WikittyConfig; import org.nuiton.wikitty.WikittyConfigOption; import org.nuiton.wikitty.WikittyException; import org.nuiton.wikitty.WikittyUtil; @@ -42,8 +40,10 @@ import org.nuiton.wikitty.WikittyUtil; * xmpp avec une room * <p> * Configuration - * <li>wikitty.xmpp.server = adresse du serveur (ex: im.codelutin.com) - * <li>wikitty.xmpp.room = adresse de la room (ex: wikitty-event@im.codelutin.com) + * <ul> + * <li>wikitty.xmpp.server = adresse du serveur (ex: im.codelutin.com)</li> + * <li>wikitty.xmpp.room = adresse de la room (ex: wikitty-event@im.codelutin.com)</li> + * </ul> * * @author poussin * @version $Revision$ @@ -75,9 +75,8 @@ public class XMPPNotifierTransporter implements PacketListener, protected MultiUserChat muc; /** - * - * @param ws - * @param props + * + * @param config */ public XMPPNotifierTransporter(ApplicationConfig config) { propagateEvent = config.getOptionAsBoolean(WikittyConfigOption. @@ -100,7 +99,7 @@ public class XMPPNotifierTransporter implements PacketListener, /** * Si persistent est vrai alors il faut toujours utilise le meme user id * - * @param props + * @param config */ protected void initXMPP(ApplicationConfig config) { // on verifie qu'on a besoin reellement de faire l'init diff --git a/wikitty-api/src/main/java/org/nuiton/wikitty/storage/WikittyStorage.java b/wikitty-api/src/main/java/org/nuiton/wikitty/storage/WikittyStorage.java index 293ff42..1da0295 100644 --- a/wikitty-api/src/main/java/org/nuiton/wikitty/storage/WikittyStorage.java +++ b/wikitty-api/src/main/java/org/nuiton/wikitty/storage/WikittyStorage.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -47,7 +47,7 @@ public interface WikittyStorage { * * new version is computed as follow: * <pre> - * if version in wikitty > version in database + * if version in wikitty > version in database * newversion = version in wikitty * else * newversion = version in database + 1 diff --git a/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyClientAbstractTest.java b/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyClientAbstractTest.java index af9e1db..c6d73ea 100644 --- a/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyClientAbstractTest.java +++ b/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyClientAbstractTest.java @@ -161,7 +161,7 @@ public abstract class WikittyClientAbstractTest { * * In test case, product are books, movies structured in a media library. * - * @param wikittyClient wikitty client + * @param client wikitty client * @throws ParseException */ protected void addTestDataInClient(WikittyClient client) throws ParseException { diff --git a/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyUtilTest.java b/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyUtilTest.java index e086ae5..f1ff91d 100644 --- a/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyUtilTest.java +++ b/wikitty-api/src/test/java/org/nuiton/wikitty/WikittyUtilTest.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -295,9 +295,11 @@ public class WikittyUtilTest { * Test la difference de temps entre differente methode d'increment de version * qui est sous forme texte. * - * <li> parsing Integer + 1 (757ms / 3 millions d'appels) - * <li> switch sur les caracteres (419ms / 3 millions d'appels) - * <li> appel d'une methode d'increment (462ms / 3 millions d'appels) + * <ul> + * <li> parsing Integer + 1 (757ms / 3 millions d'appels)</li> + * <li> switch sur les caracteres (419ms / 3 millions d'appels)</li> + * <li> appel d'une methode d'increment (462ms / 3 millions d'appels)</li> + * </ul> */ @Test public void testPerfIncrementMinorRevision() { @@ -800,7 +802,7 @@ public class WikittyUtilTest { /** * getLabels : - * @return Set<String> + * @return Set<String> */ @Override public Set<String> getLabels() { diff --git a/wikitty-api/src/test/java/org/nuiton/wikitty/query/WikittyQueryTest.java b/wikitty-api/src/test/java/org/nuiton/wikitty/query/WikittyQueryTest.java index 0b1f1ab..28d0a79 100644 --- a/wikitty-api/src/test/java/org/nuiton/wikitty/query/WikittyQueryTest.java +++ b/wikitty-api/src/test/java/org/nuiton/wikitty/query/WikittyQueryTest.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: api * %% - * Copyright (C) 2012 CodeLutin, Benjamin Poussin + * Copyright (C) 2012 - 2016 CodeLutin, Benjamin Poussin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -25,7 +25,6 @@ import java.util.Date; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.junit.Assert; -import org.junit.Ignore; import org.junit.Test; import org.nuiton.wikitty.entities.Wikitty; import org.nuiton.wikitty.entities.WikittyImpl; @@ -441,8 +440,6 @@ public class WikittyQueryTest { /** * Les requettes qui commencent par un espace provoque une erreur de parsing. - * - * @throws Exception */ @Test public void testParseSpaceStart() { -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.