com.publiccms.logic.component.template

类 TemplateComponent

java.lang.Object

com.publiccms.logic.component.template.TemplateComponent

所有已实现的接口:

AdminContextPath, Cache

@Component
public class TemplateComponent
extends java.lang.Object
implements Cache, AdminContextPath

模板处理组件 Template Component

字段概要

字段

限定符和类型	字段和说明
private freemarker.template.Configuration	adminConfiguration
private CmsCategoryAttributeService	categoryAttributeService
private CmsCategoryModelService	categoryModelService
private CmsCategoryService	categoryService
protected ConfigDataComponent	configDataComponent
private CmsContentAttributeService	contentAttributeService
protected ContentConfigComponent	contentConfigComponent
private CmsContentService	contentService
static java.lang.String	CONTEXT_ADMIN_CONTEXT_PATH 管理后台上下文路径 Context Management Context Path Context
protected FileUploadComponent	fileUploadComponent
static java.lang.String	INCLUDE_DIRECTORY 包含目录 include directory
protected org.apache.commons.logging.Log	log
private MetadataComponent	metadataComponent
private ModelComponent	modelComponent
private CmsPlaceAttributeService	placeAttributeService
private CmsPlaceService	placeService
private static java.util.concurrent.ExecutorService	pool
private SiteComponent	siteComponent
private StatisticsComponent	statisticsComponent
private freemarker.template.Configuration	taskConfiguration
private freemarker.template.Configuration	webConfiguration

构造器概要

构造器

构造器和说明
TemplateComponent()

方法概要

限定符和类型	方法和说明
void	clear()
void	clearTaskTemplateCache() 清理任务计划模板缓存 Clear Template Cache
void	clearTemplateCache() 清理模板缓存 Clear Template Cache
boolean	createCategoryFile(SysSite site, CmsCategory entity, java.lang.Integer pageIndex, java.lang.Integer totalPage) 分类页面静态化
java.lang.String	createCategoryFile(SysSite site, CmsCategory entity, java.lang.String templatePath, java.lang.String filepath, java.lang.Integer pageIndex, java.lang.Integer totalPage) 分类页面静态化
java.lang.String	createContentFile(SysSite site, CmsContent entity, CmsCategory category, boolean createMultiContentPage, java.lang.String templatePath, java.lang.String filepath, java.lang.Integer pageIndex) 内容页面静态化
boolean	createContentFile(SysSite site, CmsContent entity, CmsCategory category, CmsCategoryModel categoryModel) 内容页面静态化
void	createContentFile(SysSite site, java.util.List<java.io.Serializable> idList, CmsCategory category, CmsCategoryModel categoryModel) 内容页面静态化
java.lang.String	createStaticFile(SysSite site, java.lang.String fullTemplatePath, java.lang.String filepath, java.lang.Integer pageIndex, java.util.Map<java.lang.String,java.lang.Object> metadataMap, java.util.Map<java.lang.String,java.lang.Object> model, java.util.function.Consumer<java.lang.String> urlConsumer) 创建静态化页面
void	destroy()
private void	exposePlace(SysSite site, java.lang.String templatePath, CmsPlaceMetadata metadata, CmsPageData data, java.util.Map<java.lang.String,java.lang.Object> model)
java.lang.String	generatePlaceFilePath(java.lang.String filepath, CmsCategory category, java.util.Map<java.lang.String,java.lang.Object> model) 生成页面片段路径
freemarker.template.Configuration	getAdminConfiguration() 获取FreeMarker管理后台配置
freemarker.template.Configuration	getTaskConfiguration() 获取FreeMarker任务计划配置
freemarker.template.Configuration	getWebConfiguration() 获取FreeMarker前台配置
java.lang.String	printPlace(SysSite site, java.lang.String templatePath, CmsPlaceMetadata metadata, CmsPageData data) 输出页面片段
void	printPlace(java.io.Writer writer, SysSite site, java.lang.String templatePath, CmsPlaceMetadata metadata, CmsPageData data) 输出页面片段
void	setAdminConfiguration(freemarker.template.Configuration adminConfiguration)
void	setAdminContextPath(java.lang.String adminContextPath)
void	setTaskConfiguration(freemarker.template.Configuration taskConfiguration)
void	setWebConfiguration(freemarker.template.Configuration webConfiguration)
void	staticPlace(SysSite site, java.lang.String templatePath, CmsPlaceMetadata metadata, CmsPageData data) 静态化页面片段

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

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

