org.ametys.skinfactory

Class SkinFactoryComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.skinfactory.SkinFactoryComponent

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe

public class SkinFactoryComponent
extends AbstractLogEnabled
implements Component, ThreadSafe, Serviceable

Manager for skin parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	SkinFactoryComponent.SkinDirectoryFilter

Field Summary

Fields

Modifier and Type	Field and Description
private static Pattern	__I18N_CATALOG_LANGUAGE
private Map<String,String>	_modelsHash
private SkinModelsManager	_modelsManager
private Map<String,Map<String,AbstractSkinParameter>>	_modelsParameters
private SourceResolver	_resolver
static Pattern	CSS_PARAM_PATTERN Pattern for CSS parameters.
static Pattern	I18N_PARAM_PATTERN Pattern for i18n text parameters.
static String	ROLE Avalon role
static Pattern	TXT_PARAM_PATTERN Pattern for text parameters.

Constructor Summary

Constructors

Constructor and Description
SkinFactoryComponent()

Method Summary

Modifier and Type	Method and Description
private I18nizableText	_configureI18nizableText(Configuration configuration, String modelName)
private void	_configureImage(File imageFile, ImageParameter param, String modelName)
private void	_configureVariant(File variantFile, VariantParameter param, String modelName)
private void	_findImagesParameters(File modelDir, File imagesDir, File file, Map<String,ImageParameter> params, String modelName)
private void	_findVariantsParameters(File variantsDir, Map<String,VariantParameter> params, String modelName)
private String	_getCatalogLanguage(String string, String fileName)
private Map<String,CSSParameter>	_getCSSParameters(File modelDir, String modelName)
private Map<String,String>	_getI18nOtherDefaultValues(File defaultCatalog, String i18nKey)
private Map<String,I18nizableTextParameter>	_getI18nTextParameters(File modelDir, String modelName)
private Map<String,ImageParameter>	_getImageParameters(File modelDir, String modelName)
private Map<String,TextParameter>	_getTextParameters(File modelDir, String modelName)
private Object	_getValue(SkinModel model, AbstractSkinParameter param, Map<String,Object> values, Map<String,String> defaultValues)
private Map<String,VariantParameter>	_getVariantParameters(File modelDir, String modelName)
private List<Variant>	_getVariantValues(File variant, String modelName)
private List<File>	_listCSSFiles(File file)
private List<File>	_listXSLFiles(File file)
private void	_parseCSSFile(Map<String,CSSParameter> cssParams, String modelName, File cssFile)
private Map<String,I18nizableTextParameter>	_parseI18nFile(String skinName, File i18nFile)
private I18nizableText	_parseI18nizableText(String label, String modelName)
private Map<String,TextParameter>	_parseXSLFile(String skinName, File xslFile)
void	applyColorTheme(String modelName, File skinDir) Apply new color theme
void	applyModelParameters(String modelName, File skinDir) Apply model parameters in given skin
void	applyModelParameters(String modelName, File skinDir, Map<String,Object> values) Apply model parameters in given skin
void	applyParameter(AbstractSkinParameter parameter, File skinDir, String modelName, Object value, String lang) Apply parameter
void	clearModelsParametersCache() Remove all model parameters from cache
String	getColorTheme(File skinDir) Get the current theme
AbstractSkinParameter	getModelParamater(String modelName, String paramId) Get the skin parameter of the given model
Map<String,AbstractSkinParameter>	getModelParameters(String modelName) Get the skin parameters of a model
Object	getParameterValue(File skinDir, String modelName, String id) Get the parameter's value
Map<String,Object>	getParameterValues(File skinDir, String modelName) Get all parameters' values
Map<String,Object>	getParameterValues(File skinDir, String modelName, List<String> ids) Get the parameters' values
boolean	isModelUpToDate(String modelName) Determines if the model was changed
boolean	saveColorTheme(File skinDir, String themeId) Modify the color theme
boolean	saveParameter(File skinDir, String id, Object value) Modify a skin parameter's value
boolean	saveParameters(File skinDir, Map<String,Object> parameters) Save skin parameters
void	service(ServiceManager smanager)
void	updateHash(File xmlFile, String hash) Update hash

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 Detail

ROLE

public static final String ROLE

Avalon role

CSS_PARAM_PATTERN

public static final Pattern CSS_PARAM_PATTERN

Pattern for CSS parameters. E.g: color: #EEEEEE /* AMETYS("myuniqueid", "Label", DESCRIPTION_I18N_KEY) *\/;

I18N_PARAM_PATTERN

public static final Pattern I18N_PARAM_PATTERN

Pattern for i18n text parameters. E.g: <message key="SKIN_TITLE">Ametys, Web Java Open Source CMS<!-- Ametys("text.i18n.site.title", "Titre du site") --></message>

TXT_PARAM_PATTERN

public static final Pattern TXT_PARAM_PATTERN

Pattern for text parameters. E.g: <xsl:variable name="foo">test<!-- Ametys("variable.foo", "Foo", "Foo") --></xsl:variable>

__I18N_CATALOG_LANGUAGE

private static final Pattern __I18N_CATALOG_LANGUAGE

_modelsParameters

private final Map<String,Map<String,AbstractSkinParameter>> _modelsParameters

_modelsHash

private final Map<String,String> _modelsHash

_modelsManager

private SkinModelsManager _modelsManager

_resolver

private SourceResolver _resolver

Constructor Detail

SkinFactoryComponent

public SkinFactoryComponent()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

clearModelsParametersCache

public void clearModelsParametersCache()

Remove all model parameters from cache

getModelParamater

public AbstractSkinParameter getModelParamater(String modelName,
                                               String paramId)

Get the skin parameter of the given model

Parameters:

modelName - The model name

paramId - The id of the parameter

Returns:

