org.ametys.web.skin

Class SkinParametersModel

java.lang.Object

org.ametys.web.skin.SkinParametersModel

All Implemented Interfaces:

Model, ModelItemContainer

public class SkinParametersModel
extends Object
implements Model

Model for Skin (do not mistake this with SkinModel )

Field Summary

Fields

Modifier and Type	Field and Description
private Context	_context
private Map<String,ElementDefinition>	_flatDefinitions
private ServiceManager	_manager
private List<ModelItem>	_modelItems
private File	_skinDir
private String	_skinName
private AbstractThreadSafeComponentExtensionPoint<? extends ElementType>	_skinParameterTypeEP
private List<CategorizedElementDefinitionProxy>	_skinParams

Constructor Summary

Constructors

Constructor and Description
SkinParametersModel(String skinName, File skinDir, SkinParameterTypeExtensionPoint skinParameterTypeEP, Context context, ServiceManager manager) Create an instance of a model, based on the skin directory

Method Summary

Modifier and Type	Method and Description
private Configuration	_getConfigurationModel(File skinDir)
private List<CategorizedElementDefinitionProxy>	_getParameters() Read the CategorizedElementDefinitionProxy from the skin dir
private void	_initialize()
String	getFamilyId() Retrieves the Family Id (for example the extension point) Each model Id have to be unique in it's family Id
Map<String,ElementDefinition>	getFlatDefinitions() Get a flat map of ElementDefinition
String	getId() Retrieves the model id (an id must be unique in the family Model.getFamilyId()
ModelItem	getModelItem(String itemPath) Retrieves the model item at given path
Collection<? extends ModelItem>	getModelItems() Retrieves all the model items of this container

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.ModelItemContainer

getChild, hasModelItem

Field Detail

_skinName

private String _skinName

_skinDir

private File _skinDir

_skinParameterTypeEP

private AbstractThreadSafeComponentExtensionPoint<? extends ElementType> _skinParameterTypeEP

_context

private Context _context

_manager

private ServiceManager _manager

_modelItems

private List<ModelItem> _modelItems

_flatDefinitions

private Map<String,ElementDefinition> _flatDefinitions

_skinParams

private List<CategorizedElementDefinitionProxy> _skinParams

Constructor Detail

SkinParametersModel

public SkinParametersModel(String skinName,
                           File skinDir,
                           SkinParameterTypeExtensionPoint skinParameterTypeEP,
                           Context context,
                           ServiceManager manager)
                    throws ProcessingException

Create an instance of a model, based on the skin directory

Parameters:

skinName - name of the skin (must be unique)

skinDir - the skin directory where the configuration will be read

skinParameterTypeEP - the skin parameter type extension point

context - the current context

manager - the service manager

Throws:

ProcessingException - something went wrong while parsing the file

Method Detail

getModelItem

public ModelItem getModelItem(String itemPath)
                       throws UndefinedItemPathException

Description copied from interface: ModelItemContainer

Retrieves the model item at given path

Specified by:

getModelItem in interface ModelItemContainer

Parameters:

itemPath - the item path

Returns:

the model item.

Throws:

UndefinedItemPathException - if there is no item defined at the given path

getModelItems

public Collection<? extends ModelItem> getModelItems()

Description copied from interface: ModelItemContainer

Retrieves all the model items of this container

Specified by:

getModelItems in interface ModelItemContainer

Returns:

the model items

getId

public String getId()

Description copied from interface: Model

Retrieves the model id (an id must be unique in the family Model.getFamilyId()

Specified by:

getId in interface Model

Returns:

model id (for example the content type id for a content)

getFamilyId

public String getFamilyId()

Description copied from interface: Model

Retrieves the Family Id (for example the extension point) Each model Id have to be unique in it's family Id

Specified by:

getFamilyId in interface Model

Returns:

content point (for example "org.ametys.cms.contenttype.ContentTypeExtensionPoint" for a content)

getFlatDefinitions

public Map<String,ElementDefinition> getFlatDefinitions()
                                                 throws ProcessingException

Get a flat map of ElementDefinition

Returns:

a flat map of ElementDefinition

Throws:

ProcessingException - something went wrong when reading the configuration file

_initialize

private void _initialize()
                  throws ProcessingException

Throws:

ProcessingException

_getParameters

private List<CategorizedElementDefinitionProxy> _getParameters()
                                                        throws ProcessingException

Read the CategorizedElementDefinitionProxy from the skin dir

Returns:

a list of CategorizedElementDefinitionProxy

Throws:

ProcessingException - error while reading the XML

_getConfigurationModel

private Configuration _getConfigurationModel(File skinDir)
                                      throws ConfigurationException,
                                             SAXException,
                                             IOException

Throws:

ConfigurationException

SAXException

IOException