Package org.ametys.web.parameters.view

Class ViewParametersManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.parameters.view.ViewParametersManager

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ViewParametersManager
extends AbstractLogEnabled
implements Component, Serviceable

Manager for view parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewParametersManager.ViewParameterHolder	Object representing the data holder of the parameter with the path of the parameter in this holder

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeEP	The content type extension point
protected ContentTypesHelper	_contentTypesHelper	The content types helper
protected ContentViewParametersManager	_contentViewParametersManager	The content view parameters manager
protected GlobalViewParametersManager	_globalViewParametersManager	The global view parameters manager
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected ServiceExtensionPoint	_serviceEP	The service extension point
protected ServiceViewParametersManager	_serviceViewParametersManager	The service view parameters manager
protected SkinsManager	_skinsManager	The skins manager
protected ViewParameterTypeExtensionPoint	_viewParametersTypeEP	The view parameters type extension point
static String	CONTENT_VIEW_MODEL_ITEM_NAME	The name of the model item containing the content view parameters This model item is created from scratch, the name doesn't matter
static String	CONTENT_VIEW_PARAMETERS_COMPOSITE_NAME	The composite name for content view parameters
static String	ROLE	Avalon Role
static String	SERVICE_VIEW_DEFAULT_MODEL_ITEM_NAME	The name of default attribute in the service parameters to set the service view Warning : it's a convention to call this parameter 'xslt', but a service can't have several view xsl with different names
static String	SERVICE_VIEW_PARAMETERS_COMPOSITE_NAME	The composite name for service view parameters
static String	TEMPLATE_INHERIT_MODEL_ITEM_NAME	The name of the model item to disable inheritance for template This model item is created from scratch, the name doesn't matter
static String	VIEW_PARAMETERS_COMPOSITE_NAME	The composite name for view parameters
static String	VIEW_PARAMETERS_CONTENT_CONF_NAME	The name of the tag containing the content view parameters
static String	VIEW_PARAMETERS_NODETYPE	The node type for view parameters
static String	VIEW_PARAMETERS_SERVICE_CONF_NAME	The name of the tag containing the service view parameters
static String	VIEW_PARAMETERS_TEMPLATE_CONF_NAME	The name of the tag containing the template view parameters
static String	VIEW_PARAMETERS_ZONE_CONF_NAME	The name of the tag containing the zone view parameters
static String	VIEW_PARAMETERS_ZONE_ITEM_CONF_NAME	The name of the tag containing the zone item view parameters
static String	VIEW_PARAMETERS_ZONE_ITEM_PARENT_CONF_NAME	The name of the parent tag containing the zone item view parameters
static String	ZONE_INHERIT_MODEL_ITEM_NAME	The name of the model item to disable inheritance for zone This model item is created from scratch, the name doesn't matter

Constructor Summary

Constructors

Constructor	Description
ViewParametersManager()

Method Summary

