org.ametys.web.service

Class ServiceParameterDefinitionParser

java.lang.Object

org.ametys.runtime.model.AbstractModelItemParser

org.ametys.runtime.model.ElementDefinitionParser

org.ametys.web.service.ServiceParameterDefinitionParser

public class ServiceParameterDefinitionParser
extends ElementDefinitionParser

This class parses the service parameter definition

Field Summary

Fields inherited from class org.ametys.runtime.model.AbstractModelItemParser

_modelItemTypeExtensionPoint

Constructor Summary

Constructors

Constructor and Description
ServiceParameterDefinitionParser(ServiceParameterTypeExtensionPoint serviceParameterTypeExtensionPoint, ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager) Creates a service parameter definition parser.

Method Summary

Modifier and Type	Method and Description
protected ServiceParameter	_createModelItem(Configuration definitionConfig) Create the model item to populate it.
protected String	_parseName(Configuration definitionConfig) Parses the name of the model item.
ServiceParameter	parse(ServiceManager serviceManager, String pluginName, Configuration definitionConfig, Model model, ModelItemGroup parent) Parses an element definition from a XML configuration.

Methods inherited from class org.ametys.runtime.model.ElementDefinitionParser

_parseAndSetEnumerator, _parseAndSetValidator, _parseDefaultValue, _parseDisableConditions, _parseMultiple, _parseWidget, _parseWidgetParameters, lookupComponents

Methods inherited from class org.ametys.runtime.model.AbstractModelItemParser

_getNameConfigurationAttribute, _parseI18nizableText, _parseType

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceParameterDefinitionParser

public ServiceParameterDefinitionParser(ServiceParameterTypeExtensionPoint serviceParameterTypeExtensionPoint,
                                        ThreadSafeComponentManager<Enumerator> enumeratorManager,
                                        ThreadSafeComponentManager<Validator> validatorManager)

Creates a service parameter definition parser.

Parameters:

serviceParameterTypeExtensionPoint - the extension point to use to get available element types

enumeratorManager - the enumerator component manager.

validatorManager - the validator component manager.

Method Detail

parse

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

Description copied from class: AbstractModelItemParser

Parses an element definition from a XML configuration.

Overrides:

parse in class ElementDefinitionParser

Parameters:

serviceManager - the service manager

pluginName - the plugin name declaring this item.

definitionConfig - 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 ServiceParameter _createModelItem(Configuration definitionConfig)
                                     throws ConfigurationException

Description copied from class: AbstractModelItemParser

Create the model item to populate it.

Overrides:

_createModelItem in class ElementDefinitionParser

Parameters:

definitionConfig - the model item configuration to use.

Returns:

the item instantiated.

Throws:

ConfigurationException - if the configuration is not valid.

_parseName

protected String _parseName(Configuration definitionConfig)
                     throws ConfigurationException

Description copied from class: AbstractModelItemParser

Parses the name of the model item.

Overrides:

_parseName in class AbstractModelItemParser

Parameters:

definitionConfig - the model item configuration to use.

Returns:

the name of the model item.

Throws:

ConfigurationException - if the configuration is not valid.