org.ametys.runtime.model

Class AbstractModelItemParser

java.lang.Object

org.ametys.runtime.model.AbstractModelItemParser

Direct Known Subclasses:

CompositeDefinitionParser, ElementDefinitionParser, RepeaterDefinitionParser

public abstract class AbstractModelItemParser
extends Object

ModelItem parser from an XML configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractThreadSafeComponentExtensionPoint<? extends ModelItemType>	_modelItemTypeExtensionPoint The extension point to use to get available model items types

Constructor Summary

Constructors

Constructor and Description
AbstractModelItemParser(AbstractThreadSafeComponentExtensionPoint<? extends ModelItemType> modelItemTypeExtensionPoint) Creates a model item parser.

Method Summary

Modifier and Type	Method and Description
protected abstract ModelItem	_createModelItem(Configuration itemConfig) Create the model item to populate it.
protected String	_getNameConfigurationAttribute() Retrieves the name of the configuration attribute that contains the name of the model item
protected I18nizableText	_parseI18nizableText(Configuration config, String pluginName, String name) Parses an i18n text.
protected String	_parseName(Configuration itemConfig) Parses the name of the model item.
protected ModelItemType	_parseType(Configuration config) Parses the type.
ModelItem	parse(ServiceManager serviceManager, String pluginName, Configuration itemConfig, Model model, ModelItemGroup parent) Parses an element definition from a XML configuration.

Methods inherited from class java.lang.Object

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

Field Detail

_modelItemTypeExtensionPoint

protected AbstractThreadSafeComponentExtensionPoint<? extends ModelItemType> _modelItemTypeExtensionPoint

The extension point to use to get available model items types

Constructor Detail

AbstractModelItemParser

public AbstractModelItemParser(AbstractThreadSafeComponentExtensionPoint<? extends ModelItemType> modelItemTypeExtensionPoint)

Creates a model item parser.

Parameters:

modelItemTypeExtensionPoint - the extension point to use to get available model items types

Method Detail

parse

public ModelItem parse(ServiceManager serviceManager,
                       String pluginName,
                       Configuration itemConfig,
                       Model model,
                       ModelItemGroup parent)
                throws ConfigurationException

Parses an element definition from a XML configuration.

Parameters:

serviceManager - the service manager

pluginName - the plugin name declaring this item.

itemConfig - the XML configuration of the model item.

model - the model which defines the model item

parent - the parent of the model item to create. Can be null if the model item to parse has no parent

Returns:

the parsed model item.

Throws:

ConfigurationException - if the configuration is not valid.

_createModelItem

protected abstract ModelItem _createModelItem(Configuration itemConfig)
                                       throws ConfigurationException

Create the model item to populate it.

Parameters:

itemConfig - the model item configuration to use.

Returns:

the item instantiated.

Throws:

ConfigurationException - if the configuration is not valid.

_parseName

protected String _parseName(Configuration itemConfig)
                     throws ConfigurationException

Parses the name of the model item.

Parameters:

itemConfig - the model item configuration to use.

Returns:

the name of the model item.

Throws:

ConfigurationException - if the configuration is not valid.

_getNameConfigurationAttribute

protected String _getNameConfigurationAttribute()

Retrieves the name of the configuration attribute that contains the name of the model item

Returns:

the name of the configuration attribute that contains the name of the model item

_parseI18nizableText

protected I18nizableText _parseI18nizableText(Configuration config,
                                              String pluginName,
                                              String name)
                                       throws ConfigurationException

Parses an i18n text.

Parameters:

config - the configuration to use.

pluginName - the current plugin name.

name - the child name.

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

_parseType

protected ModelItemType _parseType(Configuration config)
                            throws ConfigurationException

Parses the type.

Parameters:

config - the model item configuration to use.

Returns:

the type.

Throws:

ConfigurationException - if the configuration is not valid.