Modifier and Type	Method	Description
private void	_addParameters(Collection<? extends ModelItem> modelItems, ViewParametersModel viewParametersModel)
private void	_addViewItems(View sourceView, View destView)
private JCRRepositoryData	_getJCRRepositoryData(JCRRepositoryData parentJCRData, String jcrName)
protected Optional<ViewParametersManager.ViewParameterHolder>	_getTemplateViewParameterHolderWithInheritance(Page page, ViewParameter viewParameter, String parameterPath)	Get the parameter holder with the effective parameter path for a view parameter of a template, taking into account the inheritance.
private Optional<ViewParametersManager.ViewParameterHolder>	_getViewParamaterHolder(ModelAwareDataHolder dataHolder, String parameterPath)
protected Optional<ViewParametersManager.ViewParameterHolder>	_getZoneViewParameterHolderWithInheritance(Page page, Zone zone, ViewParameter viewParameter, String parameterPath)	Get the parameter holder with the effective parameter path for a view parameter of a zone, taking into account the inheritance.
Optional<ViewParametersModel>	addGlobalViewParameters(String skinId, GlobalViewParametersManager.ViewParametersType type, Optional<ViewParametersModel> viewParameters)	Get the global view parameters for the given type and add the view parameters to it
void	copyContentViewParameters(ModifiableZoneItem zoneItemSource, ModifiableZoneItem zoneItemDestination)	Copy content view parameters of the source zone item to the destination zone item
void	copyServiceViewParameters(ModifiableZoneItem zoneItemSource, ModifiableZoneItem zoneItemDestination)	Copy service view parameters of the source zone item to the destination zone item
<T> T	getContentParameterValue(ZoneItem zoneItem, String viewName, String parameterPath)	Get the content parameter value
ElementDefinition<String>	getContentViewEnumerator(Content content)	Get a static enumerator with all content view
ModifiableModelAwareDataHolder	getContentViewParametersHolder(JCRRepositoryData parentJCRData, String viewName, ViewParametersModel viewParametersModel)	Get the content view parameters holder
Optional<ModelAwareDataHolder>	getContentViewParametersHolder(ZoneItem zoneItem)	Get content view parameters holder from the zone item
Optional<ViewParametersModel>	getContentViewParametersModel(String skinId, Content content, String viewName)	Get the content view parameters model
Optional<ViewParametersModel>	getContentViewParametersModel(ZoneItem zoneItem)	Get the content view parameters model
Map<String,ViewParametersModel>	getContentViewParametersModels(String skinId, Content content)	Get all view parameters model for one content
ViewParameter<Boolean>	getInheritCheckboxElement(Model model, String name)	Get a check box to override inherit parameters
ModifiableModelAwareDataHolder	getParametersHolder(JCRRepositoryData parentJCRData, ViewParametersModel viewParametersModel)	Get the view parameters holder
<T> T	getServiceParameterValue(ZoneItem zoneItem, String viewName, String parameterPath)	Get the service parameter value
ElementDefinition<String>	getServiceViewEnumerator(String serviceId)	Get a service enumerator with all content view
ModifiableModelAwareDataHolder	getServiceViewParametersHolder(JCRRepositoryData parentJCRData, String viewName, ViewParametersModel viewParametersModel)	Get the service view parameters holder
Optional<ModelAwareDataHolder>	getServiceViewParametersHolder(ZoneItem zoneItem)	Get service view parameters holder from the zone item
Optional<ViewParametersModel>	getServiceViewParametersModel(String skinId, String serviceId, String viewName)	Get the service view parameters model
Optional<ViewParametersModel>	getServiceViewParametersModel(ZoneItem zoneItem)	Get the service view parameters model
Map<String,ViewParametersModel>	getServiceViewParametersModels(String skinId, String serviceId)	Get all view parameters model for one service
<T> T	getTemplateParameterValue(Page page, String parameterPath)	Get the template parameter value
Optional<ViewParametersManager.ViewParameterHolder>	getTemplateViewParameterHolderWithInheritance(Page page, String parameterPath)	Get the parameter holder with the effective parameter path for a view parameter of a template, taking into account the inheritance.
Optional<ViewParametersManager.ViewParameterHolder>	getTemplateViewParameterHolderWithInheritance(Page page, ModelItem modelItem)	Get the parameter holder with the effective parameter path for a view parameter of a template, taking into account the inheritance.
Optional<ViewParametersModel>	getTemplateViewParametersModel(String skinId, String templateId)	Get the template view parameters model
Optional<ViewParametersModel>	getTemplateViewParametersModel(SkinTemplate skinTemplate)	Get the template view parameters model
<T> T	getZoneItemParameterValue(ZoneItem zoneItem, String parameterPath)	Get the zone item parameter value
Optional<ViewParametersModel>	getZoneItemViewParametersModel(String skinId, String templateId, String zoneName)	Get the zone item view parameters model
Optional<ViewParametersModel>	getZoneItemViewParametersModel(ZoneItem zoneItem)	Get the zone item view parameters model
<T> T	getZoneParameterValue(Page page, Zone zone, String parameterPath)	Get the zone parameter value
Optional<ViewParametersManager.ViewParameterHolder>	getZoneViewParameterHolderWithInheritance(Page page, Zone zone, String parameterPath)	Get the parameter holder with the effective parameter path for a view parameter of a zone, taking into account the inheritance.
Optional<ViewParametersManager.ViewParameterHolder>	getZoneViewParameterHolderWithInheritance(Page page, Zone zone, ModelItem modelItem)	Get the parameter holder with the effective parameter path for a view parameter of a zone, taking into account the inheritance.
Optional<ViewParametersModel>	getZoneViewParametersModel(String skinId, String templateId, String zoneId)	Get the zone view parameters model
Optional<ViewParametersModel>	getZoneViewParametersModel(SkinTemplateZone skinTemplateZone)	Get the zone view parameters model
List<ModelItem>	includeModelItems(Collection<? extends ModelItem> modelItems, String prefix, ViewItemContainer viewItemContainer)	Add model items to the view item container and add prefix to items name
List<ModelItem>	includeModelItems(Collection<? extends ModelItem> modelItems, String prefix, ViewItemContainer viewItemContainer, Optional<Integer> index)	Add model items to the view item container and add prefix to items name
String	normalizeViewName(String viewName)	Normalize the view name (for service view value with /)
void	service(ServiceManager manager)
void	setDisableConditions(String elementName, String conditionValue, Collection<? extends ModelItem> modelItems)	Set the a disable condition to all model items.

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

