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

NIHVIVO-2378 Add HelpDirective to freemarker dump package. Remove DescribeDirective from vitro source.

Browse source
This commit is contained in:
ryounes 2011-04-20 18:56:05 +00:00
parent 79b7f7a3e4
commit c1a7c7a9f5
9 changed files with 417 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -313,7 +313,6 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
*/
public static Map<String, Object> getDirectives() {
Map<String, Object> map = new HashMap<String, Object>();
map.put("describe", new edu.cornell.mannlib.vitro.webapp.web.directives.dump.DescribeDirective());
map.put("dump", new edu.cornell.mannlib.vitro.webapp.web.directives.dump.DumpDirective());
map.put("dumpAll", new edu.cornell.mannlib.vitro.webapp.web.directives.dump.DumpAllDirective());
map.put("help", new edu.cornell.mannlib.vitro.webapp.web.directives.dump.HelpDirective());

109
webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/dump/DescribeDirective.java
View file

@ -1,109 +0,0 @@
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
package edu.cornell.mannlib.vitro.webapp.web.directives.dump;
import java.io.IOException;
import java.lang.reflect.Method;
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 edu.cornell.mannlib.vitro.webapp.web.directives.BaseTemplateDirectiveModel;
import edu.cornell.mannlib.vitro.webapp.web.templatemodels.BaseTemplateModel;
import freemarker.core.Environment;
import freemarker.template.SimpleScalar;
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 DescribeDirective extends BaseTemplateDirectiveModel {
private static final Log log = LogFactory.getLog(DescribeDirective.class);
@Override
public void execute(Environment env, Map params, TemplateModel[] loopVars,
TemplateDirectiveBody body) throws TemplateException, IOException {
if (loopVars.length != 0) {
throw new TemplateModelException(
"The describe directive doesn't allow loop variables.");
}
if (body != null) {
throw new TemplateModelException(
"The describe directive doesn't allow nested content.");
}
Object o = params.get("var");
if ( !(o instanceof SimpleScalar)) {
throw new TemplateModelException(
"Value of parameter 'var' must be a string.");
}
String varName = ((SimpleScalar)o).getAsString();
TemplateHashModel dataModel = env.getDataModel();
TemplateModel wrappedModel = null;
try {
wrappedModel = dataModel.get(varName);
} catch (TemplateModelException tme) {
log.error("Error getting value of template model " + varName + " from data model.");
}
Object unwrappedModel = null;
try {
unwrappedModel = DeepUnwrap.permissiveUnwrap(wrappedModel);
} catch (TemplateModelException e) {
log.error("Cannot unwrap template model " + varName + ".");
}
if (! (unwrappedModel instanceof BaseTemplateModel) ) {
throw new TemplateModelException(
varName + " is not a template model.");
}
DumpHelper helper = new DumpHelper(env);
List<Method> methods = helper.getMethodsAvailableToTemplate(wrappedModel, (BaseTemplateModel)unwrappedModel);
List<String> methodDisplayNames = new ArrayList<String>(methods.size());
for (Method m : methods) {
methodDisplayNames.add(helper.getMethodDisplayName(m));
}
Collections.sort(methodDisplayNames);
Map<String, Object> map = new HashMap<String, Object>();
map.put("var", varName);
map.put("methods", methodDisplayNames);
helper.writeDump("describe.ftl", map, varName, dataModel);
}
@Override
public String help(String name, Environment env) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("name", name);
map.put("effect", "Describe the methods callable on a template variable.");
//map.put("comments", "");
Map<String, String> params = new HashMap<String, String>();
params.put("var", "name of variable to describe");
map.put("params", params);
List<String> examples = new ArrayList<String>();
examples.add("<@" + name + " var=\"stylesheets\" />");
map.put("examples", examples);
return mergeToHelpTemplate(map, env);
}
}