org.ametys.cms.contenttype

Class AbstractContentTypeDescriptor

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.contenttype.AbstractContentTypeDescriptor

All Implemented Interfaces:

ContentTypeDescriptor, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

DefaultContentType, DynamicContentTypeDescriptor

public abstract class AbstractContentTypeDescriptor
extends AbstractLogEnabled
implements ContentTypeDescriptor, Configurable, PluginAware, Serviceable

This abstract class represents a content type descriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,MetadataSet>	_allMetadataSetsForEdition All metadata sets for edition.
protected Map<String,MetadataSet>	_allMetadataSetsForView All metadata sets for view.
protected I18nizableText	_category Category.
protected ContentTypesHelper	_contentTypesHelper The content types helper
protected List<ClientSideElement.ScriptFile>	_cssFiles The CSS files
protected ContentTypeExtensionPoint	_cTypeEP The content type extension point.
protected DublinCoreMetadataProvider	_dcProvider The DublinCore metadata provider
protected I18nizableText	_defaultTitle Default title.
protected I18nizableText	_description Description.
protected String	_iconDecorator Icon decorator
protected String	_iconGlyph Glyph icon
protected String	_id Content type id.
protected I18nizableText	_label Label.
protected String	_largeIcon Large icon URI 48x48.
protected String	_mediumIcon Medium icon URI 32x32.
protected Map<String,MetadataSet>	_metadataSetsForEdition Non-internal metadata sets for edition.
protected Map<String,MetadataSet>	_metadataSetsForView Non-internal metadata sets for view.
protected String	_pluginName Plugin name.
protected String	_smallIcon Small icon URI 16x16.
protected SourceResolver	_srcResolver The source resolver
protected String[]	_superTypeIds This content-type's supertype ids (can be empty).

Constructor Summary

Constructors

Constructor and Description
AbstractContentTypeDescriptor()

Method Summary

