Package org.opencms.xml.templatemapper

Class CmsTemplateMapper

java.lang.Object

org.opencms.xml.templatemapper.CmsTemplateMapper

public final class CmsTemplateMapper
extends Object

Responsible for mapping formatters, containers and settings to different formatters, containers and settings according to the configuration file /system/config/template-mapping.xml.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_configPath	The path to the mapper configuration.
protected boolean	m_enabled	Flag which controls whether this is enabled.

Constructor Summary

Constructors

Constructor	Description
CmsTemplateMapper(String configPath)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
static CmsTemplateMapper	get()	Gets a template mapper.
static CmsTemplateMapper	get(javax.servlet.ServletRequest request)	Gets the template mapper for the current request.
static String	getTemplateMapperConfig(javax.servlet.ServletRequest request)	Checks if the selected template context is "templatemapper".
void	setForSave(boolean forSave)	Sets the for-save mode.
protected CmsContainerElementBean	transformContainerElement(CmsObject cms, CmsTemplateMapperConfiguration config, CmsContainerElementBean element)	Helper method to transform a single container element.
CmsContainerPageBean	transformContainerpageBean(CmsObject cms, CmsContainerPageBean input, String rootPath)	Transforms a container page bean.
CmsContainerElementBean	transformDetailElement(CmsObject cms, CmsContainerElementBean input, String rootPath)	Transforms a container element bean used for detail elements.
CmsGroupContainerBean	transformGroupContainer(CmsObject cms, CmsGroupContainerBean input, String rootPath)	Transforms a group container bean.

Methods inherited from class java.lang.Object

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

Field Details

m_enabled

protected boolean m_enabled

Flag which controls whether this is enabled.

m_configPath

protected String m_configPath

The path to the mapper configuration.

Constructor Details

CmsTemplateMapper

public CmsTemplateMapper(String configPath)

Creates a new instance.

Parameters:

configPath - the template mapper configuration VFS path

Method Details

get

public static CmsTemplateMapper get()

Gets a template mapper.

Returns:

a template mapper

get

public static CmsTemplateMapper get(javax.servlet.ServletRequest request)

Gets the template mapper for the current request.

Parameters:

request - the current request

Returns:

the template mapper

getTemplateMapperConfig

public static String getTemplateMapperConfig(javax.servlet.ServletRequest request)

Checks if the selected template context is "templatemapper".

Parameters:

request - the current request

Returns:

true if the selected template context is "templatemapper"

setForSave

public void setForSave(boolean forSave)

Sets the for-save mode.

Parameters:

forSave - true if for-save mode should be enabled

transformContainerpageBean

public CmsContainerPageBean transformContainerpageBean(CmsObject cms,
 CmsContainerPageBean input,
 String rootPath)

Transforms a container page bean.

Parameters:

cms - the current CMS context

input - the bean to be transformed

rootPath - the root path of the page

Returns:

the transformed bean

transformDetailElement

public CmsContainerElementBean transformDetailElement(CmsObject cms,
 CmsContainerElementBean input,
 String rootPath)

Transforms a container element bean used for detail elements.

Parameters:

cms - the current CMS context

input - the bean to be transformed

rootPath - the root path of the page

Returns:

the transformed bean

transformGroupContainer

public CmsGroupContainerBean transformGroupContainer(CmsObject cms,
 CmsGroupContainerBean input,
 String rootPath)

Transforms a group container bean.

Parameters:

cms - the current CMS context

input - the input bean to be transformed

rootPath - the root path of the container page

Returns:

the transformed bean

transformContainerElement

protected CmsContainerElementBean transformContainerElement(CmsObject cms,
 CmsTemplateMapperConfiguration config,
 CmsContainerElementBean element)

Helper method to transform a single container element.

Parameters:

cms - the CMS context

config - the configuration

element - the container element to be transformed

Returns:

the transformed bean