ROLE

public static final String ROLE

Avalon Role

TEMPLATE_INHERIT_MODEL_ITEM_NAME

public static final String TEMPLATE_INHERIT_MODEL_ITEM_NAME

The name of the model item to disable inheritance for template This model item is created from scratch, the name doesn't matter

See Also:

Constant Field Values

ZONE_INHERIT_MODEL_ITEM_NAME

public static final String ZONE_INHERIT_MODEL_ITEM_NAME

The name of the model item to disable inheritance for zone This model item is created from scratch, the name doesn't matter

See Also:

Constant Field Values

CONTENT_VIEW_MODEL_ITEM_NAME

public static final String CONTENT_VIEW_MODEL_ITEM_NAME

The name of the model item containing the content view parameters This model item is created from scratch, the name doesn't matter

See Also:

Constant Field Values

SERVICE_VIEW_DEFAULT_MODEL_ITEM_NAME

public static final String SERVICE_VIEW_DEFAULT_MODEL_ITEM_NAME

The name of default attribute in the service parameters to set the service view Warning : it's a convention to call this parameter 'xslt', but a service can't have several view xsl with different names

See Also:

Constant Field Values

VIEW_PARAMETERS_TEMPLATE_CONF_NAME

public static final String VIEW_PARAMETERS_TEMPLATE_CONF_NAME

The name of the tag containing the template view parameters

See Also:

Constant Field Values

VIEW_PARAMETERS_ZONE_CONF_NAME

public static final String VIEW_PARAMETERS_ZONE_CONF_NAME

The name of the tag containing the zone view parameters

See Also:

Constant Field Values

VIEW_PARAMETERS_ZONE_ITEM_PARENT_CONF_NAME

public static final String VIEW_PARAMETERS_ZONE_ITEM_PARENT_CONF_NAME

The name of the parent tag containing the zone item view parameters

See Also:

Constant Field Values

VIEW_PARAMETERS_ZONE_ITEM_CONF_NAME

public static final String VIEW_PARAMETERS_ZONE_ITEM_CONF_NAME

The name of the tag containing the zone item view parameters

See Also:

Constant Field Values

VIEW_PARAMETERS_SERVICE_CONF_NAME

public static final String VIEW_PARAMETERS_SERVICE_CONF_NAME

The name of the tag containing the service view parameters

See Also:

Constant Field Values

VIEW_PARAMETERS_CONTENT_CONF_NAME

public static final String VIEW_PARAMETERS_CONTENT_CONF_NAME

The name of the tag containing the content view parameters

See Also:

Constant Field Values

VIEW_PARAMETERS_COMPOSITE_NAME

public static final String VIEW_PARAMETERS_COMPOSITE_NAME

The composite name for view parameters

See Also:

Constant Field Values

CONTENT_VIEW_PARAMETERS_COMPOSITE_NAME

public static final String CONTENT_VIEW_PARAMETERS_COMPOSITE_NAME

The composite name for content view parameters

See Also:

Constant Field Values

SERVICE_VIEW_PARAMETERS_COMPOSITE_NAME

public static final String SERVICE_VIEW_PARAMETERS_COMPOSITE_NAME

The composite name for service view parameters

See Also:

Constant Field Values

VIEW_PARAMETERS_NODETYPE

public static final String VIEW_PARAMETERS_NODETYPE

The node type for view parameters

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_serviceViewParametersManager

protected ServiceViewParametersManager _serviceViewParametersManager

The service view parameters manager

_contentViewParametersManager

protected ContentViewParametersManager _contentViewParametersManager

The content view parameters manager

_globalViewParametersManager

protected GlobalViewParametersManager _globalViewParametersManager

The global view parameters manager

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The content type extension point

_viewParametersTypeEP

protected ViewParameterTypeExtensionPoint _viewParametersTypeEP

The view parameters type extension point

_serviceEP

protected ServiceExtensionPoint _serviceEP

The service extension point