字段详细资料

log

protected final org.apache.commons.logging.Log log

INCLUDE_DIRECTORY

public static final java.lang.String INCLUDE_DIRECTORY

包含目录 include directory

另请参阅:

常量字段值

CONTEXT_ADMIN_CONTEXT_PATH

public static final java.lang.String CONTEXT_ADMIN_CONTEXT_PATH

管理后台上下文路径 Context Management Context Path Context

另请参阅:

常量字段值

adminConfiguration

private freemarker.template.Configuration adminConfiguration

webConfiguration

private freemarker.template.Configuration webConfiguration

taskConfiguration

private freemarker.template.Configuration taskConfiguration

contentAttributeService

private CmsContentAttributeService contentAttributeService

categoryAttributeService

private CmsCategoryAttributeService categoryAttributeService

contentService

private CmsContentService contentService

categoryModelService

private CmsCategoryModelService categoryModelService

categoryService

private CmsCategoryService categoryService

siteComponent

private SiteComponent siteComponent

metadataComponent

private MetadataComponent metadataComponent

modelComponent

private ModelComponent modelComponent

placeService

private CmsPlaceService placeService

placeAttributeService

private CmsPlaceAttributeService placeAttributeService

fileUploadComponent

protected FileUploadComponent fileUploadComponent

configDataComponent

protected ConfigDataComponent configDataComponent

contentConfigComponent

protected ContentConfigComponent contentConfigComponent

statisticsComponent

private StatisticsComponent statisticsComponent

pool

private static java.util.concurrent.ExecutorService pool

构造器详细资料

TemplateComponent

public TemplateComponent()

方法详细资料

createCategoryFile

public java.lang.String createCategoryFile(SysSite site,
                                           CmsCategory entity,
                                           java.lang.String templatePath,
                                           java.lang.String filepath,
                                           java.lang.Integer pageIndex,
                                           java.lang.Integer totalPage)
                                    throws java.io.IOException,
                                           freemarker.template.TemplateException

分类页面静态化

参数:

site -

entity -

templatePath -

filepath -

pageIndex -

totalPage -

返回:

category static file path

抛出:

java.io.IOException

freemarker.template.TemplateException

createContentFile

public java.lang.String createContentFile(SysSite site,
                                          CmsContent entity,
                                          CmsCategory category,
                                          boolean createMultiContentPage,
                                          java.lang.String templatePath,
                                          java.lang.String filepath,
                                          java.lang.Integer pageIndex)
                                   throws java.io.IOException,
                                          freemarker.template.TemplateException

内容页面静态化

参数:

site -

entity -

category -

createMultiContentPage -

templatePath -

filepath -

pageIndex -

返回:

content static file path

抛出:

java.io.IOException

freemarker.template.TemplateException

createContentFile

public boolean createContentFile(SysSite site,
                                 CmsContent entity,
                                 CmsCategory category,
                                 CmsCategoryModel categoryModel)
                          throws java.io.IOException,
                                 freemarker.template.TemplateException

内容页面静态化

参数:

site -

entity -

category -

categoryModel -

返回:

whether the create is successful

抛出:

freemarker.template.TemplateException

java.io.IOException

createCategoryFile

public boolean createCategoryFile(SysSite site,
                                  CmsCategory entity,
                                  java.lang.Integer pageIndex,
                                  java.lang.Integer totalPage)
                           throws java.io.IOException,
                                  freemarker.template.TemplateException

分类页面静态化

参数:

site -

entity -

pageIndex -

totalPage -

返回:

whether the create is successful

抛出:

java.io.IOException

freemarker.template.TemplateException

createContentFile

public void createContentFile(SysSite site,
                              java.util.List<java.io.Serializable> idList,
                              CmsCategory category,
                              CmsCategoryModel categoryModel)

