Package org.ametys.web.skin

Class SkinParametersModel

java.lang.Object

org.ametys.web.skin.SkinParametersModel

All Implemented Interfaces:

Model, ModelItemAccessor, ModelItemContainer

public class SkinParametersModel
extends Object
implements Model

Model for Skin (do not mistake this with SkinModel )

Field Summary

Fields

Modifier and Type	Field	Description
private Context	_context
private ServiceManager	_manager
private List<ElementDefinition>	_parameters
private List<CategorizedElementDefinitionWrapper>	_parameterWrappers
private Path	_skinDir
private String	_skinName
private AbstractThreadSafeComponentExtensionPoint<? extends ElementType>	_skinParameterTypeEP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private Configuration	_getConfigurationModel(Path skinDir)
private void	_initialize()
private List<CategorizedElementDefinitionWrapper>	_readSkinParameters()	Read the CategorizedElementDefinitionWrapper from the skin directory
String	getFamilyId()	Retrieves the Family Id (for example the extension point) Each model Id have to be unique in it's family Id
String	getId()	Retrieves the model id (an id must be unique in the family Model.getFamilyId()
ElementDefinition	getModelItem(String itemPath)	Retrieves the model item at given path
Collection<ElementDefinition>	getModelItems()	Retrieves all the model items of this accessor
View	getView()	Retrieves the view of skin parameters

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.ModelItemAccessor

getChild, hasModelItem

Field Detail

_skinName

private String _skinName

_skinDir

private Path _skinDir

_skinParameterTypeEP

private AbstractThreadSafeComponentExtensionPoint<? extends ElementType> _skinParameterTypeEP

_context

private Context _context

_manager

private ServiceManager _manager

_parameterWrappers

private List<CategorizedElementDefinitionWrapper> _parameterWrappers

_parameters

private List<ElementDefinition> _parameters

Constructor Detail

SkinParametersModel

public SkinParametersModel(String skinName,
                           Path 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

getModelItems

public Collection<ElementDefinition> getModelItems()

Description copied from interface: ModelItemAccessor

Retrieves all the model items of this accessor

Specified by:

getModelItems in interface ModelItemAccessor

Returns:

the model items

getModelItem

public ElementDefinition getModelItem(String itemPath)
                               throws UndefinedItemPathException

Description copied from interface: ModelItemAccessor

Retrieves the model item at given path

Specified by:

getModelItem in interface ModelItemAccessor

Parameters:

itemPath - the item path

Returns:

the model item.

Throws:

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

getView

public View getView()

Retrieves the view of skin parameters

Returns:

the skin parameters' view

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)

_initialize

private void _initialize()
                  throws ProcessingException

Throws:

ProcessingException

_readSkinParameters

private List<CategorizedElementDefinitionWrapper> _readSkinParameters()
                                                               throws ProcessingException

Read the CategorizedElementDefinitionWrapper from the skin directory

Returns:

a list of CategorizedElementDefinitionWrapper

Throws:

ProcessingException - error while reading the XML

_getConfigurationModel

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

Throws:

ConfigurationException

SAXException

IOException