Package org.ametys.runtime.model

Class ItemParserHelper

java.lang.Object

org.ametys.runtime.model.ItemParserHelper

public final class ItemParserHelper
extends Object

Helper for all ModelItem parsers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ItemParserHelper.ConfigurationAndPluginName	Stores a configuration and the name of the plugin in which is declared the configuration
static interface	ItemParserHelper.DefaultValueParser	Default value parser

Method Summary

Modifier and Type	Method	Description
static Object	parseDefaultValue(Configuration defaultValueConfig, ElementDefinition definition, String defaultValueType)	Parses the default value.
static List<Pair<String,Object>>	parseDefaultValues(Configuration itemConfig, ElementDefinition definition, ItemParserHelper.DefaultValueParser defaultValueParser)	Parses the default values.
static I18nizableText	parseI18nizableText(ItemParserHelper.ConfigurationAndPluginName configurationAndPluginName, String name)	Parse an i18n text.
static I18nizableText	parseI18nizableText(ItemParserHelper.ConfigurationAndPluginName configurationAndPluginName, String name, String defaultValue)	Parse an i18n text.
static I18nizableText	parseI18nizableText(ItemParserHelper.ConfigurationAndPluginName configurationAndPluginName, String name, I18nizableText defaultValue)	Parse an i18n text.
static Boolean	parseMultiple(Configuration itemConfig)	Parses the multiple attribute.
static String	parseName(Configuration itemConfig, String nameConfigurationAttribute)	Parses the name of the model item
static String	parseName(Configuration itemConfig, String nameConfigurationAttribute, boolean acceptDots)	Parses the name of the model item
static String	parseWidget(Configuration itemConfig)	Parses the widget.
static Map<String,I18nizableText>	parseWidgetParameters(Configuration itemConfig, String pluginName)	Parses the widget's parameters

Methods inherited from class java.lang.Object

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

Method Details

parseName

public static String parseName(Configuration itemConfig,
 String nameConfigurationAttribute)
                        throws ConfigurationException

Parses the name of the model item

Parameters:

itemConfig - the model item's configuration to parse

nameConfigurationAttribute - the name of the attribute containing the item's name

Returns:

the name of the model item

Throws:

ConfigurationException - if an error occurs

parseName

public static String parseName(Configuration itemConfig,
 String nameConfigurationAttribute,
 boolean acceptDots)
                        throws ConfigurationException

Parses the name of the model item

Parameters:

itemConfig - the model item's configuration to parse

nameConfigurationAttribute - the name of the attribute containing the item's name

acceptDots - true if the name to parse can contain dots, false otherwise

Returns:

the name of the model item

Throws:

ConfigurationException - if an error occurs

parseMultiple

public static Boolean parseMultiple(Configuration itemConfig)
                             throws ConfigurationException

Parses the multiple attribute.

Parameters:

itemConfig - the item configuration to use.

Returns:

true if the item is multiple, false otherwise.

Throws:

ConfigurationException - if the configuration is not valid.

parseDefaultValues

public static List<Pair<String,Object>> parseDefaultValues(Configuration itemConfig,
 ElementDefinition definition,
 ItemParserHelper.DefaultValueParser defaultValueParser)
                                                    throws ConfigurationException

Parses the default values.

Parameters:

itemConfig - the item configuration.

definition - the element definition.

defaultValueParser - The ItemParserHelper.DefaultValueParser to use to parse single default values

Returns:

the default values and their types or null if none default value is defined.

Throws:

ConfigurationException - if the configuration is not valid.

parseDefaultValue

public static Object parseDefaultValue(Configuration defaultValueConfig,
 ElementDefinition definition,
 String defaultValueType)
                                throws ConfigurationException

Parses the default value.

Parameters:

defaultValueConfig - the default value configuration.

definition - the element definition.

defaultValueType - the type of the default value

Returns:

the default value or null if none default value is defined.

Throws:

ConfigurationException - if the configuration is not valid.

parseWidget

public static String parseWidget(Configuration itemConfig)
                          throws ConfigurationException

Parses the widget.

Parameters:

itemConfig - the item configuration to use.

Returns:

the widget or null if none defined.

Throws:

ConfigurationException - if the configuration is not valid.

parseWidgetParameters

public static Map<String,I18nizableText> parseWidgetParameters(Configuration itemConfig,
 String pluginName)
                                                        throws ConfigurationException

Parses the widget's parameters

Parameters:

itemConfig - the item configuration to use.

pluginName - the current plugin name.

Returns:

the widget's parameters in a Map

Throws:

ConfigurationException - if the configuration is not valid.

parseI18nizableText

public static I18nizableText parseI18nizableText(ItemParserHelper.ConfigurationAndPluginName configurationAndPluginName,
 String name)
                                          throws ConfigurationException

Parse an i18n text.

Parameters:

configurationAndPluginName - the configuration to use.

name - the child name.

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

parseI18nizableText

public static I18nizableText parseI18nizableText(ItemParserHelper.ConfigurationAndPluginName configurationAndPluginName,
 String name,
 String defaultValue)
                                          throws ConfigurationException

Parse an i18n text.

Parameters:

configurationAndPluginName - the configuration to use.

name - the child name.

defaultValue - the default value if no present

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

parseI18nizableText

public static I18nizableText parseI18nizableText(ItemParserHelper.ConfigurationAndPluginName configurationAndPluginName,
 String name,
 I18nizableText defaultValue)
                                          throws ConfigurationException

Parse an i18n text.

Parameters:

configurationAndPluginName - the configuration to use.

name - the child name.

defaultValue - the default value if no present

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.