org.beetl.core

类 GroupTemplate

java.lang.Object

org.beetl.core.GroupTemplate

public class GroupTemplate
extends Object

系统核心类，重量级对象，详见指南

作者:

xiangdafu

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	GroupTemplate.SizeVirtualAttributeEval

构造器概要

构造器

构造器和说明
GroupTemplate() 使用默认的配置和默认的模板资源加载器ClasspathResourceLoader，
GroupTemplate(Configuration conf) 使用指定的配置和默认的资源加载器ClasspathResourceLoader
GroupTemplate(ResourceLoader loader, Configuration conf) 使用loader 和 conf初始化GroupTempalte
GroupTemplate(ResourceLoader loader, Configuration conf, ClassLoader classLoader) beetl加载类都通过classloader加载，在某些框架，需要显示设置一个classloader

方法概要

限定符和类型	方法和说明
void	addListener(EventListener eventListener)
void	close() 关闭GroupTemplate，清理所有的资源
void	enableStrict()
void	fireEvent(Event event)
Template	getAjaxTemplate(Object key, String ajaxId) 获取模板的ajax片段，
Template	getAjaxTemplate(Object key, String ajaxId, ResourceLoader loader) 获取模板key的标有ajaxId的模板片段。
AABuilder	getAttributeAccessFactory()
ClassLoader	getClassLoader()
ClassSearch	getClassSearch()
Configuration	getConf()
Format	getDefaultFormat(Class type)
TemplateEngine	getEngine() 设置一个自定义引擎
ErrorHandler	getErrorHandler()
Format	getFormat(String name)
Function	getFunction(String name)
AttributeNameConvert	getHtmlTagAttrNameConvert()
NativeSecurityManager	getNativeSecurity()
Program	getProgram(String key)
IBeetlCache	getProgramCache()
ResourceLoader	getResourceLoader()
Script	getScript(Object key) 获得脚本
Script	getScript(Object key, ResourceLoader loader) 获得脚本
Map<String,Object>	getSharedVars() 获得共享变量，如果未有，返回一个空的HashMap
TagFactory	getTagFactory(String name)
Template	getTemplate(Object key) 获取指定模板。
Template	getTemplate(Object key, Context parent)
Template	getTemplate(Object key, ResourceLoader loader) 使用额外的资源加载器加载模板
Template	getTemplate(Object key, String parent, ResourceLoader loader) 得到模板，并指明父模板
Template	getTemplateProxy(Template t) Template类是线程安全和高效的，但只能运行一次就抛弃。
VirtualClassAttribute	getVirtualAttributeEval(Class c, String attributeName)
boolean	hasTemplate(Object key) 判断是否加载过模板
protected void	init()
protected void	initBuffers()
protected void	initCache()
protected void	initFormatter()
protected void	initFunction()
protected void	initResourceLoader()
protected void	initTag()
protected void	initVirtual()
Class	loadClassBySimpleName(String simpleName) 通过class的简单名字找到class
void	registerDefaultFormat(Class type, Format format)
void	registerFormat(String name, Format format) 注册一个自定义格式化函数
void	registerFunction(String name, Function fn)
void	registerFunctionPackage(String packageName, Class cls) 注册一个类的所有方法，packageName+方法名是beetl的方法名
protected void	registerFunctionPackage(String packageName, Class target, Object o)
void	registerFunctionPackage(String packageName, Object o) 注册一个function包，包名由packageName指定，方法名是对象o里的所有方法 如果方法定义为void，则方法返回null，如果方法参数最后一个Context，则传入一个Context
void	registerFunctionPackageAsRoot(Class cls) 注册一个类的所有方法，方法名是beetl的方法名，类似registerFunction
protected void	registerFunctionPackageAsRoot(Class target, Object o)
void	registerTag(String name, Class tagCls)
void	registerTagFactory(String name, TagFactory tagFactory)
void	registerVirtualAttributeClass(Class cls, VirtualClassAttribute virtual)
void	registerVirtualAttributeEval(VirtualAttributeEval e)
void	removeTemplate(Object key) 手工删除加载过的模板
Map	runScript(Object key, Map<String,Object> paras) 执行某个脚本，参数是paras，返回的是顶级变量
Map	runScript(Object key, Map<String,Object> paras, Writer w) 执行某个脚本，参数是paras，返回的是顶级变量 ,如果script有输出，则输出到writer里
Map	runScript(Object key, Map<String,Object> paras, Writer w, ResourceLoader loader) 执行某个脚本，参数是paras，返回的是顶级变量
void	setClassLoader(ClassLoader classLoader) GroupTempalte 动态加载默写类使用的classloader
void	setConf(Configuration conf)
void	setEngine(TemplateEngine engine)
void	setErrorHandler(ErrorHandler errorHandler)
void	setNativeSecurity(NativeSecurityManager nativeSecurity)
void	setResourceLoader(ResourceLoader resourceLoader)
void	setSharedVars(Map<String,Object> vars) 添加共享变量
BeetlException	validateScript(Object key)
BeetlException	validateScript(Object key, ResourceLoader loader)
BeetlException	validateTemplate(Object key)
BeetlException	validateTemplate(Object key, ResourceLoader loader)

