程序包 com.publiccms.logic.component.template

类 TemplateComponent

java.lang.Object

com.publiccms.logic.component.template.TemplateComponent

所有已实现的接口:

AdminContextPath, Cache

@Component
public class TemplateComponent
extends Object
implements Cache, AdminContextPath

模板处理组件 Template Component

字段概要

字段

修饰符和类型	字段	说明
private freemarker.template.Configuration	adminConfiguration
private CmsCategoryAttributeService	categoryAttributeService
private CmsCategoryLangService	categoryLangService
private CmsCategoryModelService	categoryModelService
private CmsCategoryService	categoryService
protected ConfigDataComponent	configDataComponent
private CmsContentAttributeService	contentAttributeService
protected ContentConfigComponent	contentConfigComponent
private CmsContentLangService	contentLangService
private CmsContentService	contentService
static final String	CONTEXT_ADMIN_CONTEXT_PATH	管理后台上下文路径 Context Management Context Path Context
protected FileUploadComponent	fileUploadComponent
static final String	INCLUDE_DIRECTORY	包含目录 include directory
private CmsLanguageService	languageService
protected final org.apache.commons.logging.Log	log
private MetadataComponent	metadataComponent
private ModelComponent	modelComponent
private CmsPlaceAttributeService	placeAttributeService
private CmsPlaceService	placeService
private static ExecutorService	pool
protected SiteAttributeComponent	siteAttributeComponent
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
private boolean	createCategoryFile(SysSite site, CmsCategory entity, CmsCategoryLang lang, Integer pageIndex, Integer totalPage)	分类页面静态化
String	createCategoryFile(SysSite site, CmsCategory entity, CmsCategoryLang langEntity, String templatePath, String filepathTemplate, Integer pageIndex, Integer totalPage)	分类页面静态化
String	createContentFile(SysSite site, CmsContent entity, CmsContentLang langEntity, CmsCategory category, boolean createMultiContentPage, String templatePath, String filepathTemplate, Integer pageIndex)	内容页面静态化
private boolean	createContentFile(SysSite site, CmsContent entity, CmsContentLang lang, String defaultLang, CmsCategory category, CmsCategoryModel categoryModel)	内容页面静态化
void	createContentFile(SysSite site, List<Serializable> idList, CmsCategory category, CmsCategoryModel categoryModel)	内容页面静态化
String	createStaticFile(SysSite site, String fullTemplatePath, String filepath, String lang, Integer pageIndex, CmsPageMetadata metadata, Map<String,Object> model, Consumer<String> urlConsumer)	创建静态化页面
void	deleteStaticFile(short siteId, CmsCategory entity)
void	deleteStaticFile(short siteId, CmsContent entity)
void	deleteStaticFile(short siteId, String url)
void	destroy()
private void	exposePlace(SysSite site, String templatePath, String lang, String defaultLang, CmsPlaceMetadata metadata, Map<String,Object> model)
String	generateFilepath(String filepathTemplate, SysSite site, Map<String,Object> model)
String	generatePlaceFilePath(String filepath, CmsCategory category, Map<String,Object> model)	生成页面片段路径
freemarker.template.Configuration	getAdminConfiguration()	获取FreeMarker管理后台配置
freemarker.template.Configuration	getTaskConfiguration()	获取FreeMarker任务计划配置
freemarker.template.Configuration	getWebConfiguration()	获取FreeMarker前台配置
void	initPreviewContentModel(SysSite site, CmsContent entity, CmsContentAttribute attribute, CmsContentParameters contentParameters, org.springframework.ui.ModelMap model)
void	previewContent(SysSite site, CmsContent entity, CmsContentAttribute attribute, Writer writer, org.springframework.ui.ModelMap model)
String	printPlace(SysSite site, String templatePath, String lang, CmsPlaceMetadata metadata)	输出页面片段
void	printPlace(Writer writer, SysSite site, String templatePath, String lang, String defaultLang, CmsPlaceMetadata metadata)	输出页面片段
boolean	publish(SysSite site, CmsCategory entity, Integer pageIndex, Integer totalPage)
boolean	publish(SysSite site, CmsContent entity)
boolean	publish(SysSite site, CmsContent entity, CmsCategory category)
boolean	publish(SysSite site, CmsContent entity, CmsCategory category, CmsCategoryModel categoryModel)
void	publishPage(SysSite site, String templatePath)	创建静态化页面
boolean	publishPage(SysSite site, String templatePath, String lang)	创建静态化页面
void	publishPlace(SysSite site, String templatePath, boolean checkExists)	静态化页面片段
void	setAdminConfiguration(freemarker.template.Configuration adminConfiguration)
void	setAdminContextPath(String adminContextPath)
void	setTaskConfiguration(freemarker.template.Configuration taskConfiguration)
void	setWebConfiguration(freemarker.template.Configuration webConfiguration)
private void	staticPlace(SysSite site, String templatePath, String lang, String defaultLang, CmsPlaceMetadata metadata)	静态化页面片段

