Author: echatellier Date: 2012-01-25 14:22:20 +0100 (Wed, 25 Jan 2012) New Revision: 1366 Url: http://nuiton.org/repositories/revision/wikitty/1366 Log: Fix doc Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/And.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Between.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ConditionValueString.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerNaryOperator.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerOperator.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerUnaryOperator.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsAll.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsOne.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Or.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalBinaryOperator.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalNaryOperator.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalOperator.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalTernaryOperator.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalUnaryOperator.java Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/AbstractCondition.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -24,10 +24,6 @@ */ package org.nuiton.wikitty.query.conditions; -import java.io.Serializable; -import java.util.HashSet; -import java.util.Set; -import org.apache.commons.lang.ClassUtils; import org.nuiton.wikitty.WikittyException; import org.nuiton.wikitty.query.WikittyQueryVisitor; import org.nuiton.wikitty.query.WikittyQueryVisitorCopy; @@ -49,13 +45,6 @@ // serialVersionUID is used for serialization. private static final long serialVersionUID = 1L; - /** - * Default constructor - */ - public AbstractCondition() { - super(); - } - @Override public Condition copy() { WikittyQueryVisitorCopy v = new WikittyQueryVisitorCopy(); @@ -67,7 +56,7 @@ * For non terminal condition this method add subCondition. * For terminal this method must return an exception * - * When you overriden this method, you must call {@link #checkAddCondition} + * When you override this method, you must call {@link #checkAddCondition} * in first * * @param c Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/And.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/And.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/And.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -27,6 +27,8 @@ import java.util.Arrays; import java.util.List; +import org.nuiton.wikitty.query.WikittyQueryMaker; + /** * And operator is used to build conjunctive restriction for request on content. * It take at least 2 args. <br> Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Between.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Between.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Between.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -48,8 +48,6 @@ * Constructor with all parameters initialized * * @param element - * @param min - * @param max */ public Between(Element element) { super(element); Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ConditionValueString.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ConditionValueString.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ConditionValueString.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -25,8 +25,6 @@ package org.nuiton.wikitty.query.conditions; import org.apache.commons.lang.ObjectUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; /** * @@ -38,9 +36,6 @@ */ public class ConditionValueString extends AbstractCondition implements ConditionValue { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(ConditionValueString.class); - private static final long serialVersionUID = 1L; protected String value; Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerNaryOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerNaryOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerNaryOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -28,8 +28,6 @@ import java.util.List; import org.apache.commons.lang.ClassUtils; import org.apache.commons.lang.ObjectUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.nuiton.wikitty.WikittyException; import org.nuiton.wikitty.query.WikittyQueryVisitor; @@ -46,8 +44,8 @@ */ public abstract class ContainerNaryOperator extends ContainerOperator { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(ContainerNaryOperator.class); + /** serialVersionUID. */ + private static final long serialVersionUID = 1L; protected List<Condition> conditions; @@ -100,8 +98,9 @@ } /** - * Return Restriction list. This list is never null, but can be empty - * @return + * Return Restriction list. This list is never null, but can be empty. + * + * @return conditions list */ public List<Condition> getConditions() { if (conditions == null) { Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -24,11 +24,9 @@ */ package org.nuiton.wikitty.query.conditions; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - /** - * Permet de marker touts les containers (autorise autre chose qu'un ConditionValue + * Permet de marker touts les containers (autorise autre chose qu'un ConditionValue). + * * @author poussin * @version $Revision$ * @@ -37,9 +35,6 @@ */ public abstract class ContainerOperator extends AbstractCondition { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(ContainerOperator.class); - private static final long serialVersionUID = 1L; } Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerUnaryOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerUnaryOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainerUnaryOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -26,8 +26,6 @@ import org.apache.commons.lang.ClassUtils; import org.apache.commons.lang.ObjectUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.nuiton.wikitty.WikittyException; import org.nuiton.wikitty.query.WikittyQueryVisitor; @@ -43,8 +41,8 @@ */ public abstract class ContainerUnaryOperator extends ContainerOperator { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(ContainerUnaryOperator.class); + /** serialVersionUID. */ + private static final long serialVersionUID = 1L; protected Condition subCondition; Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsAll.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsAll.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsAll.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -57,7 +57,7 @@ * Constructor with all parameters initialized * * @param element - * @param value + * @param values */ public ContainsAll(Element element, Collection<ConditionValue> values) { super(element, values); @@ -66,6 +66,4 @@ public ContainsAll(Element element) { super(element); } - - -} \ No newline at end of file +} Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsOne.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsOne.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/ContainsOne.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -48,7 +48,7 @@ * Constructor with all parameters initialized * * @param element - * @param value + * @param values */ public ContainsOne(Element element, Collection<ConditionValue> values) { super(element, values); @@ -57,5 +57,4 @@ public ContainsOne(Element element) { super(element); } - -} \ No newline at end of file +} Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Equals.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -61,5 +61,4 @@ public Equals(Element element, ConditionValue value) { super(element, value); } - -} \ No newline at end of file +} Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/NotEquals.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -25,6 +25,7 @@ package org.nuiton.wikitty.query.conditions; import org.nuiton.wikitty.entities.Element; +import org.nuiton.wikitty.query.WikittyQueryMaker; /** * NotEquals operator is used to build restriction containing "element != value" Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Or.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Or.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/Or.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -27,6 +27,8 @@ import java.util.Arrays; import java.util.List; +import org.nuiton.wikitty.query.WikittyQueryMaker; + /** * Or operator is used to build disjunctive restriction for request on content. * It take at least 2 args. <br> @@ -56,7 +58,7 @@ /** * Constructor with all parameters initialized * - * @param restrictions + * @param conditions */ public Or(List<Condition> conditions) { super(conditions); Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalBinaryOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalBinaryOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalBinaryOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -54,7 +54,6 @@ * Constructor with all parameters initialized * * @param element - * @param value */ public TerminalBinaryOperator(Element element) { this(element, (ConditionValue)null); Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalNaryOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalNaryOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalNaryOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -30,8 +30,6 @@ import java.util.List; import org.apache.commons.lang.ClassUtils; import org.apache.commons.lang.ObjectUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.nuiton.wikitty.WikittyException; import org.nuiton.wikitty.query.WikittyQueryVisitor; @@ -45,9 +43,6 @@ */ public class TerminalNaryOperator extends TerminalOperator { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(TerminalNaryOperator.class); - // serialVersionUID is used for serialization. private static final long serialVersionUID = 1L; @@ -58,7 +53,6 @@ * Constructor with all parameters initialized * * @param element - * @param value */ public TerminalNaryOperator(Element element) { this(element, (Collection<ConditionValue>)null); @@ -68,7 +62,7 @@ * Constructor with all parameters initialized * * @param element - * @param value value is internaly copied to prevent external modification + * @param values value is internaly copied to prevent external modification */ public TerminalNaryOperator(Element element, Collection<ConditionValue> values) { this.element = element; Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -24,12 +24,8 @@ */ package org.nuiton.wikitty.query.conditions; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.nuiton.wikitty.WikittyException; - /** - * Class mere de tous les operateurs terminaux sans parametre + * Class mere de tous les operateurs terminaux sans parametres * (ex: True, False) * * @author poussin @@ -41,8 +37,8 @@ */ public abstract class TerminalOperator extends AbstractCondition { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(TerminalOperator.class); + /** serialVersionUID. */ + private static final long serialVersionUID = 1L; public TerminalOperator() { } Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalTernaryOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalTernaryOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalTernaryOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -27,8 +27,6 @@ import org.nuiton.wikitty.entities.Element; import org.apache.commons.lang.ClassUtils; import org.apache.commons.lang.ObjectUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.nuiton.wikitty.WikittyException; import org.nuiton.wikitty.query.WikittyQueryVisitor; @@ -44,9 +42,6 @@ */ public abstract class TerminalTernaryOperator extends TerminalOperator { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(TerminalTernaryOperator.class); - private static final long serialVersionUID = 1L; protected Element element; @@ -128,6 +123,4 @@ && ObjectUtils.equals(this.getMax(), op.getMax()); return result; } - - } Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalUnaryOperator.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalUnaryOperator.java 2012-01-25 13:14:06 UTC (rev 1365) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/query/conditions/TerminalUnaryOperator.java 2012-01-25 13:22:20 UTC (rev 1366) @@ -26,8 +26,6 @@ import org.nuiton.wikitty.entities.Element; import org.apache.commons.lang.ObjectUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; /** * @@ -39,9 +37,6 @@ */ public class TerminalUnaryOperator extends TerminalOperator { - /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(TerminalUnaryOperator.class); - // serialVersionUID is used for serialization. private static final long serialVersionUID = 1L; @@ -50,8 +45,7 @@ /** * Constructor with all parameters initialized * - * @param element - * @param value value is internaly copied to prevent external modification + * @param element value is internaly copied to prevent external modification */ public TerminalUnaryOperator(Element element) { this.element = element;