从类继承的方法 java.lang.Object

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

构造器详细资料

GroupTemplate

public GroupTemplate()

使用默认的配置和默认的模板资源加载器ClasspathResourceLoader，

GroupTemplate

public GroupTemplate(Configuration conf)

使用指定的配置和默认的资源加载器ClasspathResourceLoader

GroupTemplate

public GroupTemplate(ResourceLoader loader,
                     Configuration conf)

使用loader 和 conf初始化GroupTempalte

参数:

loader - 资源加载器

conf - 模板引擎配置

GroupTemplate

public GroupTemplate(ResourceLoader loader,
                     Configuration conf,
                     ClassLoader classLoader)

beetl加载类都通过classloader加载，在某些框架，需要显示设置一个classloader

参数:

loader -

conf -

classLoader - 默认是 Thread.currentThread().getContextClassLoader() 或者GroupTemplate的加载类

方法详细资料

initResourceLoader

protected void initResourceLoader()

init

protected void init()

initCache

protected void initCache()

initFunction

protected void initFunction()

initFormatter

protected void initFormatter()

initTag

protected void initTag()

initVirtual

protected void initVirtual()

initBuffers

protected void initBuffers()

setClassLoader

public void setClassLoader(ClassLoader classLoader)

GroupTempalte 动态加载默写类使用的classloader

参数:

classLoader - 资源加载器

getScript

public Script getScript(Object key)

获得脚本

getScript

public Script getScript(Object key,
                        ResourceLoader loader)

获得脚本

runScript

public Map runScript(Object key,
                     Map<String,Object> paras)
              throws BeetlException

执行某个脚本，参数是paras，返回的是顶级变量

抛出:

BeetlException - ,可以通过ErrorInfo 来获取异常信息详细信息

runScript

public Map runScript(Object key,
                     Map<String,Object> paras,
                     Writer w)
              throws BeetlException

执行某个脚本，参数是paras，返回的是顶级变量 ,如果script有输出，则输出到writer里

抛出:

BeetlException

runScript

public Map runScript(Object key,
                     Map<String,Object> paras,
                     Writer w,
                     ResourceLoader loader)
              throws BeetlException

执行某个脚本，参数是paras，返回的是顶级变量

抛出:

BeetlException

validateTemplate

public BeetlException validateTemplate(Object key,
                                       ResourceLoader loader)

validateTemplate

public BeetlException validateTemplate(Object key)

validateScript

public BeetlException validateScript(Object key,
                                     ResourceLoader loader)

validateScript

public BeetlException validateScript(Object key)

getTemplate

public Template getTemplate(Object key,
                            ResourceLoader loader)

使用额外的资源加载器加载模板

getAjaxTemplate

public Template getAjaxTemplate(Object key,
                                String ajaxId,
                                ResourceLoader loader)

获取模板key的标有ajaxId的模板片段。

getTemplate

public Template getTemplate(Object key,
                            String parent,
                            ResourceLoader loader)

