litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

NIHVIVO-1564 Minor refactoring. Add DumpAll directive.

Browse source
This commit is contained in:
ryounes 2011-04-18 22:41:35 +00:00
parent 15ed59d494
commit f7dbdc4889
3 changed files with 124 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
webapp/src/freemarker/ext/dump/BaseDumpDirective.java
View file

@ -112,78 +112,82 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
} }
} }
protected Map<String, Object> getTemplateVariableDump(String varName, Environment env)
throws TemplateModelException {
protected Map<String, Object> getTemplateVariableData(String varName, Environment env) TemplateHashModel dataModel = env.getDataModel();
TemplateModel model = dataModel.get(varName);
return getTemplateVariableDump(varName, model);
}
protected Map<String, Object> getTemplateVariableDump(String varName, TemplateModel model)
throws TemplateModelException { throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.NAME.toString(), varName); map.put(Key.NAME.toString(), varName);
TemplateHashModel dataModel = env.getDataModel();
TemplateModel model = dataModel.get(varName);
// Don't return null if model == null. We still want to send the map to the template. // Don't return null if model == null. We still want to send the map to the template.
if (model != null) { if (model != null) {
// TemplateMethodModel and TemplateDirectiveModel objects can only be // TemplateMethodModel and TemplateDirectiveModel objects can only be
// included in the data model at the top level. // included in the data model at the top level.
if (model instanceof TemplateMethodModel) { if (model instanceof TemplateMethodModel) {
map.putAll( getTemplateModelData( ( TemplateMethodModel)model, varName ) ); map.putAll( getTemplateModelDump( ( TemplateMethodModel)model, varName ) );
} else if (model instanceof TemplateDirectiveModel) { } else if (model instanceof TemplateDirectiveModel) {
map.putAll( getTemplateModelData( ( TemplateDirectiveModel)model, varName ) ); map.putAll( getTemplateModelDump( ( TemplateDirectiveModel)model, varName ) );
} else { } else {
map.putAll(getData(model)); map.putAll(getDump(model));
} }
} }
return map; return map;
} }
private Map<String, Object> getData(TemplateModel model) throws TemplateModelException { private Map<String, Object> getDump(TemplateModel model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
// Don't return null if model == null. We still want to send the map to the template. // Don't return null if model == null. We still want to send the map to the template.
if (model != null) { if (model != null) {
if ( model instanceof TemplateSequenceModel ) { if ( model instanceof TemplateSequenceModel ) {
map.putAll( getTemplateModelData( ( TemplateSequenceModel)model ) ); map.putAll( getTemplateModelDump( ( TemplateSequenceModel)model ) );
} else if ( model instanceof TemplateNumberModel ) { } else if ( model instanceof TemplateNumberModel ) {
map.putAll( getTemplateModelData( (TemplateNumberModel)model ) ); map.putAll( getTemplateModelDump( (TemplateNumberModel)model ) );
} else if ( model instanceof TemplateBooleanModel ) { } else if ( model instanceof TemplateBooleanModel ) {
map.putAll( getTemplateModelData( (TemplateBooleanModel)model ) ); map.putAll( getTemplateModelDump( (TemplateBooleanModel)model ) );
} else if ( model instanceof TemplateDateModel ) { } else if ( model instanceof TemplateDateModel ) {
map.putAll( getTemplateModelData( (TemplateDateModel)model ) ); map.putAll( getTemplateModelDump( (TemplateDateModel)model ) );
} else if ( model instanceof TemplateCollectionModel ) { } else if ( model instanceof TemplateCollectionModel ) {
map.putAll( getTemplateModelData( ( TemplateCollectionModel)model ) ); map.putAll( getTemplateModelDump( ( TemplateCollectionModel)model ) );
} else if ( model instanceof StringModel ) { } else if ( model instanceof StringModel ) {
Object unwrappedModel = DeepUnwrap.permissiveUnwrap(model); Object unwrappedModel = DeepUnwrap.permissiveUnwrap(model);
if (unwrappedModel instanceof String) { if (unwrappedModel instanceof String) {
map.putAll( getTemplateModelData( (TemplateScalarModel)model ) ); map.putAll( getTemplateModelDump( (TemplateScalarModel)model ) );
} else { } else {
map.putAll( getTemplateModelData( ( TemplateHashModelEx)model ) ); map.putAll( getTemplateModelDump( ( TemplateHashModelEx)model ) );
} }
} else if ( model instanceof TemplateScalarModel ) { } else if ( model instanceof TemplateScalarModel ) {
map.putAll( getTemplateModelData( (TemplateScalarModel)model ) ); map.putAll( getTemplateModelDump( (TemplateScalarModel)model ) );
} else if ( model instanceof TemplateHashModelEx ) { } else if ( model instanceof TemplateHashModelEx ) {
map.putAll( getTemplateModelData( ( TemplateHashModelEx)model ) ); map.putAll( getTemplateModelDump( ( TemplateHashModelEx)model ) );
} else if (model instanceof TemplateHashModel ) { } else if (model instanceof TemplateHashModel ) {
map.putAll( getTemplateModelData( ( TemplateHashModel)model ) ); map.putAll( getTemplateModelDump( ( TemplateHashModel)model ) );
// Nodes and transforms not included here // Nodes and transforms not included here
} else { } else {
map.putAll( getTemplateModelData( (TemplateModel)model ) ); map.putAll( getTemplateModelDump( (TemplateModel)model ) );
} }
} else { } else {
map.put(Key.VALUE.toString(), "null"); map.put(Key.VALUE.toString(), "null");
@ -192,28 +196,28 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateScalarModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateScalarModel model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.STRING); map.put(Key.TYPE.toString(), Type.STRING);
map.put(Key.VALUE.toString(), model.getAsString()); map.put(Key.VALUE.toString(), model.getAsString());
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateBooleanModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateBooleanModel model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.BOOLEAN); map.put(Key.TYPE.toString(), Type.BOOLEAN);
map.put(Key.VALUE.toString(), model.getAsBoolean()); map.put(Key.VALUE.toString(), model.getAsBoolean());
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateNumberModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateNumberModel model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.NUMBER); map.put(Key.TYPE.toString(), Type.NUMBER);
map.put(Key.VALUE.toString(), model.getAsNumber()); map.put(Key.VALUE.toString(), model.getAsNumber());
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateDateModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateDateModel model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.DATE); map.put(Key.TYPE.toString(), Type.DATE);
int dateType = model.getDateType(); int dateType = model.getDateType();
@ -238,7 +242,7 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateHashModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateHashModel model) throws TemplateModelException {
// The data model is a hash; when else do we get here? // The data model is a hash; when else do we get here?
log.debug("Dumping model " + model); log.debug("Dumping model " + model);
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
@ -247,32 +251,32 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateSequenceModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateSequenceModel model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.SEQUENCE); map.put(Key.TYPE.toString(), Type.SEQUENCE);
int itemCount = model.size(); int itemCount = model.size();
List<Map<String, Object>> items = new ArrayList<Map<String, Object>>(itemCount); List<Map<String, Object>> items = new ArrayList<Map<String, Object>>(itemCount);
for ( int i = 0; i < itemCount; i++ ) { for ( int i = 0; i < itemCount; i++ ) {
TemplateModel item = model.get(i); TemplateModel item = model.get(i);
items.add(getData(item)); items.add(getDump(item));
} }
map.put(Key.VALUE.toString(), items); map.put(Key.VALUE.toString(), items);
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateHashModelEx model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateHashModelEx model) throws TemplateModelException {
Object unwrappedModel = DeepUnwrap.permissiveUnwrap(model); Object unwrappedModel = DeepUnwrap.permissiveUnwrap(model);
// This seems to be the most reliable way of distinguishing a wrapped map from a wrapped object. // This seems to be the most reliable way of distinguishing a wrapped map from a wrapped object.
// A map may be wrapped as a SimpleHash, and an object may be wrapped as a StringModel, but they could // A map may be wrapped as a SimpleHash, and an object may be wrapped as a StringModel, but they could
// be wrapped as other types as well. // be wrapped as other types as well.
if ( unwrappedModel instanceof Map ) { if ( unwrappedModel instanceof Map ) {
return getMapData(model); return getMapDump(model);
} }
// Java objects are wrapped as TemplateHashModelEx-s. // Java objects are wrapped as TemplateHashModelEx-s.
return getObjectData(model, unwrappedModel); return getObjectDump(model, unwrappedModel);
} }
private Map<String, Object> getMapData(TemplateHashModelEx model) throws TemplateModelException { private Map<String, Object> getMapDump(TemplateHashModelEx model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.HASH_EX); map.put(Key.TYPE.toString(), Type.HASH_EX);
SortedMap<String, Object> items = new TreeMap<String, Object>(); SortedMap<String, Object> items = new TreeMap<String, Object>();
@ -281,13 +285,13 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
while (iModel.hasNext()) { while (iModel.hasNext()) {
String key = iModel.next().toString(); String key = iModel.next().toString();
TemplateModel value = model.get(key); TemplateModel value = model.get(key);
items.put(key, getData(value)); items.put(key, getDump(value));
} }
map.put(Key.VALUE.toString(), items); map.put(Key.VALUE.toString(), items);
return map; return map;
} }
private Map<String, Object> getObjectData(TemplateHashModelEx model, Object object) throws TemplateModelException { private Map<String, Object> getObjectDump(TemplateHashModelEx model, Object object) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), object.getClass().getName()); map.put(Key.TYPE.toString(), object.getClass().getName());
@ -344,7 +348,7 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
// The method is available as a property // The method is available as a property
if (keySet.contains(propertyName)) { if (keySet.contains(propertyName)) {
TemplateModel value = model.get(propertyName); TemplateModel value = model.get(propertyName);
properties.put(propertyName, getData(value)); properties.put(propertyName, getDump(value));
continue; continue;
} }
} }
@ -391,27 +395,27 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
return StringUtils.uncapitalize(keyName); return StringUtils.uncapitalize(keyName);
} }
private Map<String, Object> getTemplateModelData(TemplateCollectionModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateCollectionModel model) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.COLLECTION); map.put(Key.TYPE.toString(), Type.COLLECTION);
List<Map<String, Object>> items = new ArrayList<Map<String, Object>>(); List<Map<String, Object>> items = new ArrayList<Map<String, Object>>();
TemplateModelIterator iModel = model.iterator(); TemplateModelIterator iModel = model.iterator();
while (iModel.hasNext()) { while (iModel.hasNext()) {
TemplateModel m = iModel.next(); TemplateModel m = iModel.next();
items.add(getData(m)); items.add(getDump(m));
} }
map.put(Key.VALUE.toString(), items); map.put(Key.VALUE.toString(), items);
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateMethodModel model, String varName) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateMethodModel model, String varName) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.METHOD); map.put(Key.TYPE.toString(), Type.METHOD);
map.put("help", getHelp(model, varName)); map.put("help", getHelp(model, varName));
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateDirectiveModel model, String varName) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateDirectiveModel model, String varName) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put(Key.TYPE.toString(), Type.DIRECTIVE); map.put(Key.TYPE.toString(), Type.DIRECTIVE);
map.put("help", getHelp(model, varName)); map.put("help", getHelp(model, varName));
@ -439,7 +443,7 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelDump(TemplateModel model) throws TemplateModelException {
// One of the above cases should have applied. Track whether this actually occurs. // One of the above cases should have applied. Track whether this actually occurs.
log.debug("Found model with no known type"); log.debug("Found model with no known type");
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
@ -449,7 +453,7 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
return map; return map;
} }
protected void dump(String templateName, Map<String, Object> map, String modelName, Environment env) protected void dump(String templateName, Map<String, Object> map, Environment env)
throws TemplateException, IOException { throws TemplateException, IOException {
Template template = env.getConfiguration().getTemplate(templateName); Template template = env.getConfiguration().getTemplate(templateName);

76
webapp/src/freemarker/ext/dump/DumpAllDirective.java Normal file
View file

@ -0,0 +1,76 @@
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
package freemarker.ext.dump;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import freemarker.core.Environment;
import freemarker.template.TemplateDirectiveBody;
import freemarker.template.TemplateException;
import freemarker.template.TemplateHashModel;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelException;
import freemarker.template.utility.DeepUnwrap;
public class DumpAllDirective extends BaseDumpDirective {
@SuppressWarnings("unused")
private static final Log log = LogFactory.getLog(DumpDirective.class);
@SuppressWarnings("rawtypes")
@Override
public void execute(Environment env, Map params, TemplateModel[] loopVars,
TemplateDirectiveBody body) throws TemplateException, IOException {
if (params.size() != 0) {
throw new TemplateModelException(
"The dumpAll directive doesn't allow parameters.");
}
if (loopVars.length != 0) {
throw new TemplateModelException(
"The dump directive doesn't allow loop variables.");
}
if (body != null) {
throw new TemplateModelException(
"The dump directive doesn't allow nested content.");
}
TemplateHashModel dataModel = env.getDataModel();
// Need to unwrap in order to iterate through the variables
@SuppressWarnings("unchecked")
Map<String, Object> unwrappedDataModel = (Map<String, Object>) DeepUnwrap.permissiveUnwrap(dataModel);
List<String> varNames = new ArrayList<String>(unwrappedDataModel.keySet());
Collections.sort(varNames);
// *** RY Change data structure so it's
// "employee" => { type =>..., value => ...}
// rather than { name => "employee", type => ..., value => ...}
// Then this will be a SortedMap
// Otherwise we need a Comparator to sort on the "name" key. Yuck!
// The first data structure seems more natural
List<Map<String, Object>> models = new ArrayList<Map<String, Object>>();
for (String varName : varNames) {
models.add(getTemplateVariableDump(varName, dataModel.get(varName)));
}
Map<String, Object> map = new HashMap<String, Object>();
map.put("templateName", env.getTemplate().getName());
map.put("models", models);
dump("dumpAll.ftl", map, env);
}
}

4
webapp/src/freemarker/ext/dump/DumpDirective.java
View file

@ -43,8 +43,8 @@ public class DumpDirective extends BaseDumpDirective {
String varName = ((SimpleScalar)o).getAsString(); String varName = ((SimpleScalar)o).getAsString();
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put("var", getTemplateVariableData(varName, env)); map.put("var", getTemplateVariableDump(varName, env));
dump("dumpvar.ftl", map, varName, env); dump("dumpvar.ftl", map, env);
} }
} }