The skin parameter or null if it doesn't exist

isModelUpToDate

public boolean isModelUpToDate(String modelName)

Determines if the model was changed

Parameters:

modelName - The model name

Returns:

true if the model was changed

getModelParameters

public Map<String,AbstractSkinParameter> getModelParameters(String modelName)

Get the skin parameters of a model

Parameters:

modelName - the model name

Returns:

skin parameters in a List

_getVariantParameters

private Map<String,VariantParameter> _getVariantParameters(File modelDir,
                                                           String modelName)

_findVariantsParameters

private void _findVariantsParameters(File variantsDir,
                                     Map<String,VariantParameter> params,
                                     String modelName)

_getVariantValues

private List<Variant> _getVariantValues(File variant,
                                        String modelName)

_configureVariant

private void _configureVariant(File variantFile,
                               VariantParameter param,
                               String modelName)

_getImageParameters

private Map<String,ImageParameter> _getImageParameters(File modelDir,
                                                       String modelName)

_findImagesParameters

private void _findImagesParameters(File modelDir,
                                   File imagesDir,
                                   File file,
                                   Map<String,ImageParameter> params,
                                   String modelName)

_configureImage

private void _configureImage(File imageFile,
                             ImageParameter param,
                             String modelName)

_getCSSParameters

private Map<String,CSSParameter> _getCSSParameters(File modelDir,
                                                   String modelName)

_listCSSFiles

private List<File> _listCSSFiles(File file)

_parseCSSFile

private void _parseCSSFile(Map<String,CSSParameter> cssParams,
                           String modelName,
                           File cssFile)

_getTextParameters

private Map<String,TextParameter> _getTextParameters(File modelDir,
                                                     String modelName)

_listXSLFiles

private List<File> _listXSLFiles(File file)

_parseXSLFile

private Map<String,TextParameter> _parseXSLFile(String skinName,
                                                File xslFile)

_getI18nTextParameters

private Map<String,I18nizableTextParameter> _getI18nTextParameters(File modelDir,
                                                                   String modelName)

_parseI18nFile

private Map<String,I18nizableTextParameter> _parseI18nFile(String skinName,
                                                           File i18nFile)

_getCatalogLanguage

private String _getCatalogLanguage(String string,
                                   String fileName)

_getI18nOtherDefaultValues

private Map<String,String> _getI18nOtherDefaultValues(File defaultCatalog,
                                                      String i18nKey)

_parseI18nizableText

private I18nizableText _parseI18nizableText(String label,
                                            String modelName)

getParameterValue

public Object getParameterValue(File skinDir,
                                String modelName,
                                String id)

Get the parameter's value

Parameters:

skinDir - The skin directory (could be in temp, work or skin)

modelName - The model name

id - The parameter id

Returns:

The parameter's value

getParameterValues

public Map<String,Object> getParameterValues(File skinDir,
                                             String modelName,
                                             List<String> ids)

Get the parameters' values

Parameters:

skinDir - The skin directory (could be in temp, work or skin)

modelName - The model name

ids - The parameters' id

Returns:

The parameters' values

getColorTheme

public String getColorTheme(File skinDir)

Get the current theme

Parameters:

skinDir - The skin directory (could be in temp, work or skin)

Returns:

The current theme id

getParameterValues

public Map<String,Object> getParameterValues(File skinDir,
                                             String modelName)

Get all parameters' values

Parameters:

skinDir - The skin directory (could be in temp, work or skin)

modelName - The model name

Returns:

The all parameters' values

saveColorTheme

public boolean saveColorTheme(File skinDir,
                              String themeId)

Modify the color theme

Parameters:

skinDir - The skin directory (could be in temp, work or skin)

themeId - The id of the theme. Can be null to clear theme.

Returns:

true is modification success

saveParameter

public boolean saveParameter(File skinDir,
                             String id,
                             Object value)

Modify a skin parameter's value

Parameters:

skinDir - The skin directory (could be in temp, work or skin)

id - the id of the parameter

value - the new value

Returns:

true is modification success

saveParameters

public boolean saveParameters(File skinDir,
                              Map<String,Object> parameters)

Save skin parameters

Parameters:

skinDir - The skin directory (could be in temp, work or skin)

parameters - The skins parameters to save

Returns:

true is modification success

applyModelParameters

public void applyModelParameters(String modelName,
                                 File skinDir)

Apply model parameters in given skin

Parameters:

modelName - The model name

skinDir - The skin directory (could be temp, work or skins)

applyModelParameters

public void applyModelParameters(String modelName,
                                 File skinDir,
                                 Map<String,Object> values)

Apply model parameters in given skin

Parameters:

modelName - The model name

skinDir - The skin directory

values - The values to set

_getValue

private Object _getValue(SkinModel model,
                         AbstractSkinParameter param,
                         Map<String,Object> values,
                         Map<String,String> defaultValues)

updateHash

public void updateHash(File xmlFile,
                       String hash)
                throws IOException

Update hash

Parameters:

xmlFile - the xml File

hash - the new hash of the file

Throws:

IOException - if an error occurs while manipulating the file

applyParameter

public void applyParameter(AbstractSkinParameter parameter,
                           File skinDir,
                           String modelName,
                           Object value,
                           String lang)

Apply parameter

Parameters:

parameter - the skin parameter

skinDir - the skin directory (could be temp, work or skins)

modelName - the model name

value - the parameter value

lang - The language

applyColorTheme

public void applyColorTheme(String modelName,
                            File skinDir)

Apply new color theme

Parameters:

skinDir - the skin directory (could be temp, work or skins)

modelName - the model name

_configureI18nizableText

private I18nizableText _configureI18nizableText(Configuration configuration,
                                                String modelName)
                                         throws ConfigurationException

Throws:

ConfigurationException