Improved: Rewrite EntityConditionVisitor interface to respect visitor Pattern

(OFBIZ-10593)

Remove visit methods from current EntityConditionBase type hierarchy.
Add or rewrite accept method in EntityCondition type hierachy.
Add documentation in EntityConditionVisitor, introducing implementation examples.
Add junit test validating documented examples.
Thanks to Mathieu Lirzin for your contribution, and Jacques for the review.


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1843780 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gil Portenseigne
2018-10-13 19:50:27 +00:00
parent c440f65a99
commit 699bbb9cf9
18 changed files with 274 additions and 127 deletions
@@ -77,12 +77,6 @@ public abstract class EntityComparisonOperator<L, R> extends EntityOperator<L, R
}
}
@Override
public void visit(EntityConditionVisitor visitor, L lhs, R rhs) {
visitor.accept(lhs);
visitor.accept(rhs);
}
@Override
public void addSqlValue(StringBuilder sql, ModelEntity entity, List<EntityConditionParam> entityConditionParams, boolean compat, L lhs, R rhs, Datasource datasourceInfo) {
@@ -109,9 +109,12 @@ public abstract class EntityCondition extends EntityConditionBase implements IsE
return makeWhereString(null, new ArrayList<EntityConditionParam>(), null);
}
public void accept(EntityConditionVisitor visitor) {
throw new IllegalArgumentException(getClass().getName() + ".accept not implemented");
}
/**
* Applies a visitor to this condition.
*
* @param visitor the visitor to be applied
*/
abstract public void accept(EntityConditionVisitor visitor);
abstract public String makeWhereString(ModelEntity modelEntity, List<EntityConditionParam> entityConditionParams, Datasource datasourceInfo);
@@ -132,8 +135,4 @@ public abstract class EntityCondition extends EntityConditionBase implements IsE
abstract public boolean mapMatches(Delegator delegator, Map<String, ? extends Object> map);
abstract public EntityCondition freeze();
public void visit(EntityConditionVisitor visitor) {
throw new IllegalArgumentException(getClass().getName() + ".visit not implemented");
}
}
@@ -84,6 +84,10 @@ public class EntityConditionBuilder extends BuilderSupport {
return condition.equals(obj);
}
@Override
public void accept(EntityConditionVisitor visitor) {
throw new IllegalArgumentException(getClass().getName() + ".accept not implemented");
}
}
@Override
@@ -80,8 +80,8 @@ public abstract class EntityConditionFunction extends EntityCondition {
}
@Override
public void visit(EntityConditionVisitor visitor) {
visitor.acceptEntityConditionFunction(this, condition);
public void accept(EntityConditionVisitor visitor) {
visitor.visit(this);
}
@Override
@@ -43,6 +43,6 @@ public class EntityConditionList<T extends EntityCondition> extends EntityCondit
@Override
public void accept(EntityConditionVisitor visitor) {
visitor.acceptEntityConditionList(this);
visitor.visit(this);
}
}
@@ -60,11 +60,6 @@ public abstract class EntityConditionListBase<T extends EntityCondition> extends
return this.conditionList.iterator();
}
@Override
public void visit(EntityConditionVisitor visitor) {
visitor.acceptEntityJoinOperator(operator, conditionList);
}
@Override
public boolean isEmpty() {
return operator.isEmpty(conditionList);
@@ -146,11 +146,4 @@ public class EntityConditionSubSelect extends EntityConditionValue {
public void validateSql(ModelEntity modelEntity) throws GenericModelException {
// do nothing for now
}
@Override
public void visit(EntityConditionVisitor visitor) {
if (whereCond != null) {
whereCond.visit(visitor);
}
}
}
@@ -44,11 +44,6 @@ public abstract class EntityConditionValue extends EntityConditionBase {
this.value = value;
}
@Override
public void accept(EntityConditionVisitor visitor) {
visitor.acceptEntityConditionValue(this);
}
@Override
public void addSqlValue(StringBuilder sql, Map<String, String> tableAliases, ModelEntity modelEntity, List<EntityConditionParam> entityConditionParams, boolean includeTableNamePrefix, Datasource datasourceinfo) {
sql.append(value);
@@ -77,11 +72,6 @@ public abstract class EntityConditionValue extends EntityConditionBase {
@Override
public void validateSql(org.apache.ofbiz.entity.model.ModelEntity modelEntity) {
}
@Override
public void visit(EntityConditionVisitor visitor) {
visitor.acceptObject(value);
}
}
public abstract ModelField getModelField(ModelEntity modelEntity);
@@ -109,12 +99,6 @@ public abstract class EntityConditionValue extends EntityConditionBase {
public abstract EntityConditionValue freeze();
public abstract void visit(EntityConditionVisitor visitor);
public void accept(EntityConditionVisitor visitor) {
throw new IllegalArgumentException("accept not implemented");
}
public void toString(StringBuilder sb) {
addSqlValue(sb, null, new ArrayList<EntityConditionParam>(), false, null);
}
@@ -1,4 +1,4 @@
/*******************************************************************************
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -15,40 +15,139 @@
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*******************************************************************************/
*/
package org.apache.ofbiz.entity.condition;
import java.util.List;
// Keep the tests from EntityConditionVisitorTests in sync with the code examples.
/**
* <p>Represents the conditions to be used to constrain a query.</p>
* <p>An EntityCondition can represent various type of constraints, including:</p>
* <ul>
* <li>EntityConditionList: a list of EntityConditions, combined with the operator specified
* <li>EntityExpr: for simple expressions or expressions that combine EntityConditions
* <li>EntityFieldMap: a map of fields where the field (key) equals the value, combined with the operator specified
* </ul>
* These can be used in various combinations using the EntityConditionList and EntityExpr objects.
* A visitor of entity conditions in the style of the visitor design pattern.
* <p>
* Classes implementing this interface can extend the dynamically dispatched
* behavior associated with {@link EntityCondition} without augmenting its
* interface. Those classes are meant be passed to the
* {@link EntityCondition#accept(EntityConditionVisitor) accept} method which
* calls the corresponding method in the visitor.
* <p>
* <b>Usage Examples:</b>
* Here is a dummy example that should print <i>EntityExpr\n</i> to
* the standard output.
* <pre>{@code
* EntityExpr expr;
* expr.accept(new EntityConditionVisitor() {
* public void visit(EntityConditionFunction func) {
* system.out.println("EntityConditionFunction");
* }
*
* public <T extends EntityCondition> void visit(EntityConditionList<T> l) {
* system.out.println("EntityConditionList");
* }
*
* public void visit(EntityFieldMap m) {
* system.out.println("EntityFieldMap");
* }
*
* public void visit(EntityDateFilterCondition df) {
* system.out.println("EntityDateFilterCondition");
* }
*
* public void visit(EntityExpr expr) {
* system.out.println("EntityExpr");
* }
*
* public void visit(EntityWhereString ws) {
* system.out.println("EntityWhereString");
* }
* });
* }</pre>
* <p>
* Here is a more complex example asserting the presence of a raw string condition
* even when it is embedded inside another one.
* <pre>{@code
* class ContainsRawCondition implements EntityConditionVisitor {
* public boolean hasRawCondition = false;
*
* public void visit(EntityConditionFunction func) {}
* public void visit(EntityFieldMap m) {}
* public void visit(EntityDateFilterCondition df) {}
*
* public <T extends EntityCondition> void visit(EntityConditionList<T> l) {
* Iterator<T> it = l.getConditionIterator();
* while (it.hasNext()) {
* it.next().accept(this);
* }
* }
*
* public void visit(EntityExpr expr) {
* Object lhs = expr.getLhs();
* Object rhs = expr.getRhs();
* if (lhs instanceof EntityCondition) {
* ((EntityCondition) lhs).accept(this);
* }
* if (rhs instanceof EntityCondition) {
* ((EntityCondition) rhs).accept(this);
* }
* }
*
* public void visit(EntityWhereString ws) {
* hasRawCondition = true;
* }
* }
*
* EntityCondition ec =
* EntityCondition.makeCondition(EntityCondition.makeConditionWhere("foo=bar"));
* EntityConditionVisitor visitor = new ContainsRawCondition();
* ec.accept(visitor);
* assert visitor.hasRawCondition;
* }</pre>
*
* @see EntityCondition
*/
public interface EntityConditionVisitor {
<T> void visit(T obj);
<T> void accept(T obj);
void acceptObject(Object obj);
void acceptEntityCondition(EntityCondition condition);
<T extends EntityCondition> void acceptEntityJoinOperator(EntityJoinOperator op, List<T> conditions);
<L,R,T> void acceptEntityOperator(EntityOperator<L, R, T> op, L lhs, R rhs);
<L,R> void acceptEntityComparisonOperator(EntityComparisonOperator<L, R> op, L lhs, R rhs);
void acceptEntityConditionValue(EntityConditionValue value);
void acceptEntityFieldValue(EntityFieldValue value);
/**
* Visits an entity condition function.
*
* @param func the visited class
* @see EntityConditionFunction
*/
void visit(EntityConditionFunction func);
void acceptEntityExpr(EntityExpr expr);
<T extends EntityCondition> void acceptEntityConditionList(EntityConditionList<T> list);
void acceptEntityFieldMap(EntityFieldMap fieldMap);
void acceptEntityConditionFunction(EntityConditionFunction func, EntityCondition nested);
<T extends Comparable<?>> void acceptEntityFunction(EntityFunction<T> func);
void acceptEntityWhereString(EntityWhereString condition);
/**
* Visits a list of entity conditions.
*
* @param l the visited class
* @see EntityConditionList
*/
<T extends EntityCondition> void visit(EntityConditionList<T> l);
void acceptEntityDateFilterCondition(EntityDateFilterCondition condition);
/**
* Visits a map of entity fields.
*
* @param m the visited class
* @see EntityFieldMap
*/
void visit(EntityFieldMap m);
/**
* Visits a date filter condition.
*
* @param df the visited class
* @see EntityDateFilterCondition
*/
void visit(EntityDateFilterCondition df);
/**
* Visits an entity expression.
*
* @param expr the visited class
* @see EntityExpr
*/
void visit(EntityExpr expr);
/**
* Visits a raw string condition.
*
* @param ws the visited class
* @see EntityWhereString
*/
void visit(EntityWhereString ws);
}
@@ -81,14 +81,9 @@ public final class EntityDateFilterCondition extends EntityCondition {
return hashCode(fromDateName) ^ hashCode(thruDateName);
}
@Override
public void visit(EntityConditionVisitor visitor) {
visitor.acceptEntityDateFilterCondition(this);
}
@Override
public void accept(EntityConditionVisitor visitor) {
visitor.acceptEntityDateFilterCondition(this);
visitor.visit(this);
}
@Override
@@ -148,14 +148,9 @@ public final class EntityExpr extends EntityCondition {
return operator.freeze(lhs, rhs);
}
@Override
public void visit(EntityConditionVisitor visitor) {
visitor.acceptEntityOperator(operator, lhs, rhs);
}
@Override
public void accept(EntityConditionVisitor visitor) {
visitor.acceptEntityExpr(this);
visitor.visit(this);
}
public void checkRhsType(ModelEntity modelEntity, Delegator delegator) {
@@ -74,6 +74,6 @@ public final class EntityFieldMap extends EntityConditionListBase<EntityExpr> {
@Override
public void accept(EntityConditionVisitor visitor) {
visitor.acceptEntityFieldMap(this);
visitor.visit(this);
}
}
@@ -198,16 +198,6 @@ public class EntityFieldValue extends EntityConditionValue {
return map.get(fieldName);
}
@Override
public void visit(EntityConditionVisitor visitor) {
visitor.acceptEntityFieldValue(this);
}
@Override
public void accept(EntityConditionVisitor visitor) {
visitor.acceptEntityFieldValue(this);
}
@Override
public EntityConditionValue freeze() {
return this;
@@ -200,20 +200,6 @@ public abstract class EntityFunction<T extends Comparable<?>> extends EntityCond
sql.append(')');
}
@Override
public void visit(EntityConditionVisitor visitor) {
if (nested != null) {
visitor.acceptEntityConditionValue(nested);
} else {
visitor.acceptObject(value);
}
}
@Override
public void accept(EntityConditionVisitor visitor) {
visitor.acceptEntityFunction(this);
}
@Override
public ModelField getModelField(ModelEntity modelEntity) {
if (nested != null) {
@@ -96,20 +96,6 @@ public class EntityJoinOperator extends EntityOperator<EntityCondition, EntityCo
return EntityCondition.makeCondition(newList, this);
}
public void visit(EntityConditionVisitor visitor, List<? extends EntityCondition> conditionList) {
if (UtilValidate.isNotEmpty(conditionList)) {
for (EntityCondition condition: conditionList) {
visitor.visit(condition);
}
}
}
@Override
public void visit(EntityConditionVisitor visitor, EntityCondition lhs, EntityCondition rhs) {
lhs.visit(visitor);
visitor.visit(rhs);
}
public Boolean eval(GenericEntity entity, EntityCondition lhs, EntityCondition rhs) {
return entityMatches(entity, lhs, rhs) ? Boolean.TRUE : Boolean.FALSE;
}
@@ -296,7 +296,6 @@ public abstract class EntityOperator<L, R, T> extends EntityConditionBase {
public abstract void addSqlValue(StringBuilder sql, ModelEntity entity, List<EntityConditionParam> entityConditionParams, boolean compat, L lhs, R rhs, Datasource datasourceInfo);
public abstract EntityCondition freeze(L lhs, R rhs);
public abstract void visit(EntityConditionVisitor visitor, L lhs, R rhs);
public static final Comparable<?> WILDCARD = new Comparable<Object>() {
public int compareTo(Object obj) {
@@ -82,8 +82,8 @@ public final class EntityWhereString extends EntityCondition {
}
@Override
public void visit(EntityConditionVisitor visitor) {
visitor.acceptEntityWhereString(this);
public void accept(EntityConditionVisitor visitor) {
visitor.visit(this);
}
@Override