从类继承的方法 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 String INCLUDE_DIRECTORY

包含目录 include directory

另请参阅:

• 常量字段值

CONTEXT_ADMIN_CONTEXT_PATH

public static final 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

contentLangService

private CmsContentLangService contentLangService

categoryLangService

private CmsCategoryLangService categoryLangService

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

languageService

private CmsLanguageService languageService

siteAttributeComponent

protected SiteAttributeComponent siteAttributeComponent

pool

private static ExecutorService pool

构造器详细资料

TemplateComponent

public TemplateComponent()

方法详细资料

createCategoryFile

public String createCategoryFile(SysSite site,
 CmsCategory entity,
 CmsCategoryLang langEntity,
 String templatePath,
 String filepathTemplate,
 Integer pageIndex,
 Integer totalPage)
                          throws IOException,
freemarker.template.TemplateException

分类页面静态化

参数:

site -

entity -

langEntity -

templatePath -

filepathTemplate -

pageIndex -

totalPage -

defaultLang -

返回:

category static file path

抛出:

IOException

freemarker.template.TemplateException

createContentFile

public String createContentFile(SysSite site,
 CmsContent entity,
 CmsContentLang langEntity,
 CmsCategory category,
 boolean createMultiContentPage,
 String templatePath,
 String filepathTemplate,
 Integer pageIndex)
                         throws IOException,
freemarker.template.TemplateException

内容页面静态化

参数:

site -

entity -

langEntity -

category -

createMultiContentPage -

templatePath -

filepathTemplate -

pageIndex -

defaultLang -

返回:

content static file path

抛出:

IOException

freemarker.template.TemplateException

createContentFile

private boolean createContentFile(SysSite site,
 CmsContent entity,
 CmsContentLang lang,
 String defaultLang,
 CmsCategory category,
 CmsCategoryModel categoryModel)
                           throws IOException,
freemarker.template.TemplateException

内容页面静态化

参数:

site -

entity -

lang -

category -

categoryModel -

返回:

whether the create is successful

抛出:

freemarker.template.TemplateException

IOException

publish

public boolean publish(SysSite site,
 CmsCategory entity,
 Integer pageIndex,
 Integer totalPage)
                throws IOException,
freemarker.template.TemplateException

参数:

site -

entity -

pageIndex -

totalPage -

返回:

抛出:

freemarker.template.TemplateException

IOException

publish

public boolean publish(SysSite site,
 CmsContent entity)
                throws IOException,
freemarker.template.TemplateException

参数:

site -

entity -

返回:

抛出:

freemarker.template.TemplateException

IOException

publish

public boolean publish(SysSite site,
 CmsContent entity,
 CmsCategory category)
                throws IOException,
freemarker.template.TemplateException

参数:

site -

entity -

category -

返回:

抛出:

freemarker.template.TemplateException

IOException

publish

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

参数:

site -

entity -

category -

categoryModel -

返回:

抛出:

freemarker.template.TemplateException

IOException

deleteStaticFile

public void deleteStaticFile(short siteId,
 CmsCategory entity)