Constructor Detail

ViewParametersManager

public ViewParametersManager()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getParametersHolder

public ModifiableModelAwareDataHolder getParametersHolder(JCRRepositoryData parentJCRData,
                                                          ViewParametersModel viewParametersModel)

Get the view parameters holder

Parameters:

parentJCRData - the parent JCR data

viewParametersModel - the view parameters model

Returns:

the view parameters holder

getContentViewParametersHolder

public ModifiableModelAwareDataHolder getContentViewParametersHolder(JCRRepositoryData parentJCRData,
                                                                     String viewName,
                                                                     ViewParametersModel viewParametersModel)

Get the content view parameters holder

Parameters:

parentJCRData - the parent JCR data

viewName - the view name

viewParametersModel - the view parameters model

Returns:

the view parameters holder

getServiceViewParametersHolder

public ModifiableModelAwareDataHolder getServiceViewParametersHolder(JCRRepositoryData parentJCRData,
                                                                     String viewName,
                                                                     ViewParametersModel viewParametersModel)

Get the service view parameters holder

Parameters:

parentJCRData - the parent JCR data

viewName - the view name

viewParametersModel - the view parameters model

Returns:

the view parameters holder

_getJCRRepositoryData

private JCRRepositoryData _getJCRRepositoryData(JCRRepositoryData parentJCRData,
                                                String jcrName)

getTemplateViewParametersModel

public Optional<ViewParametersModel> getTemplateViewParametersModel(String skinId,
                                                                    String templateId)

Get the template view parameters model

Parameters:

skinId - the skin id

templateId - the template id

Returns:

the view parameters

getTemplateViewParametersModel

public Optional<ViewParametersModel> getTemplateViewParametersModel(SkinTemplate skinTemplate)

Get the template view parameters model

Parameters:

skinTemplate - the skin template

Returns:

the view parameters

getZoneViewParametersModel

public Optional<ViewParametersModel> getZoneViewParametersModel(String skinId,
                                                                String templateId,
                                                                String zoneId)

Get the zone view parameters model

Parameters:

skinId - the skin id

templateId - the template id

zoneId - the zone id

Returns:

the view parameters

getZoneViewParametersModel

public Optional<ViewParametersModel> getZoneViewParametersModel(SkinTemplateZone skinTemplateZone)

Get the zone view parameters model

Parameters:

skinTemplateZone - the skin template zone

Returns:

the view parameters

getZoneItemViewParametersModel

public Optional<ViewParametersModel> getZoneItemViewParametersModel(ZoneItem zoneItem)

Get the zone item view parameters model

Parameters:

zoneItem - the zone item

Returns:

the view parameters

getZoneItemViewParametersModel

public Optional<ViewParametersModel> getZoneItemViewParametersModel(String skinId,
                                                                    String templateId,
                                                                    String zoneName)

Get the zone item view parameters model

Parameters:

skinId - the skin id

templateId - the template id

zoneName - the zone name

Returns:

the view parameters

getContentViewParametersModel

public Optional<ViewParametersModel> getContentViewParametersModel(ZoneItem zoneItem)

Get the content view parameters model

Parameters:

zoneItem - the zone item

Returns:

the view parameters

getContentViewParametersModel

public Optional<ViewParametersModel> getContentViewParametersModel(String skinId,
                                                                   Content content,
                                                                   String viewName)

Get the content view parameters model

Parameters:

skinId - the skin id

content - the content

viewName - the view name

Returns:

the view parameters

getContentViewParametersModels

public Map<String,ViewParametersModel> getContentViewParametersModels(String skinId,
                                                                            Content content)

Get all view parameters model for one content

Parameters:

skinId - the skin id

content - the content

Returns:

the map of view parameters model (with the view name)

getContentViewEnumerator

public ElementDefinition<String> getContentViewEnumerator(Content content)

Get a static enumerator with all content view

Parameters:

content - the content

Returns:

the element definition of the enumerator

copyContentViewParameters

public void copyContentViewParameters(ModifiableZoneItem zoneItemSource,
                                      ModifiableZoneItem zoneItemDestination)

Copy content view parameters of the source zone item to the destination zone item

Parameters:

zoneItemSource - the source zone item

zoneItemDestination - the destination zone item

getServiceViewParametersModel

public Optional<ViewParametersModel> getServiceViewParametersModel(ZoneItem zoneItem)

Get the service view parameters model

Parameters:

zoneItem - the zone item

Returns:

the view parameters

