org.ametys.cms.contenttype

Class DefaultContentType.MetadataAndRepeaterDefinitionParser

java.lang.Object

org.ametys.runtime.parameter.AbstractParameterParser<MetadataDefinition,MetadataType>

org.ametys.cms.contenttype.DefaultContentType.MetadataAndRepeaterDefinitionParser

Enclosing class:

DefaultContentType

protected class DefaultContentType.MetadataAndRepeaterDefinitionParser
extends AbstractParameterParser<MetadataDefinition,MetadataType>

DefaultContentType.RestrictedMetadataDefinition and DefaultContentType.RestrictedRepeaterDefinition parser.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_parentPrefix Parent prefix.

Fields inherited from class org.ametys.runtime.parameter.AbstractParameterParser

_enumeratorManager, _validatorManager

Constructor Summary

Constructors

Constructor and Description
MetadataAndRepeaterDefinitionParser(ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager) Creates an DefaultContentType.MetadataAndRepeaterDefinitionParser.

Method Summary

Modifier and Type	Method and Description
protected void	_additionalParsing(ServiceManager manager, String pluginName, Configuration metadataConfiguration, String metadataId, MetadataDefinition metadataDefinition) Called for additional parsing. Default implementation does nothing.
protected MetadataDefinition	_createParameter(Configuration metadataConfiguration) Create the parameter to populate it.
protected Pattern	_getAnnotationNamePattern() Get the annotation name pattern to test validity.
protected boolean	_parseAccessType(Configuration configuration) Parses type attribute from a configuration.
protected void	_parseContentRelations(Configuration metadataConfiguration, MetadataDefinition metadataDefinition, String contentType) Parse content mutual relations.
protected Object	_parseDefaultValue(Configuration metadataConfiguration, MetadataDefinition metadataDef) Parses the default value.
protected void	_parseDefinitionWithAnnotations(ServiceManager manager, String pluginName, Configuration metadataConfiguration, DefaultContentType.AnnotableDefinition annotableDefinition) Parses the definition with semantic annotations.
protected I18nizableText	_parseI18nizableText(Configuration config, String pluginName, String name) Parses an i18n text.
protected String	_parseId(Configuration metadataConfiguration) Parses the id.
protected void	_parseRepeaterDefinition(ServiceManager manager, String pluginName, Configuration metadataConfiguration, RepeaterDefinition repeaterDefinition) Parses the repeater definition.
protected List<SemanticAnnotation>	_parseSemAnnotations(String pluginName, Configuration annotationsConfiguration) Extract the list of the declared annotations
protected MetadataType	_parseType(Configuration metadataConfiguration) Parses the type.
protected void	_populateNegativeRestrictions(Configuration restrictionsConfig, DefaultContentType.Restrictions restrictions) Populates the negative restrictions.
protected void	_populateRestrictions(Configuration metadataConfiguration, DefaultContentType.Restrictions restrictions) Populates the restrictions into a metadata definition.
protected void	_populateRightRestrictions(Configuration restrictionsConfig, DefaultContentType.Restrictions restrictions) Populates the rights restrictions.
protected void	_populateWorkflowRestrictions(Configuration restrictionsConfig, DefaultContentType.Restrictions restrictions) Populates the workflows restrictions.

Methods inherited from class org.ametys.runtime.parameter.AbstractParameterParser

_parseAndSetEnumerator, _parseAndSetValidator, _parseWidget, _parseWidgetParameters, lookupComponents, parseParameter

Methods inherited from class java.lang.Object

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

Field Detail

_parentPrefix

protected String _parentPrefix

Parent prefix.

Constructor Detail

MetadataAndRepeaterDefinitionParser

public MetadataAndRepeaterDefinitionParser(ThreadSafeComponentManager<Enumerator> enumeratorManager,
                                           ThreadSafeComponentManager<Validator> validatorManager)

Creates an DefaultContentType.MetadataAndRepeaterDefinitionParser.

Parameters:

enumeratorManager - the enumerator component manager.

validatorManager - the validator component manager.

Method Detail

_createParameter

protected MetadataDefinition _createParameter(Configuration metadataConfiguration)
                                       throws ConfigurationException

Description copied from class: AbstractParameterParser

Create the parameter to populate it.

Specified by:

_createParameter in class AbstractParameterParser<MetadataDefinition,MetadataType>

Parameters:

metadataConfiguration - the parameter configuration to use.

Returns:

the parameter instantiated.

Throws:

ConfigurationException - if the configuration is not valid.

_parseId

protected String _parseId(Configuration metadataConfiguration)
                   throws ConfigurationException

Description copied from class: AbstractParameterParser

Parses the id.

Specified by:

_parseId in class AbstractParameterParser<MetadataDefinition,MetadataType>

Parameters:

metadataConfiguration - the parameter configuration to use.

Returns:

the id.

Throws:

ConfigurationException - if the configuration is not valid.

_parseType

protected MetadataType _parseType(Configuration metadataConfiguration)
                           throws ConfigurationException

Description copied from class: AbstractParameterParser

Parses the type.

Specified by:

_parseType in class AbstractParameterParser<MetadataDefinition,MetadataType>

Parameters:

metadataConfiguration - the parameter configuration to use.

Returns:

