org.ametys.cms.contenttype

Class ContentAttributeDefinitionParser

java.lang.Object

org.ametys.runtime.model.AbstractModelItemParser

org.ametys.runtime.model.ElementDefinitionParser

org.ametys.cms.contenttype.ContentAttributeDefinitionParser

Direct Known Subclasses:

DublinCoreAttributeDefinitionParser

public class ContentAttributeDefinitionParser
extends ElementDefinitionParser

This class parses the content attributes definition

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	__annotationNamePattern Pattern for annotation names
protected ContentAttributeTypeExtensionPoint	_contentAttributeTypeExtensionPoint the content attribute type extension point
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint the content type extension point

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

_modelItemTypeExtensionPoint

Constructor Summary

Constructors

Constructor and Description
ContentAttributeDefinitionParser(ContentAttributeTypeExtensionPoint contentAttributeTypeExtensionPoint, ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager) Creates a content attribute definition parser.

Method Summary

Modifier and Type	Method and Description
protected AttributeDefinition	_createModelItem(Configuration definitionConfig) Create the model item to populate it.
protected Pattern	_getAnnotationNamePattern() Get the annotation name pattern to test validity.
protected String	_parseContentTypeId(Configuration itemConfig) Parses the content type identifier attribute.
protected List<SemanticAnnotation>	_parseDefinitionWithAnnotations(String pluginName, Configuration itemConfig) Parses the semantic annotations of the model item
protected boolean	_parseForceInvert(Configuration itemConfig) Parses the force invert attribute.
protected String	_parseInvertRelationPath(Configuration itemConfig) Parses the invert relation path attribute.
protected String	_parseName(Configuration itemConfig) Parses the name of the model item.
AttributeDefinition	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

Field Detail

__annotationNamePattern

protected static Pattern __annotationNamePattern

Pattern for annotation names

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

the content type extension point

_contentAttributeTypeExtensionPoint

protected ContentAttributeTypeExtensionPoint _contentAttributeTypeExtensionPoint

the content attribute type extension point

Constructor Detail

ContentAttributeDefinitionParser

public ContentAttributeDefinitionParser(ContentAttributeTypeExtensionPoint contentAttributeTypeExtensionPoint,
                                        ThreadSafeComponentManager<Enumerator> enumeratorManager,
                                        ThreadSafeComponentManager<Validator> validatorManager)

Creates a content attribute definition parser.

Parameters:

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

enumeratorManager - the enumerator component manager.

validatorManager - the validator component manager.

Method Detail

parse

public AttributeDefinition 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 AttributeDefinition _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 itemConfig)
                     throws ConfigurationException

Description copied from class: AbstractModelItemParser

Parses the name of the model item.

Overrides:

_parseName in class AbstractModelItemParser

Parameters:

itemConfig - the model item configuration to use.

Returns:

the name of the model item.

Throws:

ConfigurationException - if the configuration is not valid.

_parseDefinitionWithAnnotations

protected List<SemanticAnnotation> _parseDefinitionWithAnnotations(String pluginName,
                                                                   Configuration itemConfig)
                                                            throws ConfigurationException

Parses the semantic annotations of the model item

Parameters:

pluginName - the name of the plugin name declaring this item.

itemConfig - the model item 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.

_parseContentTypeId

protected String _parseContentTypeId(Configuration itemConfig)
                              throws ConfigurationException

Parses the content type identifier attribute.

Parameters:

itemConfig - the item configuration to use.

Returns:

the identifier of the content type or null if none defined.

Throws:

ConfigurationException - if the defined content type des not exist

_parseInvertRelationPath

protected String _parseInvertRelationPath(Configuration itemConfig)

Parses the invert relation path attribute.

Parameters:

itemConfig - the item configuration to use.

Returns:

the invert relation path or null if none defined.

_parseForceInvert

protected boolean _parseForceInvert(Configuration itemConfig)

Parses the force invert attribute.

Parameters:

itemConfig - the item configuration to use.

Returns:

true if mutual relationship of the item should be set regardless of user's rights, false otherwise.