得到模板，并指明父模板

getTemplate

public Template getTemplate(Object key,
                            Context parent)

getTemplate

public Template getTemplate(Object key)

获取指定模板。 注意，不能根据Template为空来判断模板是否存在，请调用ResourceLoader来判断

getAjaxTemplate

public Template getAjaxTemplate(Object key,
                                String ajaxId)

获取模板的ajax片段，

参数:

key - ，key为模板resourceId

getTemplateProxy

public Template getTemplateProxy(Template t)

Template类是线程安全和高效的，但只能运行一次就抛弃。如果想一直持有Template 可以调用此方法获得一个TemplateProxy

getProgram

public Program getProgram(String key)

hasTemplate

public boolean hasTemplate(Object key)

判断是否加载过模板

removeTemplate

public void removeTemplate(Object key)

手工删除加载过的模板

close

public void close()

关闭GroupTemplate，清理所有的资源

getResourceLoader

public ResourceLoader getResourceLoader()

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

getConf

public Configuration getConf()

setConf

public void setConf(Configuration conf)

getClassLoader

public ClassLoader getClassLoader()

fireEvent

public void fireEvent(Event event)

addListener

public void addListener(EventListener eventListener)

getProgramCache

public IBeetlCache getProgramCache()

registerFunction

public void registerFunction(String name,
                             Function fn)

registerFunctionPackage

public void registerFunctionPackage(String packageName,
                                    Object o)

注册一个function包，包名由packageName指定，方法名是对象o里的所有方法 如果方法定义为void，则方法返回null，如果方法参数最后一个Context，则传入一个Context

registerFunctionPackage

public void registerFunctionPackage(String packageName,
                                    Class cls)

注册一个类的所有方法，packageName+方法名是beetl的方法名

registerFunctionPackageAsRoot

public void registerFunctionPackageAsRoot(Class cls)

注册一个类的所有方法，方法名是beetl的方法名，类似registerFunction

registerFunctionPackage

protected void registerFunctionPackage(String packageName,
                                       Class target,
                                       Object o)

registerFunctionPackageAsRoot

protected void registerFunctionPackageAsRoot(Class target,
                                             Object o)

registerFormat

public void registerFormat(String name,
                           Format format)

注册一个自定义格式化函数

registerDefaultFormat

public void registerDefaultFormat(Class type,
                                  Format format)

registerTag

public void registerTag(String name,
                        Class tagCls)

registerTagFactory

public void registerTagFactory(String name,
                               TagFactory tagFactory)

getTagFactory

public TagFactory getTagFactory(String name)

getFunction

public Function getFunction(String name)

getFormat

public Format getFormat(String name)

getDefaultFormat

public Format getDefaultFormat(Class type)

registerVirtualAttributeEval

public void registerVirtualAttributeEval(VirtualAttributeEval e)

registerVirtualAttributeClass

public void registerVirtualAttributeClass(Class cls,
                                          VirtualClassAttribute virtual)

getVirtualAttributeEval

public VirtualClassAttribute getVirtualAttributeEval(Class c,
                                                     String attributeName)

loadClassBySimpleName

public Class loadClassBySimpleName(String simpleName)

通过class的简单名字找到class

getNativeSecurity

public NativeSecurityManager getNativeSecurity()

setNativeSecurity

public void setNativeSecurity(NativeSecurityManager nativeSecurity)

getErrorHandler

public ErrorHandler getErrorHandler()

getSharedVars

public Map<String,Object> getSharedVars()

获得共享变量，如果未有，返回一个空的HashMap

setSharedVars

public void setSharedVars(Map<String,Object> vars)

添加共享变量

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

getClassSearch

public ClassSearch getClassSearch()

getAttributeAccessFactory

public AABuilder getAttributeAccessFactory()

enableStrict

public void enableStrict()

getEngine

public TemplateEngine getEngine()

设置一个自定义引擎

setEngine

public void setEngine(TemplateEngine engine)

getHtmlTagAttrNameConvert

public AttributeNameConvert getHtmlTagAttrNameConvert()