Package edu.cornell.mannlib.vitro.webapp.web.directives

Class BaseTemplateDirectiveModel

java.lang.Object

edu.cornell.mannlib.vitro.webapp.web.directives.BaseTemplateDirectiveModel

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

Direct Known Subclasses:

DataGetterDirective, IndividualShortViewDirective, UrlDirective, WidgetDirective

public abstract class BaseTemplateDirectiveModel
extends Object
implements freemarker.template.TemplateDirectiveModel

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor	Description
BaseTemplateDirectiveModel()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getOptionalHashModelParameter(Map<?,?> params, String name)
protected String	getOptionalSimpleScalarParameter(Map<?,?> params, String name)	Get the parameter, or "null" if the parameter is not provided.
protected String	getRequiredSimpleScalarParameter(Map<?,?> params, String name)	Get the parameter, or throw an exception.
abstract Map<String,Object>	help(String name)
static String	processTemplateToString(String templateName, Map<String,Object> map, freemarker.core.Environment env)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface freemarker.template.TemplateDirectiveModel

execute

Constructor Detail

BaseTemplateDirectiveModel

public BaseTemplateDirectiveModel()

Method Detail

help

public abstract Map<String,Object> help(String name)

processTemplateToString

public static String processTemplateToString(String templateName,
                                             Map<String,Object> map,
                                             freemarker.core.Environment env)

getRequiredSimpleScalarParameter

protected String getRequiredSimpleScalarParameter(Map<?,?> params,
                                                  String name)
                                           throws freemarker.template.TemplateModelException

Get the parameter, or throw an exception.

Throws:

freemarker.template.TemplateModelException

getOptionalSimpleScalarParameter

protected String getOptionalSimpleScalarParameter(Map<?,?> params,
                                                  String name)
                                           throws freemarker.template.TemplateModelException

Get the parameter, or "null" if the parameter is not provided.

Throws:

freemarker.template.TemplateModelException

getOptionalHashModelParameter

protected Map<String,Object> getOptionalHashModelParameter(Map<?,?> params,
                                                                 String name)
                                                          throws freemarker.template.TemplateModelException

Throws:

freemarker.template.TemplateModelException