org.ametys.web.skin

Class SkinModelsManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.skin.SkinModelsManager

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable, ThreadSafe

public class SkinModelsManager
extends AbstractLogEnabled
implements ThreadSafe, Serviceable, Component, Contextualizable

Manages the models of skin

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_cocoonContext Cocoon context
protected Context	_context Avalon context
protected ServiceManager	_manager The avalon service manager
protected Map<String,SkinModel>	_models The set of templates classified by skins
protected SkinsManager	_skinsManager The sites manager
protected SourceResolver	_sourceResolver The excalibur source resolver
static String	ROLE The avalon role name

Constructor Summary

Constructors

Constructor and Description
SkinModelsManager()

Method Summary

Modifier and Type	Method and Description
private String	_getModelLocation(String id) Get the model location
private boolean	_modelExists(File modelDir)
void	contextualize(Context context)
void	generateModelFile(File skinDir, String modelId) Generates the model.xml file for the skin
void	generateModelFile(File skinDir, String modelId, String colorTheme) Generates the model.xml file for the skin
SkinModel	getModel(String id) Get a model
String	getModelHash(String id) Get hash from model
String	getModelOfSkin(Skin skin) Get the id of model associated to a skin
Set<String>	getModels() Get the list of existing models
String	getModelsLocation() Get the skins location
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 Detail

ROLE

public static final String ROLE

The avalon role name

_models

protected Map<String,SkinModel> _models

The set of templates classified by skins

_manager

protected ServiceManager _manager

The avalon service manager

_sourceResolver

protected SourceResolver _sourceResolver

The excalibur source resolver

_skinsManager

protected SkinsManager _skinsManager

The sites manager

_context

protected Context _context

Avalon context

_cocoonContext

protected Context _cocoonContext

Cocoon context

Constructor Detail

SkinModelsManager

public SkinModelsManager()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getModels

public Set<String> getModels()
                      throws ProcessingException

Get the list of existing models

Returns:

A set of model names. Can be null if there is an error.

Throws:

ProcessingException - if an error occurs

getModel

public SkinModel getModel(String id)

Get a model

Parameters:

id - The id of the model

Returns:

The model or null if the model does not exists

getModelOfSkin

public String getModelOfSkin(Skin skin)

Get the id of model associated to a skin

Parameters:

skin - The skin

Returns:

The id of the model or null if there is no model for this skin

getModelHash

public String getModelHash(String id)

Get hash from model

Parameters:

id - The id of the model

Returns:

unique has

generateModelFile

public void generateModelFile(File skinDir,
                              String modelId,
                              String colorTheme)
                       throws IOException,
                              SAXException,
                              TransformerConfigurationException

Generates the model.xml file for the skin

Parameters:

skinDir - The skin directory

modelId - The model id

colorTheme - The id of color theme. Can be null.

Throws:

IOException - if an I/O exception occurs during generation

SAXException - if an error occurs during generation

TransformerConfigurationException - if an error occurs during generation

generateModelFile

public void generateModelFile(File skinDir,
                              String modelId)
                       throws IOException,
                              SAXException,
                              TransformerConfigurationException

Generates the model.xml file for the skin

Parameters:

skinDir - The skin directory

modelId - The model id

Throws:

IOException - if an I/O exception occurs during generation

SAXException - if an error occurs during generation

TransformerConfigurationException - if an error occurs during generation

getModelsLocation

public String getModelsLocation()

Get the skins location

Returns:

the skin location

_getModelLocation

private String _getModelLocation(String id)

Get the model location

Parameters:

id - The id of the model

Returns:

the model location

_modelExists

private boolean _modelExists(File modelDir)