ModelAdapter now manages special iteration variable

Author: DJCordhose

Releasenotes.md

@@ -150,4 +150,6 @@ Release 3.2.0
 * Now building for JDK 1.7
 * Transformation of model value to iterable for for each now done in ModelAdaptor
 * ModelAdapter can be configured to treat everything as a list when looping over it, prevents map to be iterated over as entries
+* ModelAdapter now manages special iterator alias, DefaultModelAdapter provides "_it" for backward compatibility 
+
 

src/com/floreysoft/jmte/DefaultModelAdaptor.java

@@ -30,6 +30,8 @@
  */
 public class DefaultModelAdaptor implements ModelAdaptor {
 
+    private static final String DEFAULT_SPECIAL_ITERATOR_VARIABLE = "_it";
+
     public enum LoopMode {
         DEFAULT,
         /**
@@ -38,15 +40,21 @@ public enum LoopMode {
         LIST
     }
 
-    protected Map<Class<?>, Map<String, Member>> cache = new HashMap<Class<?>, Map<String, Member>>();
-    private LoopMode loopMode;
+    protected final Map<Class<?>, Map<String, Member>> cache = new HashMap<Class<?>, Map<String, Member>>();
+    private final LoopMode loopMode;
+    private final String specialIteratorVariable;
 
     public DefaultModelAdaptor() {
         this(LoopMode.DEFAULT);
     }
 
     public DefaultModelAdaptor(LoopMode loopMode) {
+        this(loopMode, DEFAULT_SPECIAL_ITERATOR_VARIABLE);
+    }
+
+    public DefaultModelAdaptor(LoopMode loopMode, String specialIteratorVariable) {
         this.loopMode = loopMode;
+        this.specialIteratorVariable = specialIteratorVariable;
     }
 
     public Object getValue(Map<String, Object> model, String expression) {
@@ -98,6 +106,11 @@ public Iterable<Object> getIterable(Object value) {
         return iterable;
     }
 
+    @Override
+    public String getSpecialIteratorVariable() {
+        return specialIteratorVariable;
+    }
+
     protected Object traverse(List<String> segments, Map<String, Object> model,
                               ErrorHandler errorHandler, Token token) {
         if (segments.size() == 0) {

src/com/floreysoft/jmte/Engine.java

@@ -246,6 +246,11 @@ public Iterable<Object> getIterable(Object value) {
                 return null;
             }
 
+            @Override
+            public String getSpecialIteratorVariable() {
+                return null;
+            }
+
         };
 
 		String output = transformInternal(pattern, null, model, modelAdaptor, null);

src/com/floreysoft/jmte/ModelAdaptor.java

@@ -34,4 +34,12 @@ public Object getValue(TemplateContext context, Token token,
      */
     public Iterable<Object> getIterable(Object value);
 
+    /**
+     * Gets the name of the special iterator variable which will be used as an alternative
+     * variable name of the iterator in a foreach loop. E.g. something like <em>it</em>.
+     *
+     * @return name of the special iterator variable
+     */
+    public String getSpecialIteratorVariable();
+
 }

src/com/floreysoft/jmte/template/AbstractTemplate.java

@@ -11,7 +11,6 @@
 
 public abstract class AbstractTemplate implements Template {
 
-	public static final String SPECIAL_ITERATOR_VARIABLE = "_it";
 	public static final String ODD_PREFIX = "odd_";
 	public static final String EVEN_PREFIX = "even_";
 	public static final String LAST_PREFIX = "last_";
@@ -25,12 +24,11 @@ public abstract class AbstractTemplate implements Template {
 
 	protected void addSpecialVariables(ForEachToken feToken,
 			Map<String, Object> model) {
-		String suffix = feToken.getVarName();
-		addSpecialVariables(feToken, model, suffix);
-		
+		addSpecialVariables(feToken, model, feToken.getVarName());
 		// special _it variable as an alias for run variable in inner loop
-		model.put(SPECIAL_ITERATOR_VARIABLE, model.get(feToken.getVarName()));
-		addSpecialVariables(feToken, model, SPECIAL_ITERATOR_VARIABLE);
+        final String specialIteratorVariable = engine.getModelAdaptor().getSpecialIteratorVariable();
+		model.put(specialIteratorVariable, model.get(feToken.getVarName()));
+		addSpecialVariables(feToken, model, specialIteratorVariable);
 	}
 
 	private void addSpecialVariables(ForEachToken feToken, Map<String, Object> model, String suffix) {