Package org.ametys.cms.content

Class DefaultContentViewProvider

java.lang.Object

org.ametys.cms.content.DefaultContentViewProvider

All Implemented Interfaces:

ContentViewProvider, Component, Serviceable

Direct Known Subclasses:

WebContentViewProvider

public class DefaultContentViewProvider
extends Object
implements ContentViewProvider, Component, Serviceable

Default implementation of a ContentViewProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypesHelper	_contentTypesHelper	The content types helper

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

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultContentViewProvider()

Method Summary

Modifier and Type	Method	Description
View	getView(String viewName, String[] contentTypeIds, String[] mixinIds)	Get the view for view resulting of the concatenation of views of the given content.
Optional<ContentTypesParserHelper.ViewConfigurations>	getViewConfigurations(ContentType contentType, String viewName, ViewParserContext context)	Retrieves the optional view's configuration declared by the given content type
Map<String,ContentTypesParserHelper.ViewConfigurations>	getViewConfigurations(ContentType contentType, ViewParserContext context)	Retrieves all the views' configurations declared by the given content type
View	getViewWithFallback(String viewName, String fallbackViewName, String[] contentTypeIds, String[] mixinIds)	Get the view for view resulting for a given content
void	service(ServiceManager manager)

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

getContentTypeView, getOverriddenContentTypes, getView, getViewWithFallback, initializeViewConfigurations, parseViews, resolveViewReferences

Field Details

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper

Constructor Details

DefaultContentViewProvider

public DefaultContentViewProvider()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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

Parameters:

contentType - the content type

context - the context of view parsing

Returns:

the views' configurations

getViewConfigurations

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

Description copied from interface: ContentViewProvider

Retrieves the optional view's configuration declared by the given content type

Specified by:

getViewConfigurations in interface ContentViewProvider

Parameters:

contentType - the content type

viewName - the name of the view to retrieve

context - the context of view parsing

Returns:

the view's configuration

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

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.

getViewWithFallback

public View getViewWithFallback(String viewName,
 String fallbackViewName,
 String[] contentTypeIds,
 String[] mixinIds)

Description copied from interface: ContentViewProvider

Get the view for view resulting for a given content

Specified by:

getViewWithFallback in interface ContentViewProvider

Parameters:

viewName - the name of the view to retrieve. If null or empty, fallback view will be used.

fallbackViewName - the name of the view to retrieve if the initial was not found. If null or empty, "main" view view will be used as fallback view.

contentTypeIds - the identifiers of the content types

mixinIds - the identifiers of the mixins

Returns:

The view or null if none matches.