Package org.ametys.web.content

Class WebContentViewProvider

java.lang.Object

org.ametys.cms.content.DefaultContentViewProvider

org.ametys.web.content.WebContentViewProvider

All Implemented Interfaces:

ContentViewProvider, Initializable, Component, Contextualizable, Serviceable

public class WebContentViewProvider
extends DefaultContentViewProvider
implements Contextualizable, Initializable

This implementation of a ContentViewProvider looks first if the view has been defined (or overridden) in the current skin

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected ContentTypesParserHelper	_contentTypesParserHelper	The content types parser helper
protected Context	_context	The context
protected static final org.slf4j.Logger	_LOGGER	The logger.
protected SiteManager	_siteManager	The site manager
protected SkinConfigurationHelper	_skinConfigurationHelper	The skin configuration helper
protected SkinContentTypeOverridesExtensionPoint	_skinContentTypeOverridesExtensionPoint	The extension point with overrides specific to skins
protected SkinsManager	_skinsManager	The skin manager
protected SourceResolver	_srcResolver	The source resolver

Fields inherited from class org.ametys.cms.content.DefaultContentViewProvider

_contentTypesHelper

Fields inherited from interface org.ametys.cms.content.ContentViewProvider

ROLE

Constructor Summary

Constructors

Constructor	Description
WebContentViewProvider()

Method Summary

Modifier and Type	Method	Description
protected void	_createCaches()	Creates the caches
void	contextualize(Context context)
View	getContentTypeView(ContentType contentType, String viewName, ViewParserContext context)	Retrieves the view of the given content type
Set<String>	getOverriddenContentTypes()	Retrieves a Set of content types that have been overridden
View	getView(String viewName, String[] contentTypeIds, String[] mixinIds)	Get the view for view resulting of the concatenation of views of the given content.
Map<String,ContentTypesParserHelper.ViewConfigurations>	getViewConfigurations(ContentType contentType, ViewParserContext context)	Retrieves all the views' configurations declared by the given content type
void	initialize()	Initialize
void	initializeViewConfigurations()	Initializes the view configurations of the provider.
void	parseViews()	Parse the views of the provider This method is called once at application startup, after all content type's views have been parsed
void	resolveViewReferences()	Resolve the temporary view references in overridden views
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.content.DefaultContentViewProvider

getViewConfigurations, getViewWithFallback

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.content.ContentViewProvider

getView, getViewWithFallback

Field Details

_LOGGER

protected static final org.slf4j.Logger _LOGGER

The logger.

_skinsManager

protected SkinsManager _skinsManager

The skin manager

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_contentTypesParserHelper

protected ContentTypesParserHelper _contentTypesParserHelper

The content types parser helper

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_skinConfigurationHelper

protected SkinConfigurationHelper _skinConfigurationHelper

The skin configuration helper

_skinContentTypeOverridesExtensionPoint

protected SkinContentTypeOverridesExtensionPoint _skinContentTypeOverridesExtensionPoint

The extension point with overrides specific to skins

_siteManager

protected SiteManager _siteManager

The site manager

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

_context

protected Context _context

The context

Constructor Details

WebContentViewProvider

public WebContentViewProvider()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class DefaultContentViewProvider

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

initialize

public void initialize()

Initialize

Specified by:

initialize in interface Initializable

_createCaches

protected void _createCaches()

Creates the caches

initializeViewConfigurations

public void initializeViewConfigurations()
                                  throws ConfigurationException

Description copied from interface: ContentViewProvider

Initializes the view configurations of the provider. This method is called once at application startup, after all content types have been configured.

Specified by:

initializeViewConfigurations in interface ContentViewProvider

Throws:

ConfigurationException - if an error occurs during the initialization of the view configurations

getViewConfigurations

public Map<String,ContentTypesParserHelper.ViewConfigurations> getViewConfigurations(ContentType contentType,
 ViewParserContext context)

Description copied from interface: ContentViewProvider

Retrieves all the views' configurations declared by the given content type

Specified by:

getViewConfigurations in interface ContentViewProvider

Overrides:

getViewConfigurations in class DefaultContentViewProvider

Parameters:

contentType - the content type

context - the context of view parsing

Returns:

the views' configurations

parseViews

public void parseViews()
                throws ConfigurationException

Description copied from interface: ContentViewProvider

Parse the views of the provider This method is called once at application startup, after all content type's views have been parsed

Specified by:

parseViews in interface ContentViewProvider

Throws:

ConfigurationException - if an error occurs during the parse of the views

resolveViewReferences

public void resolveViewReferences()
                           throws ConfigurationException

Description copied from interface: ContentViewProvider

Resolve the temporary view references in overridden views

Specified by:

resolveViewReferences in interface ContentViewProvider

Throws:

ConfigurationException - if a view reference has a configuration error (the content attribute nesting the reference does not specify any content type, the view does not exist, ...)

getContentTypeView

public View getContentTypeView(ContentType contentType,
 String viewName,
 ViewParserContext context)

Description copied from interface: ContentViewProvider

Retrieves the view of the given content type

Specified by:

getContentTypeView in interface ContentViewProvider

Parameters:

contentType - the content type

viewName - the view name

context - the context of view parsing

Returns:

the view of the given content type

getOverriddenContentTypes

public Set<String> getOverriddenContentTypes()

Description copied from interface: ContentViewProvider

Retrieves a Set of content types that have been overridden

Specified by:

getOverriddenContentTypes in interface ContentViewProvider

Returns:

the set of overridden content types identifiers

getView

public View getView(String viewName,
 String[] contentTypeIds,
 String[] mixinIds)

Description copied from interface: ContentViewProvider

Get the view for view resulting of the concatenation of views of the given content.

Specified by:

getView in interface ContentViewProvider

Overrides:

getView in class DefaultContentViewProvider

Parameters:

viewName - the name of the view to retrieve

contentTypeIds - the identifiers of the content types

mixinIds - the identifiers of the mixins

Returns:

The view or null if none matches.