getServiceViewParametersModel

public Optional<ViewParametersModel> getServiceViewParametersModel(String skinId,
                                                                   String serviceId,
                                                                   String viewName)

Get the service view parameters model

Parameters:

skinId - the skin id

serviceId - the service id

viewName - the view name

Returns:

the view parameters

getServiceViewParametersModels

public Map<String,ViewParametersModel> getServiceViewParametersModels(String skinId,
                                                                            String serviceId)

Get all view parameters model for one service

Parameters:

skinId - the skin id

serviceId - the service id

Returns:

the map of view parameters model (with the view name)

getServiceViewEnumerator

public ElementDefinition<String> getServiceViewEnumerator(String serviceId)

Get a service enumerator with all content view

Parameters:

serviceId - the service id

Returns:

the element definition of the enumerator

copyServiceViewParameters

public void copyServiceViewParameters(ModifiableZoneItem zoneItemSource,
                                      ModifiableZoneItem zoneItemDestination)

Copy service view parameters of the source zone item to the destination zone item

Parameters:

zoneItemSource - the source zone item

zoneItemDestination - the destination zone item

normalizeViewName

public String normalizeViewName(String viewName)

Normalize the view name (for service view value with /)

Parameters:

viewName - the view name

Returns:

the normalized view name

includeModelItems

public List<ModelItem> includeModelItems(Collection<? extends ModelItem> modelItems,
                                         String prefix,
                                         ViewItemContainer viewItemContainer)

Add model items to the view item container and add prefix to items name

Parameters:

modelItems - the model items

prefix - the prefix

viewItemContainer - the view item container

Returns:

the list of included model items

includeModelItems

public List<ModelItem> includeModelItems(Collection<? extends ModelItem> modelItems,
                                         String prefix,
                                         ViewItemContainer viewItemContainer,
                                         Optional<Integer> index)

Add model items to the view item container and add prefix to items name

Parameters:

modelItems - the model items

prefix - the prefix

viewItemContainer - the view item container

index - index at which the model items have to be included

Returns:

the list of included model items

setDisableConditions

public void setDisableConditions(String elementName,
                                 String conditionValue,
                                 Collection<? extends ModelItem> modelItems)

Set the a disable condition to all model items. These model items will show if the value of the element (elementName) equal the condition value (conditionValue)

Parameters:

elementName - the element name

conditionValue - the condition value

modelItems - the list of model items

getInheritCheckboxElement

public ViewParameter<Boolean> getInheritCheckboxElement(Model model,
                                                        String name)

Get a check box to override inherit parameters

Parameters:

model - the model of the element

name - the name of the check box

Returns:

the element definition of the enumerator

addGlobalViewParameters

public Optional<ViewParametersModel> addGlobalViewParameters(String skinId,
                                                             GlobalViewParametersManager.ViewParametersType type,
                                                             Optional<ViewParametersModel> viewParameters)

Get the global view parameters for the given type and add the view parameters to it

Parameters:

skinId - the skin id

type - the type

viewParameters - the view parameters

Returns:

the new view parameters (with global view parameters)

getTemplateViewParameterHolderWithInheritance

public Optional<ViewParametersManager.ViewParameterHolder> getTemplateViewParameterHolderWithInheritance(Page page,
                                                                                                         String parameterPath)

Get the parameter holder with the effective parameter path for a view parameter of a template, taking into account the inheritance. The parameter path can be different in case of inheritance.

Parameters:

page - the page

parameterPath - the initial parameter path.

Returns:

the ViewParametersManager.ViewParameterHolder for this page and parameter

getTemplateViewParameterHolderWithInheritance

public Optional<ViewParametersManager.ViewParameterHolder> getTemplateViewParameterHolderWithInheritance(Page page,
                                                                                                         ModelItem modelItem)

Get the parameter holder with the effective parameter path for a view parameter of a template, taking into account the inheritance. The parameter path can be different in case of inheritance.

Parameters:

page - the page

modelItem - the model item of parameter

Returns:

the ViewParametersManager.ViewParameterHolder for this page and parameter

_getTemplateViewParameterHolderWithInheritance

protected Optional<ViewParametersManager.ViewParameterHolder> _getTemplateViewParameterHolderWithInheritance(Page page,
                                                                                                             ViewParameter viewParameter,
                                                                                                             String parameterPath)

Get the parameter holder with the effective parameter path for a view parameter of a template, taking into account the inheritance. The parameter path can be different in case of inheritance.

Parameters:

