Package org.ametys.cms.contenttype

Class ContentTypesParserHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.contenttype.ContentTypesParserHelper

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

public class ContentTypesParserHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Helper for content types parsing

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypesHelper	_contentTypesHelper	The content types helper
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ContentTypesParserHelper()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
String	getIconGlyphDefaultValue(String viewName, String mediumIcon)	Retrieves the default value for the view's icon glyph.
I18nizableText	parseI18nizableText(ModelHelper.ConfigurationAndPluginName configurationAndPluginName, String name)	Parse an i18n text.
I18nizableText	parseI18nizableText(ModelHelper.ConfigurationAndPluginName configurationAndPluginName, String name, String defaultValue)	Parse an i18n text.
I18nizableText	parseI18nizableText(ModelHelper.ConfigurationAndPluginName configurationAndPluginName, String name, I18nizableText defaultValue)	Parse an i18n text.
String	parseIcon(ContentTypeDescriptor contentType, Configuration configuration, String name)	Parse an icon path
String	parseIcon(ContentTypeDescriptor contentType, Configuration configuration, String name, String defaultValue)	Parse an icon path
View	parseView(ContentType contentType, ContentTypesHelper.ViewConfigurationsByType viewConfigurationsByType)	Parses the view of the given content type from the configurations
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper

Constructor Details

ContentTypesParserHelper

public ContentTypesParserHelper()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

parseView

public View parseView(ContentType contentType,
 ContentTypesHelper.ViewConfigurationsByType viewConfigurationsByType)
               throws ConfigurationException

Parses the view of the given content type from the configurations

Parameters:

contentType - the content type

viewConfigurationsByType - the view's configurations, indexed by the content types defining this view

Returns:

the parsed view

Throws:

ConfigurationException - if the configuration is invalid

parseI18nizableText

public I18nizableText parseI18nizableText(ModelHelper.ConfigurationAndPluginName configurationAndPluginName,
 String name)
                                   throws ConfigurationException

Parse an i18n text.

Parameters:

configurationAndPluginName - the configuration to use.

name - the child name.

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

parseI18nizableText

public I18nizableText parseI18nizableText(ModelHelper.ConfigurationAndPluginName configurationAndPluginName,
 String name,
 String defaultValue)
                                   throws ConfigurationException

Parse an i18n text.

Parameters:

configurationAndPluginName - the configuration to use.

name - the child name.

defaultValue - the default value if no present

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

parseI18nizableText

public I18nizableText parseI18nizableText(ModelHelper.ConfigurationAndPluginName configurationAndPluginName,
 String name,
 I18nizableText defaultValue)
                                   throws ConfigurationException

Parse an i18n text.

Parameters:

configurationAndPluginName - the configuration to use.

name - the child name.

defaultValue - the default value if no present

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

parseIcon

public String parseIcon(ContentTypeDescriptor contentType,
 Configuration configuration,
 String name)
                 throws ConfigurationException

Parse an icon path

Parameters:

contentType - the content type

configuration - the configuration to use

name - the child name.

Returns:

The icon path

Throws:

ConfigurationException - if the configuration is not valid.

parseIcon

public String parseIcon(ContentTypeDescriptor contentType,
 Configuration configuration,
 String name,
 String defaultValue)
                 throws ConfigurationException

Parse an icon path

Parameters:

contentType - the content type

configuration - the configuration to use

name - the child name.

defaultValue - the default value.

Returns:

The icon path

Throws:

ConfigurationException - if the configuration is not valid.

getIconGlyphDefaultValue

public String getIconGlyphDefaultValue(String viewName,
 String mediumIcon)

Retrieves the default value for the view's icon glyph. For all views, use medium icon or a default one. For some common views (main, abstract, link), a specific default icon is used

Parameters:

viewName - the name of the view

mediumIcon - the medium icon of the view

Returns:

the default value for the view's icon glyph.