Author: ssmiweve
Date: 2009-01-20 11:55:22 +0100 (Tue, 20 Jan 2009)
New Revision: 7151
Modified:
branches/2.18/search-command-control-spi/src/main/java/no/sesat/search/mode/command/querybuilder/AbstractQueryBuilder.java
Log:
doc
Modified:
branches/2.18/search-command-control-spi/src/main/java/no/sesat/search/mode/command/querybuilder/AbstractQueryBuilder.java
===================================================================
---
branches/2.18/search-command-control-spi/src/main/java/no/sesat/search/mode/command/querybuilder/AbstractQueryBuilder.java
2009-01-19 14:53:44 UTC (rev 7150)
+++
branches/2.18/search-command-control-spi/src/main/java/no/sesat/search/mode/command/querybuilder/AbstractQueryBuilder.java
2009-01-20 10:55:22 UTC (rev 7151)
@@ -29,6 +29,20 @@
/** Abstract QueryBuilder providing basic support for mantaining context and
stringBuilder fields (and related methods).
*
+ * <br/><br/>
+ *
+ * Any instance will have getQuery(..) called multiple times.
+ * It is therefore paramount that inside this method state fields are reset
before the visitor is visited. <br/>
+ * For example a subclass will override getQuery(..) such:
+ * <pre>
+ * @Override
+ * public String getQueryString() {
+ * // myVariable needs to be reset before every visit.
+ * myVariable = 0;
+ * return super.getQueryString();
+ * }
+ * </pre>
+ *
* @version $Id$
*/
public abstract class AbstractQueryBuilder extends AbstractReflectionVisitor
implements QueryBuilder {
_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits
