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

NIHVIVO-564 Work on dump directive

Browse source
This commit is contained in:
rjy7 2010-07-27 21:49:40 +00:00
parent 86bdfaf1cd
commit 83938a2c19
11 changed files with 138 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerComponentGenerator.java
View file

@ -24,7 +24,7 @@ import freemarker.template.Configuration;
public class FreemarkerComponentGenerator extends FreemarkerHttpServlet {
private static final long serialVersionUID = 1L;
private static final Log log = LogFactory.getLog(FreemarkerHttpServlet.class.getName());
private static final Log log = LogFactory.getLog(FreemarkerComponentGenerator.class);
private static ServletContext context = null;

45
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHelper.java Normal file
View file

@ -0,0 +1,45 @@
package edu.cornell.mannlib.vitro.webapp.controller.freemarker;
import java.io.IOException;
import java.io.StringWriter;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
public class FreemarkerHelper {
private static final Log log = LogFactory.getLog(FreemarkerHelper.class);
public StringWriter mergeToTemplate(String templateName, Map<String, Object> map, Configuration config) {
Template template = null;
try {
template = config.getTemplate(templateName);
} catch (IOException e) {
log.error("Cannot get template " + templateName);
}
StringWriter sw = new StringWriter();
if (template != null) {
try {
template.process(map, sw);
} catch (TemplateException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
return sw;
}
public String mergeMapToTemplate(String templateName, Map<String, Object> map, Configuration config) {
return mergeToTemplate(templateName, map, config).toString();
}
}

26
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java
View file

@ -50,7 +50,7 @@ import freemarker.template.TemplateModelException;
public class FreemarkerHttpServlet extends VitroHttpServlet {
private static final long serialVersionUID = 1L;
private static final Log log = LogFactory.getLog(FreemarkerHttpServlet.class.getName());
private static final Log log = LogFactory.getLog(FreemarkerHttpServlet.class);
private static final int FILTER_SECURITY_LEVEL = LoginFormBean.EDITOR;
public void doGet( HttpServletRequest request, HttpServletResponse response )
@ -375,27 +375,9 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
return "";
}
protected StringWriter mergeToTemplate(String templateName, Map<String, Object> map, Configuration config) {
Template template = null;
try {
template = config.getTemplate(templateName);
} catch (IOException e) {
log.error("Cannot get template " + templateName);
}
StringWriter sw = new StringWriter();
if (template != null) {
try {
template.process(map, sw);
} catch (TemplateException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
return sw;
protected StringWriter mergeToTemplate(String templateName, Map<String, Object> map, Configuration config) {
FreemarkerHelper helper = new FreemarkerHelper();
return helper.mergeToTemplate(templateName, map, config);
}
protected String mergeBodyToTemplate(String templateName, Map<String, Object> map, Configuration config) {

3
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/TestController.java
View file

@ -69,6 +69,9 @@ public class TestController extends FreemarkerHttpServlet {
body.put("zoo1", zoo1);
body.put("zoo2", zoo2);
body.put("trueStatement", true);
body.put("falseStatement", false);
getBerries(body);
body.put("bookTitle", "Pride and Prejudice");

52
webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDirective.java
View file

@ -4,20 +4,22 @@ package edu.cornell.mannlib.vitro.webapp.web.directives;
import java.io.IOException;
import java.io.Writer;
import java.util.Iterator;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHelper;
import freemarker.core.Environment;
import freemarker.template.Configuration;
import freemarker.template.SimpleDate;
import freemarker.template.SimpleScalar;
import freemarker.template.SimpleSequence;
import freemarker.template.TemplateBooleanModel;
import freemarker.template.TemplateDirectiveBody;
import freemarker.template.TemplateDirectiveModel;
import freemarker.template.TemplateException;
import freemarker.template.TemplateHashModel;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelException;
import freemarker.template.utility.DeepUnwrap;
public class DumpDirective implements TemplateDirectiveModel {
@ -43,15 +45,45 @@ public class DumpDirective implements TemplateDirectiveModel {
String var = ((SimpleScalar)o).getAsString();
TemplateHashModel dataModel = env.getDataModel();
TemplateModel val = dataModel.get(var);
String output = var + ": " + val.toString();
TemplateModel val = dataModel.get(var);
Configuration config = env.getConfiguration();
String templateName = "dump-var.ftl";
String includeTemplate;
Object value = val;
String type = null;
if (val instanceof SimpleScalar) {
includeTemplate = "dump-string.ftl";
type = "string";
} else if (val instanceof SimpleDate) {
includeTemplate = "dump-string.ftl";
value = value.toString();
type = "date";
} else if (val instanceof TemplateBooleanModel) {
includeTemplate = "dump-string.ftl";
value = ((TemplateBooleanModel) val).getAsBoolean() ? "true" : "false";
type = "boolean";
} else if (val instanceof SimpleSequence){
includeTemplate = "dump-array.ftl";
type = "array";
} else {
includeTemplate = "dump-string.ftl";
value = value.toString();
type = "object";
}
Map<String, Object> map = new HashMap<String, Object>();
map.put("var", var);
map.put("value", value);
map.put("includeTemplate", includeTemplate);
map.put("type", type);
FreemarkerHelper helper = new FreemarkerHelper();
String output = helper.mergeMapToTemplate(templateName, map, config);
// RY Improve by making presentation of various types more nuanced
// Also merge to a template for formatting:
// get config from environment; get a template from config
// merge as in FreeMarkerHttpServlet.mergeToTemplate()
Writer out = env.getOut();
out.write(output + "<br />");
out.write(output);
}

9
webapp/web/css/dump.css Normal file
View file

@ -0,0 +1,9 @@
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
/* Styles for Freemarker template variable dump */
.dump {
border-top: 1px solid #ccc;
border-bottom: 1px solid #ccc;
padding: 5em 0;
}

9
webapp/web/templates/freemarker/body/partials/dump/dump-array.ftl Normal file
View file

@ -0,0 +1,9 @@
<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
<#-- Template for dumping string values -->
<ul>
<#list value as item>
<li>${item_index}: ${item}</li>
</#list>
</ul>

0
webapp/web/templates/freemarker/body/partials/dump/dump-hash.ftl Normal file
View file

6
webapp/web/templates/freemarker/body/partials/dump/dump-string.ftl Normal file
View file

@ -0,0 +1,6 @@
<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
<#-- Template for dumping string values -->
${value}

17
webapp/web/templates/freemarker/body/partials/dump/dump-var.ftl Normal file
View file

@ -0,0 +1,17 @@
<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
<#-- Template for dumping a template variable -->
<hr />
<div class="dump">
<h6>Freemarker template variable dump</h6>
<strong>Variable <em>${var}</em>:</strong><br/ >
<strong>Type:</strong> ${type}<br />
<strong>Value:</strong>
<#include includeTemplate />
</div>
<hr />

2
webapp/web/templates/freemarker/body/test.ftl
View file

@ -49,6 +49,8 @@
<@dump var="now" />
<@dump var="urls" />
<@dump var="fruit" />
<@dump var="trueStatement" />
<@dump var="falseStatement" />
<@dumpDataModel />
${stylesheets.addFromTheme("/sstest.css", "/sstest2.css")}