Modifier and Type	Method and Description
protected void	_configureCSSFiles(Configuration configuration) Configure the CSS to import
protected void	_configureIcons(Configuration mainConfig) Configures the icons
protected void	_configureLabels(Configuration mainConfig) Configures the labels
protected void	_configureMetadataSets(Configuration mainConfig) Configure metadata sets
protected void	_configureSuperTypes(Configuration mainConfig) Configures the super types
protected void	_fillMetadataSetDublinCore(AbstractMetadataSetElement metadataSetElement) Parse the DublinCore metadata set.
protected void	_fillMetadataSetElement(MetadataSet rootMetadataSet, Configuration metadataSetConfig, AbstractMetadataSetElement metadataSetElement, boolean isEdition, MetadataSet superMetadataSet) Fill child elements for a metadata set element.
protected void	_getApplicableMetadataSets(Configuration config, Map<String,Configuration> metadataSetViewConfs, Map<String,Configuration> metadataSetEditConfs, boolean allowOverride) Compute the applicable metadata-sets from their configurations.
protected String	_getDefaultCatalogue() Returns the default i18n catalogue for this content type.
protected String	_getIconPath(String pluginName) Returns the path for icons
protected I18nizableText	_parseI18nizableText(Configuration config, String name) Parse an i18n text.
protected I18nizableText	_parseI18nizableText(Configuration config, String name, String defaultValue) Parse an i18n text.
protected String	_parseIcon(Configuration configuration, String name) Parse an icon path
protected String	_parseIcon(Configuration configuration, String name, String defaultValue) Parse an icon path
protected String	_parseIconGlyph(Configuration configuration, String metadataSetName, String defaultGlyph) Parse the icon glyph.
protected MetadataSet	_parseMetadataSet(Configuration metadataSetConfig, String metadataSetName, boolean isEdition, boolean isInternal, String[] superTypeIds) Parse a metadata-set configuration to create a MetadataSet object.
protected void	_parseMetadataSets(Map<String,Configuration> metadataSetConfs, Map<String,MetadataSet> metadataSets, Map<String,MetadataSet> allMetadataSets, String[] superTypeIds) Parse the metadata-set configurations
void	configure(Configuration configuration)
I18nizableText	getCategory() Retrieves the category of the content type.
List<ClientSideElement.ScriptFile>	getCSSFiles() Returns the list of CSS files needed to correctly display the content's in BO, such as the content's icon
I18nizableText	getDefaultTitle() Retrieves the default title of the content type.
I18nizableText	getDescription() Retrieves the description of the content type.
Set<String>	getEditionMetadataSetNames(boolean includeInternal) Returns all names of "edition" metadataSets.
String	getIconDecorator() Retrieves the CSS class to use for decorator above the main icon
String	getIconGlyph() Retrieves the CSS class to use for glyph icon
String	getId() Retrieves the id of the content type.
I18nizableText	getLabel() Retrieves the label of the content type.
String	getLargeIcon() Retrieves the URL of the icon without the context path.
String	getMediumIcon() Retrieves the URL of the icon without the context path.
MetadataSet	getMetadataSetForEdition(String metadataSetName) Retrieves the metadata set name for edition.
MetadataSet	getMetadataSetForView(String metadataSetName) Retrieves the metadata set name for view.
protected abstract Configuration	getOverridenConfiguration() Get the overridden configuration
String	getPluginName() Retrieves the name of the plugin declaring this content type.
protected abstract Configuration	getRootConfiguration(Configuration configuration) Get the root configuration
String	getSmallIcon() Retrieves the URL of the icon without the context path.
String[]	getSupertypeIds() Retrieves the super type's ids.
Set<String>	getViewMetadataSetNames(boolean includeInternal) Returns all names of "view" metadataSets.
void	service(ServiceManager smanager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_pluginName

protected String _pluginName

Plugin name.

_id

protected String _id

Content type id.

_label

protected I18nizableText _label

Label.

_description

protected I18nizableText _description

Description.

_defaultTitle

protected I18nizableText _defaultTitle

Default title.

_category

protected I18nizableText _category

Category.

_iconGlyph

protected String _iconGlyph

Glyph icon

_iconDecorator

protected String _iconDecorator

Icon decorator

_smallIcon

protected String _smallIcon

Small icon URI 16x16.

_mediumIcon

protected String _mediumIcon

Medium icon URI 32x32.

_largeIcon

protected String _largeIcon

Large icon URI 48x48.

_cssFiles

protected List<ClientSideElement.ScriptFile> _cssFiles

The CSS files

_superTypeIds

protected String[] _superTypeIds

This content-type's supertype ids (can be empty).

_allMetadataSetsForView

protected Map<String,MetadataSet> _allMetadataSetsForView

All metadata sets for view.

_metadataSetsForView

protected Map<String,MetadataSet> _metadataSetsForView

Non-internal metadata sets for view.

_allMetadataSetsForEdition

protected Map<String,MetadataSet> _allMetadataSetsForEdition

All metadata sets for edition.

_metadataSetsForEdition

protected Map<String,MetadataSet> _metadataSetsForEdition

Non-internal metadata sets for edition.

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point.

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_dcProvider

protected DublinCoreMetadataProvider _dcProvider

The DublinCore metadata provider

Constructor Detail

AbstractContentTypeDescriptor

public AbstractContentTypeDescriptor()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getRootConfiguration

protected abstract Configuration getRootConfiguration(Configuration configuration)

Get the root configuration

Parameters:

configuration - The configuration

Returns:

The main configuration

getOverridenConfiguration

protected abstract Configuration getOverridenConfiguration()
                                                    throws ConfigurationException

Get the overridden configuration

Returns:

the overridden configuration or null

Throws:

ConfigurationException - if an error occurred

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

_configureSuperTypes

protected void _configureSuperTypes(Configuration mainConfig)

Configures the super types

Parameters:

mainConfig - The main configuration

_configureLabels

protected void _configureLabels(Configuration mainConfig)
                         throws ConfigurationException

Configures the labels

Parameters:

mainConfig - The main configuration

Throws:

ConfigurationException - if an error occurred

_configureIcons

protected void _configureIcons(Configuration mainConfig)
                        throws ConfigurationException

Configures the icons

Parameters:

mainConfig - The main configuration

Throws:

ConfigurationException - if an error occurred

_configureMetadataSets

protected void _configureMetadataSets(Configuration mainConfig)
                               throws ConfigurationException

Configure metadata sets

Parameters:

mainConfig - The content type configuration

Throws:

ConfigurationException - if an error occurred

_getApplicableMetadataSets

protected void _getApplicableMetadataSets(Configuration config,
                                          Map<String,Configuration> metadataSetViewConfs,
                                          Map<String,Configuration> metadataSetEditConfs,
                                          boolean allowOverride)
                                   throws ConfigurationException

Compute the applicable metadata-sets from their configurations.

Parameters:

config - The content type configuration

metadataSetViewConfs - the view metadata-set configurations, indexed by name.

metadataSetEditConfs - the edition metadata-set configurations, indexed by name.

allowOverride - if true, encountering a metadata-set which has already been declared (based on its name) will replace it. Otherwise, an exception will be thrown.

Throws:

ConfigurationException - if the configuration is invalid

_parseMetadataSets

protected void _parseMetadataSets(Map<String,Configuration> metadataSetConfs,
                                  Map<String,MetadataSet> metadataSets,
                                  Map<String,MetadataSet> allMetadataSets,
                                  String[] superTypeIds)
                           throws ConfigurationException

Parse the metadata-set configurations

Parameters:

metadataSetConfs - the metadata-set configurations, indexed by name.

metadataSets - the Map of "public" MetadataSet objects to fill, indexed by name

allMetadataSets - the Map of MetadataSet objects to fill (including internal ones), indexed by name.

superTypeIds - the super content-types

Throws:

ConfigurationException - if the configuration is invalid

_parseMetadataSet

protected MetadataSet _parseMetadataSet(Configuration metadataSetConfig,
                                        String metadataSetName,
                                        boolean isEdition,
                                        boolean isInternal,
                                        String[] superTypeIds)
                                 throws ConfigurationException

Parse a metadata-set configuration to create a MetadataSet object.

Parameters:

metadataSetConfig - the metadata set configuration to use.

metadataSetName - the metadata set name.

isEdition - the metadata set edition status.

isInternal - the metadata internal status.

superTypeIds - the super types.

Returns:

the metadata set

Throws:

ConfigurationException - if the configuration is not valid.

_parseIconGlyph

protected String _parseIconGlyph(Configuration configuration,
                                 String metadataSetName,
                                 String defaultGlyph)

Parse the icon glyph. If not present, a default will be assigned if a icon is not yet defined

Parameters:

configuration - the configuration

metadataSetName - The metadata set name

defaultGlyph - The default glyph to assign if no glyph is defined. Can be null.

Returns:

the glyph icon

_fillMetadataSetElement

protected void _fillMetadataSetElement(MetadataSet rootMetadataSet,
                                       Configuration metadataSetConfig,
                                       AbstractMetadataSetElement metadataSetElement,
                                       boolean isEdition,
                                       MetadataSet superMetadataSet)
                                throws ConfigurationException

Fill child elements for a metadata set element.

Parameters:

rootMetadataSet - The root metadata set

metadataSetConfig - the metadata set configuration to use.

metadataSetElement - the metadata set element to fill.

isEdition - true if it is the edition mode

superMetadataSet - the overridden metadata-set if applicable, null otherwise.

Throws:

ConfigurationException - if the configuration is not valid.

_fillMetadataSetDublinCore

protected void _fillMetadataSetDublinCore(AbstractMetadataSetElement metadataSetElement)
                                   throws ConfigurationException

Parse the DublinCore metadata set.

Parameters:

metadataSetElement - the metadata set element to fill.

Throws:

ConfigurationException - if the configuration is not valid.

_parseI18nizableText

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

Parse an i18n text.

Parameters:

config - the configuration to use.

name - the child name.

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

_parseI18nizableText

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

Parse an i18n text.

Parameters:

config - 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.

_getDefaultCatalogue

protected String _getDefaultCatalogue()

Returns the default i18n catalogue for this content type.

Returns:

the default i18n catalogue for this content type.

_parseIcon

protected String _parseIcon(Configuration configuration,
                            String name)
                     throws ConfigurationException

Parse an icon path

Parameters:

configuration - the configuration to use

name - the child name.

Returns:

The icon path

Throws:

ConfigurationException - if the configuration is not valid.

_parseIcon

protected String _parseIcon(Configuration configuration,
                            String name,
                            String defaultValue)
                     throws ConfigurationException

Parse an icon path

Parameters:

configuration - the configuration to use

name - the child name.

defaultValue - the default value.

Returns:

The icon path

Throws:

ConfigurationException - if the configuration is not valid.

_configureCSSFiles

protected void _configureCSSFiles(Configuration configuration)
                           throws ConfigurationException

Configure the CSS to import

Parameters:

configuration - The imports configuration

Throws:

ConfigurationException - If an error occurs

_getIconPath

protected String _getIconPath(String pluginName)

Returns the path for icons

Parameters:

pluginName - the configured plugin

Returns:

the path for icons

getPluginName

public String getPluginName()

Description copied from interface: ContentTypeDescriptor

Retrieves the name of the plugin declaring this content type.

Specified by:

getPluginName in interface ContentTypeDescriptor

Returns:

the name of the plugin.

getId

public String getId()

Description copied from interface: ContentTypeDescriptor

Retrieves the id of the content type.

Specified by:

getId in interface ContentTypeDescriptor

Returns:

the id.

getLabel

public I18nizableText getLabel()

Description copied from interface: ContentTypeDescriptor

Retrieves the label of the content type.

Specified by:

getLabel in interface ContentTypeDescriptor

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: ContentTypeDescriptor

Retrieves the description of the content type.

Specified by:

getDescription in interface ContentTypeDescriptor

Returns:

the description.

getCategory

public I18nizableText getCategory()

Description copied from interface: ContentTypeDescriptor

Retrieves the category of the content type.

Specified by:

getCategory in interface ContentTypeDescriptor

Returns:

the category.

getDefaultTitle

public I18nizableText getDefaultTitle()

Description copied from interface: ContentTypeDescriptor

Retrieves the default title of the content type.

Specified by:

getDefaultTitle in interface ContentTypeDescriptor

Returns:

the default title.

getIconGlyph

public String getIconGlyph()

Description copied from interface: ContentTypeDescriptor

Retrieves the CSS class to use for glyph icon

Specified by:

getIconGlyph in interface ContentTypeDescriptor

Returns:

the glyph name.

getIconDecorator

public String getIconDecorator()

Description copied from interface: ContentTypeDescriptor

Retrieves the CSS class to use for decorator above the main icon

Specified by:

getIconDecorator in interface ContentTypeDescriptor

Returns:

the glyph name.

getSmallIcon

public String getSmallIcon()

Description copied from interface: ContentTypeDescriptor

Retrieves the URL of the icon without the context path.

Specified by:

getSmallIcon in interface ContentTypeDescriptor

Returns:

the icon URL for the small image 16x16.

getMediumIcon

public String getMediumIcon()

Description copied from interface: ContentTypeDescriptor

Retrieves the URL of the icon without the context path.

Specified by:

getMediumIcon in interface ContentTypeDescriptor

Returns:

the icon URL for the medium sized image 32x32.

getLargeIcon

public String getLargeIcon()

Description copied from interface: ContentTypeDescriptor

Retrieves the URL of the icon without the context path.

Specified by:

getLargeIcon in interface ContentTypeDescriptor

Returns:

the icon URL for the large image 48x48.

getSupertypeIds

public String[] getSupertypeIds()

Description copied from interface: ContentTypeDescriptor

Retrieves the super type's ids.

Specified by:

getSupertypeIds in interface ContentTypeDescriptor

Returns:

the super type's ids, or empty if this content type doesn't extend a specific content type.

getCSSFiles

public List<ClientSideElement.ScriptFile> getCSSFiles()

Description copied from interface: ContentTypeDescriptor

Returns the list of CSS files needed to correctly display the content's in BO, such as the content's icon

Specified by:

getCSSFiles in interface ContentTypeDescriptor

Returns:

The list of CSS files needed. Must not be null.

getEditionMetadataSetNames

public Set<String> getEditionMetadataSetNames(boolean includeInternal)

Description copied from interface: ContentTypeDescriptor

Returns all names of "edition" metadataSets.

Specified by:

getEditionMetadataSetNames in interface ContentTypeDescriptor

Parameters:

includeInternal - if the result should include internal metadataSets.

Returns:

all names of "edition" metadataSets.

getViewMetadataSetNames

public Set<String> getViewMetadataSetNames(boolean includeInternal)

Description copied from interface: ContentTypeDescriptor

Returns all names of "view" metadataSets.

Specified by:

getViewMetadataSetNames in interface ContentTypeDescriptor

Parameters:

includeInternal - if the result should include internal metadataSets.

Returns:

all names of "view" metadataSets.

getMetadataSetForView

public MetadataSet getMetadataSetForView(String metadataSetName)

Description copied from interface: ContentTypeDescriptor

Retrieves the metadata set name for view.

Specified by:

getMetadataSetForView in interface ContentTypeDescriptor

Parameters:

metadataSetName - the metadata set name.

Returns:

the metadata definition.

getMetadataSetForEdition

public MetadataSet getMetadataSetForEdition(String metadataSetName)

Description copied from interface: ContentTypeDescriptor

Retrieves the metadata set name for edition.

Specified by:

getMetadataSetForEdition in interface ContentTypeDescriptor

Parameters:

metadataSetName - the metadata set name.

Returns:

the metadata set.