the type.

Throws:

ConfigurationException - if the configuration is not valid.

_parseI18nizableText

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

Description copied from class: AbstractParameterParser

Parses an i18n text.

Overrides:

_parseI18nizableText in class AbstractParameterParser<MetadataDefinition,MetadataType>

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.

_parseDefaultValue

protected Object _parseDefaultValue(Configuration metadataConfiguration,
                                    MetadataDefinition metadataDef)

Description copied from class: AbstractParameterParser

Parses the default value.

Specified by:

_parseDefaultValue in class AbstractParameterParser<MetadataDefinition,MetadataType>

Parameters:

metadataConfiguration - the parameter configuration.

metadataDef - the parameter.

Returns:

the default value or null if none defined.

_additionalParsing

protected void _additionalParsing(ServiceManager manager,
                                  String pluginName,
                                  Configuration metadataConfiguration,
                                  String metadataId,
                                  MetadataDefinition metadataDefinition)
                           throws ConfigurationException

Description copied from class: AbstractParameterParser

Called for additional parsing.
Default implementation does nothing.

Overrides:

_additionalParsing in class AbstractParameterParser<MetadataDefinition,MetadataType>

Parameters:

manager - the sservice manager.

pluginName - the plugin name.

metadataConfiguration - the parameter configuration.

metadataId - the parameter id.

metadataDefinition - the parameter to populate.

Throws:

ConfigurationException - if the configuration is not valid.

_parseContentRelations

protected void _parseContentRelations(Configuration metadataConfiguration,
                                      MetadataDefinition metadataDefinition,
                                      String contentType)

Parse content mutual relations.

Parameters:

metadataConfiguration - the metadata configuration.

metadataDefinition - the metadata definition to fill.

contentType - the content type.

_parseRepeaterDefinition

protected void _parseRepeaterDefinition(ServiceManager manager,
                                        String pluginName,
                                        Configuration metadataConfiguration,
                                        RepeaterDefinition repeaterDefinition)
                                 throws ConfigurationException

Parses the repeater definition.

Parameters:

manager - the service manager.

pluginName - the plugin name declaring this parameter.

metadataConfiguration - the metadata configuration to use.

repeaterDefinition - the repeater definition.

Throws:

ConfigurationException - if the configuration is not valid.

_parseDefinitionWithAnnotations

protected void _parseDefinitionWithAnnotations(ServiceManager manager,
                                               String pluginName,
                                               Configuration metadataConfiguration,
                                               DefaultContentType.AnnotableDefinition annotableDefinition)
                                        throws ConfigurationException

Parses the definition with semantic annotations.

Parameters:

manager - the service manager.

pluginName - the plugin name declaring this parameter.

metadataConfiguration - the metadata configuration to use.

annotableDefinition - the metadata definition

Throws:

ConfigurationException - if the configuration is not valid.

_parseSemAnnotations

protected List<SemanticAnnotation> _parseSemAnnotations(String pluginName,
                                                        Configuration annotationsConfiguration)
                                                 throws ConfigurationException

Extract the list of the declared annotations

Parameters:

pluginName - the plugin name declaring this parameter.

annotationsConfiguration - the annotations configuration to use.

Returns:

the list of the declared annotations

Throws:

ConfigurationException - if the configuration is not valid.

_getAnnotationNamePattern

protected Pattern _getAnnotationNamePattern()

Get the annotation name pattern to test validity.

Returns:

The annotation name pattern.

_populateRestrictions

protected void _populateRestrictions(Configuration metadataConfiguration,
                                     DefaultContentType.Restrictions restrictions)
                              throws ConfigurationException

Populates the restrictions into a metadata definition.

Parameters:

metadataConfiguration - the metadata configuration to use.

restrictions - the restrictions.

Throws:

ConfigurationException - if the configuration is not valid.

_populateNegativeRestrictions

protected void _populateNegativeRestrictions(Configuration restrictionsConfig,
                                             DefaultContentType.Restrictions restrictions)
                                      throws ConfigurationException

Populates the negative restrictions.

Parameters:

restrictionsConfig - the restrictions configuration to use.

restrictions - the restrictions.

Throws:

ConfigurationException - if the configuration is not valid.

_parseAccessType

protected boolean _parseAccessType(Configuration configuration)
                            throws ConfigurationException

Parses type attribute from a configuration.

Parameters:

configuration - the configuration.

Returns:

true for read type, false for write type.

Throws:

ConfigurationException - if the configuration is not valid.

_populateRightRestrictions

protected void _populateRightRestrictions(Configuration restrictionsConfig,
                                          DefaultContentType.Restrictions restrictions)
                                   throws ConfigurationException

Populates the rights restrictions.

Parameters:

restrictionsConfig - the restrictions configuration to use.

restrictions - the restrictions.

Throws:

ConfigurationException - if the configuration is not valid.

_populateWorkflowRestrictions

protected void _populateWorkflowRestrictions(Configuration restrictionsConfig,
                                             DefaultContentType.Restrictions restrictions)
                                      throws ConfigurationException

Populates the workflows restrictions.

Parameters:

restrictionsConfig - the restrictions configuration to use.

restrictions - the restrictions.

Throws:

ConfigurationException - if the configuration is not valid.