page - the page

viewParameter - the view parameter

parameterPath - the parameter path.

Returns:

the ViewParametersManager.ViewParameterHolder for this page and parameter

getZoneViewParameterHolderWithInheritance

public Optional<ViewParametersManager.ViewParameterHolder> getZoneViewParameterHolderWithInheritance(Page page,
                                                                                                     Zone zone,
                                                                                                     String parameterPath)

Get the parameter holder with the effective parameter path for a view parameter of a zone, taking into account the inheritance. The parameter path can be different in case of inheritance.

Parameters:

page - the page

zone - the zone

parameterPath - the initial parameter path.

Returns:

the ViewParametersManager.ViewParameterHolder for this page, zone and parameter

getZoneViewParameterHolderWithInheritance

public Optional<ViewParametersManager.ViewParameterHolder> getZoneViewParameterHolderWithInheritance(Page page,
                                                                                                     Zone zone,
                                                                                                     ModelItem modelItem)

Get the parameter holder with the effective parameter path for a view parameter of a zone, taking into account the inheritance. The parameter path can be different in case of inheritance.

Parameters:

page - the page

zone - the zone

modelItem - the model item of the parameter

Returns:

the ViewParametersManager.ViewParameterHolder for this page, zone and parameter

_getZoneViewParameterHolderWithInheritance

protected Optional<ViewParametersManager.ViewParameterHolder> _getZoneViewParameterHolderWithInheritance(Page page,
                                                                                                         Zone zone,
                                                                                                         ViewParameter viewParameter,
                                                                                                         String parameterPath)

Get the parameter holder with the effective parameter path for a view parameter of a zone, taking into account the inheritance. The parameter path can be different in case of inheritance.

Parameters:

page - the page

zone - the zone

viewParameter - the view parameter

parameterPath - the parameter path.

Returns:

the ViewParametersManager.ViewParameterHolder for this page, zone and parameter

getContentViewParametersHolder

public Optional<ModelAwareDataHolder> getContentViewParametersHolder(ZoneItem zoneItem)

Get content view parameters holder from the zone item

Parameters:

zoneItem - the zone item

Returns:

the data holder

getServiceViewParametersHolder

public Optional<ModelAwareDataHolder> getServiceViewParametersHolder(ZoneItem zoneItem)

Get service view parameters holder from the zone item

Parameters:

zoneItem - the zone item

Returns:

the data holder

getTemplateParameterValue

public <T> T getTemplateParameterValue(Page page,
                                       String parameterPath)

Get the template parameter value

Type Parameters:

T - type of the value to retrieve

Parameters:

page - the page

parameterPath - the parameter path

Returns:

the template parameter value. Can be null.

getZoneParameterValue

public <T> T getZoneParameterValue(Page page,
                                   Zone zone,
                                   String parameterPath)

Get the zone parameter value

Type Parameters:

T - type of the value to retrieve

Parameters:

page - the page

zone - the zone

parameterPath - the parameter path

Returns:

the zone parameter value. Can be null.

getZoneItemParameterValue

public <T> T getZoneItemParameterValue(ZoneItem zoneItem,
                                       String parameterPath)

Get the zone item parameter value

Type Parameters:

T - type of the value to retrieve

Parameters:

zoneItem - the zone item

parameterPath - the parameter path

Returns:

the zone item parameter value. Can be null.

getContentParameterValue

public <T> T getContentParameterValue(ZoneItem zoneItem,
                                      String viewName,
                                      String parameterPath)

Get the content parameter value

Type Parameters:

T - type of the value to retrieve

Parameters:

zoneItem - the zone item

viewName - the content view name

parameterPath - the parameter path

Returns:

the content parameter value. Can be null.

getServiceParameterValue

public <T> T getServiceParameterValue(ZoneItem zoneItem,
                                      String viewName,
                                      String parameterPath)

Get the service parameter value

Type Parameters:

T - type of the value to retrieve

Parameters:

zoneItem - the zone item

viewName - the service view name

parameterPath - the parameter path

Returns:

the service parameter value. Can be null.

_addViewItems

private void _addViewItems(View sourceView,
                           View destView)

_addParameters

private void _addParameters(Collection<? extends ModelItem> modelItems,
                            ViewParametersModel viewParametersModel)

_getViewParamaterHolder

private Optional<ViewParametersManager.ViewParameterHolder> _getViewParamaterHolder(ModelAwareDataHolder dataHolder,
                                                                                    String parameterPath)