Package org.ametys.web.parameters

Class ViewAndParametersParser

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.parameters.ViewAndParametersParser

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ViewAndParametersParser
extends AbstractLogEnabled
implements Component, Serviceable

Helper to parse parameters from configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewAndParametersParser.ViewAndParameters	The view and parameters object

Field Summary

Fields

Modifier and Type	Field	Description
protected ServiceManager	_manager	The service manager
static String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
ViewAndParametersParser()

Method Summary

Modifier and Type	Method	Description
protected void	_parseChildren(Configuration groupConfiguration, ViewItemGroup viewItemGroup, ModelItemGroup modelParent, String pluginName, String catalog, View view, Map<String,ModelItem> modelItems, Model model, ElementDefinitionParser elementDefinitionParser, RepeaterDefinitionParser repeaterDefinitionParser)	Parses children of a view item group
protected I18nizableText	_parseI18nizableText(Configuration config, String name, String pluginName, String catalog)	Parse an i18n text.
protected SimpleViewItemGroup	_parseSimpleViewItemGroup(Configuration groupConfiguration, ModelItemGroup modelParent, String pluginName, String catalog, View view, Map<String,ModelItem> modelItems, Model model, ElementDefinitionParser elementDefinitionParser, RepeaterDefinitionParser repeaterDefinitionParser)	Parses a simple view item group (group or fieldset)
ViewElement	parseParameter(Configuration paramConfiguration, ModelItemGroup parent, String pluginName, String catalog, View view, Map<String,ModelItem> modelItems, Model model, ElementDefinitionParser elementDefinitionParser, RepeaterDefinitionParser repeaterDefinitionParser)	Parses a service parameter
ViewAndParametersParser.ViewAndParameters	parseParameters(Configuration parametersConfiguration, String pluginName, String catalog, Model model, ElementDefinitionParser elementDefinitionParser, RepeaterDefinitionParser repeaterDefinitionParser)	Parse the configuration to get parameters.
ModelViewItemGroup	parseRepeater(Configuration repeaterConfiguration, ModelItemGroup parent, String pluginName, String catalog, View view, Map<String,ModelItem> modelItems, Model model, ElementDefinitionParser elementDefinitionParser, RepeaterDefinitionParser repeaterDefinitionParser)	Parses a repeater
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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

_manager

protected ServiceManager _manager

The service manager

Constructor Detail

ViewAndParametersParser

public ViewAndParametersParser()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

parseParameters

public ViewAndParametersParser.ViewAndParameters parseParameters(Configuration parametersConfiguration,
                                                                 String pluginName,
                                                                 String catalog,
                                                                 Model model,
                                                                 ElementDefinitionParser elementDefinitionParser,
                                                                 RepeaterDefinitionParser repeaterDefinitionParser)
                                                          throws ConfigurationException

Parse the configuration to get parameters.

Parameters:

parametersConfiguration - the parameters configuration.

pluginName - the plugin name

catalog - the catalog

model - the model

elementDefinitionParser - the element definition parser

repeaterDefinitionParser - the repeater definition parser

Returns:

the parameters

Throws:

ConfigurationException - if an error occurs.

_parseSimpleViewItemGroup

protected SimpleViewItemGroup _parseSimpleViewItemGroup(Configuration groupConfiguration,
                                                        ModelItemGroup modelParent,
                                                        String pluginName,
                                                        String catalog,
                                                        View view,
                                                        Map<String,ModelItem> modelItems,
                                                        Model model,
                                                        ElementDefinitionParser elementDefinitionParser,
                                                        RepeaterDefinitionParser repeaterDefinitionParser)
                                                 throws ConfigurationException

Parses a simple view item group (group or fieldset)

Parameters:

groupConfiguration - the item group configuration

modelParent - The last model item group to use as parent for next definitions

pluginName - the plugin name

catalog - the catalog

view - the view

modelItems - the map of model items

model - the model

elementDefinitionParser - the element definition parser

repeaterDefinitionParser - the repeater definition parser

Returns:

the parsed simple view item group

Throws:

ConfigurationException - if an error occurs

parseParameter

public ViewElement parseParameter(Configuration paramConfiguration,
                                  ModelItemGroup parent,
                                  String pluginName,
                                  String catalog,
                                  View view,
                                  Map<String,ModelItem> modelItems,
                                  Model model,
                                  ElementDefinitionParser elementDefinitionParser,
                                  RepeaterDefinitionParser repeaterDefinitionParser)
                           throws ConfigurationException

Parses a service parameter

Parameters:

paramConfiguration - the parameter configuration

parent - the parent of the service parameter. Can be null if the parameter has no parent

pluginName - the plugin name

catalog - the catalog

view - the view

modelItems - the map of model item

model - the model

elementDefinitionParser - the element definition parser

repeaterDefinitionParser - the repeater definition parser

Returns:

the parsed parameter

Throws:

ConfigurationException - if an error occurs

parseRepeater

public ModelViewItemGroup parseRepeater(Configuration repeaterConfiguration,
                                        ModelItemGroup parent,
                                        String pluginName,
                                        String catalog,
                                        View view,
                                        Map<String,ModelItem> modelItems,
                                        Model model,
                                        ElementDefinitionParser elementDefinitionParser,
                                        RepeaterDefinitionParser repeaterDefinitionParser)
                                 throws ConfigurationException

Parses a repeater

Parameters:

repeaterConfiguration - the repeater configuration

parent - the parent of the repeater. Can be null if the repeater has no parent

pluginName - the plugin name

catalog - the catalog

view - the view

modelItems - the map of model item

model - the model

elementDefinitionParser - the element definition parser

repeaterDefinitionParser - the repeater definition parser

Returns:

the parsed repeater

Throws:

ConfigurationException - if an error occurs

_parseChildren

protected void _parseChildren(Configuration groupConfiguration,
                              ViewItemGroup viewItemGroup,
                              ModelItemGroup modelParent,
                              String pluginName,
                              String catalog,
                              View view,
                              Map<String,ModelItem> modelItems,
                              Model model,
                              ElementDefinitionParser elementDefinitionParser,
                              RepeaterDefinitionParser repeaterDefinitionParser)
                       throws ConfigurationException

Parses children of a view item group

Parameters:

groupConfiguration - the item group configuration

viewItemGroup - the item group

modelParent - The last model item group to use as parent for next definitions

pluginName - the plugin name

catalog - the catalog

view - the view

modelItems - the map of model items

model - the model

elementDefinitionParser - the element definition parser

repeaterDefinitionParser - the repeater definition parser

Throws:

ConfigurationException - if an error occurs

_parseI18nizableText

protected I18nizableText _parseI18nizableText(Configuration config,
                                              String name,
                                              String pluginName,
                                              String catalog)

Parse an i18n text.

Parameters:

config - the configuration to use.

name - the child name.

pluginName - the plugin name

catalog - the catalog

Returns:

the i18n text.