参数:

siteId -

entity - 分类

deleteStaticFile

public void deleteStaticFile(short siteId,
 CmsContent entity)

参数:

siteId -

entity - 内容

deleteStaticFile

public void deleteStaticFile(short siteId,
 String url)

参数:

siteId -

url -

createCategoryFile

private boolean createCategoryFile(SysSite site,
 CmsCategory entity,
 CmsCategoryLang lang,
 Integer pageIndex,
 Integer totalPage)
                            throws IOException,
freemarker.template.TemplateException

分类页面静态化

参数:

site -

entity -

lang -

pageIndex -

totalPage -

defaultLang -

返回:

whether the create is successful

抛出:

IOException

freemarker.template.TemplateException

createContentFile

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

内容页面静态化

参数:

site -

idList -

category -

categoryModel -

initPreviewContentModel

public void initPreviewContentModel(SysSite site,
 CmsContent entity,
 CmsContentAttribute attribute,
 CmsContentParameters contentParameters,
 org.springframework.ui.ModelMap model)

参数:

site -

entity -

attribute -

contentParameters -

model -

writer -

previewContent

public void previewContent(SysSite site,
 CmsContent entity,
 CmsContentAttribute attribute,
 Writer writer,
 org.springframework.ui.ModelMap model)

参数:

site -

entity -

attribute -

writer -

model -

generatePlaceFilePath

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

生成页面片段路径

参数:

filepath -

category -

model -

返回:

抛出:

IOException

freemarker.template.TemplateException

publishPlace

public void publishPlace(SysSite site,
 String templatePath,
 boolean checkExists)
                  throws IOException,
freemarker.template.TemplateException

静态化页面片段

参数:

site - 站点

templatePath - 模板路径 不含include

checkExists - 检查是否存在

抛出:

IOException

freemarker.template.TemplateException

staticPlace

private void staticPlace(SysSite site,
 String templatePath,
 String lang,
 String defaultLang,
 CmsPlaceMetadata metadata)
                  throws IOException,
freemarker.template.TemplateException

静态化页面片段

参数:

site -

templatePath -

lang -

metadata -

抛出:

IOException

freemarker.template.TemplateException

printPlace

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

输出页面片段

参数:

site -

templatePath -

lang -

metadata -

返回:

place content

抛出:

IOException

freemarker.template.TemplateException

printPlace

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

输出页面片段

参数:

writer -

site -

templatePath -

lang -

defaultLang -

metadata -

抛出:

IOException

freemarker.template.TemplateException

publishPage

public boolean publishPage(SysSite site,
 String templatePath,
 String lang)
                    throws IOException,
freemarker.template.TemplateException

创建静态化页面

参数:

site -

templatePath -

lang -

返回:

抛出:

IOException

freemarker.template.TemplateException

publishPage

public void publishPage(SysSite site,
 String templatePath)
                 throws IOException,
freemarker.template.TemplateException

创建静态化页面

参数:

site -

templatePath -

抛出:

IOException

freemarker.template.TemplateException

generateFilepath

public String generateFilepath(String filepathTemplate,
 SysSite site,
 Map<String,Object> model)
                        throws IOException,
freemarker.template.TemplateException

抛出:

IOException

freemarker.template.TemplateException

createStaticFile

public String createStaticFile(SysSite site,
 String fullTemplatePath,
 String filepath,
 String lang,
 Integer pageIndex,
 CmsPageMetadata metadata,
 Map<String,Object> model,
 Consumer<String> urlConsumer)
                        throws IOException,
freemarker.template.TemplateException

创建静态化页面

参数:

site -

fullTemplatePath -

filepath -

lang -

pageIndex -

metadata -

model -

urlConsumer -

返回:

static file path

抛出:

IOException

freemarker.template.TemplateException

exposePlace

private void exposePlace(SysSite site,
 String templatePath,
 String lang,
 String defaultLang,
 CmsPlaceMetadata metadata,
 Map<String,Object> model)

setAdminContextPath

public void setAdminContextPath(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