内容页面静态化

参数:

site -

idList -

category -

categoryModel -

generatePlaceFilePath

public java.lang.String generatePlaceFilePath(java.lang.String filepath,
                                              CmsCategory category,
                                              java.util.Map<java.lang.String,java.lang.Object> model)
                                       throws java.io.IOException,
                                              freemarker.template.TemplateException

生成页面片段路径

参数:

filepath -

category -

model -

返回:

抛出:

java.io.IOException

freemarker.template.TemplateException

staticPlace

public void staticPlace(SysSite site,
                        java.lang.String templatePath,
                        CmsPlaceMetadata metadata,
                        CmsPageData data)
                 throws java.io.IOException,
                        freemarker.template.TemplateException

静态化页面片段

参数:

site -

templatePath -

metadata -

data -

抛出:

java.io.IOException

freemarker.template.TemplateException

printPlace

public java.lang.String printPlace(SysSite site,
                                   java.lang.String templatePath,
                                   CmsPlaceMetadata metadata,
                                   CmsPageData data)
                            throws java.io.IOException,
                                   freemarker.template.TemplateException

输出页面片段

参数:

site -

templatePath -

metadata -

data -

返回:

place content

抛出:

java.io.IOException

freemarker.template.TemplateException

printPlace

public void printPlace(java.io.Writer writer,
                       SysSite site,
                       java.lang.String templatePath,
                       CmsPlaceMetadata metadata,
                       CmsPageData data)
                throws java.io.IOException,
                       freemarker.template.TemplateException

输出页面片段

参数:

writer -

site -

templatePath -

metadata -

data -

抛出:

java.io.IOException

freemarker.template.TemplateException

createStaticFile

public java.lang.String createStaticFile(SysSite site,
                                         java.lang.String fullTemplatePath,
                                         java.lang.String filepath,
                                         java.lang.Integer pageIndex,
                                         java.util.Map<java.lang.String,java.lang.Object> metadataMap,
                                         java.util.Map<java.lang.String,java.lang.Object> model,
                                         java.util.function.Consumer<java.lang.String> urlConsumer)
                                  throws java.io.IOException,
                                         freemarker.template.TemplateException

创建静态化页面

参数:

site -

fullTemplatePath -

filepath -

pageIndex -

metadataMap -

model -

urlConsumer -

返回:

static file path

抛出:

java.io.IOException

freemarker.template.TemplateException

exposePlace

private void exposePlace(SysSite site,
                         java.lang.String templatePath,
                         CmsPlaceMetadata metadata,
                         CmsPageData data,
                         java.util.Map<java.lang.String,java.lang.Object> model)

setAdminContextPath

public void setAdminContextPath(java.lang.String adminContextPath)

指定者:

setAdminContextPath 在接口中 AdminContextPath

clear

public void clear()

指定者:

clear 在接口中 Cache

destroy

@PreDestroy
public void destroy()

clearTemplateCache

public void clearTemplateCache()

清理模板缓存 Clear Template Cache

clearTaskTemplateCache

public void clearTaskTemplateCache()

清理任务计划模板缓存 Clear Template Cache

setAdminConfiguration

public void setAdminConfiguration(freemarker.template.Configuration adminConfiguration)

参数:

adminConfiguration - the adminConfiguration to set

setWebConfiguration

public void setWebConfiguration(freemarker.template.Configuration webConfiguration)

参数:

webConfiguration - the webConfiguration to set

setTaskConfiguration

public void setTaskConfiguration(freemarker.template.Configuration taskConfiguration)

参数:

taskConfiguration - the taskConfiguration to set

getAdminConfiguration

public freemarker.template.Configuration getAdminConfiguration()

获取FreeMarker管理后台配置

返回:

FreeMarker admin config

getWebConfiguration

public freemarker.template.Configuration getWebConfiguration()

获取FreeMarker前台配置

返回:

FreeMarker web config

getTaskConfiguration

public freemarker.template.Configuration getTaskConfiguration()

获取FreeMarker任务计划配置

返回:

FreeMarker task config