org.ametys.cms.scripts

Class CmsScriptHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.ui.script.ScriptHandler

org.ametys.cms.scripts.CmsScriptHandler

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class CmsScriptHandler
extends ScriptHandler

Content aware script handler using search model

Field Summary

Fields

Modifier and Type	Field and Description
private ContentHelper	_contentHelper
private ContentTypeExtensionPoint	_contentTypeExtensionPoint
private ContentTypesHelper	_contentTypesHelper
private ServiceManager	_manager
private SearchUIModelExtensionPoint	_searchUIModelEP
private SearchUIModelHelper	_searchUIModelHelper
private ServerCommHelper	_serverCommHelper
private SystemPropertyExtensionPoint	_systemPropEP
private ContentValuesExtractorFactory	_valuesExtractorFactory

Fields inherited from class org.ametys.plugins.core.ui.script.ScriptHandler

_context, _currentUserProvider, _rightManager, _scriptBindingEP

Constructor Summary

Constructors

Constructor and Description
CmsScriptHandler()

Method Summary

Modifier and Type	Method and Description
private void	_addColumnsConfiguration(Collection<String> columns, ContentType cTypeCommonAncestor, MutableConfiguration columnsDefaultConf)
protected SearchUIModel	_createModel(ThreadSafeComponentManager<SearchUIModel> localSearchModelManager, String defaultModelId, Collection<String> columns, Collection<Content> contents) Create and return a dynamic model based on desired columns or return a default model.
private SearchUIModel	_getOrCreateModel(Map columns, List<Content> contents, String defaultModelId)
protected void	_handleColumnConfiguration(MutableConfiguration columnConf, String column) Add/modify column configuration
private Object	_processScriptResult(Map<String,Object> results, List<ScriptBinding> scriptBindings, Object scriptResult)
private List<String>	_processScriptResultContents(Map<String,Object> results, Map scriptResultMap)
protected Map<String,Object>	content2Json(Content content, Collection<SearchUIColumn> searchColumns, ContentValuesExtractorFactory.SearchModelContentValuesExtractor extractor) Convert content to json
protected Object	processScriptResult(Map<String,Object> results, List<ScriptBinding> scriptBindings, Object scriptResult) Process the result of the script
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.plugins.core.ui.script.ScriptHandler

contextualize, executeScript, executeScript, getScriptBindingDescription, getScriptBindings

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

_searchUIModelHelper

private SearchUIModelHelper _searchUIModelHelper

_searchUIModelEP

private SearchUIModelExtensionPoint _searchUIModelEP

_contentTypesHelper

private ContentTypesHelper _contentTypesHelper

_contentTypeExtensionPoint

private ContentTypeExtensionPoint _contentTypeExtensionPoint

_systemPropEP

private SystemPropertyExtensionPoint _systemPropEP

_serverCommHelper

private ServerCommHelper _serverCommHelper

_manager

private ServiceManager _manager

_valuesExtractorFactory

private ContentValuesExtractorFactory _valuesExtractorFactory

_contentHelper

private ContentHelper _contentHelper

Constructor Detail

CmsScriptHandler

public CmsScriptHandler()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ScriptHandler

Throws:

ServiceException

processScriptResult

protected Object processScriptResult(Map<String,Object> results,
                                     List<ScriptBinding> scriptBindings,
                                     Object scriptResult)
                              throws ScriptException

Description copied from class: ScriptHandler

Process the result of the script

Overrides:

processScriptResult in class ScriptHandler

Parameters:

results - The results map, available to fill

scriptBindings - The script bindings

scriptResult - The result of the script

Returns:

The result processed

Throws:

ScriptException - If an exception occurred

_getOrCreateModel

private SearchUIModel _getOrCreateModel(Map columns,
                                        List<Content> contents,
                                        String defaultModelId)
                                 throws Exception,
                                        ProcessingException

Throws:

Exception

ProcessingException

_createModel

protected SearchUIModel _createModel(ThreadSafeComponentManager<SearchUIModel> localSearchModelManager,
                                     String defaultModelId,
                                     Collection<String> columns,
                                     Collection<Content> contents)
                              throws Exception

Create and return a dynamic model based on desired columns or return a default model.

Parameters:

localSearchModelManager - The local search manager

defaultModelId - The default model id

columns - The columns

contents - The contents

Returns:

The search model

Throws:

Exception - If an error occurred

_processScriptResult

private Object _processScriptResult(Map<String,Object> results,
                                    List<ScriptBinding> scriptBindings,
                                    Object scriptResult)
                             throws ScriptException

Throws:

ScriptException

_processScriptResultContents

private List<String> _processScriptResultContents(Map<String,Object> results,
                                                  Map scriptResultMap)

_addColumnsConfiguration

private void _addColumnsConfiguration(Collection<String> columns,
                                      ContentType cTypeCommonAncestor,
                                      MutableConfiguration columnsDefaultConf)

_handleColumnConfiguration

protected void _handleColumnConfiguration(MutableConfiguration columnConf,
                                          String column)

Add/modify column configuration

Parameters:

columnConf - The mutable configuration object that will be used to create the column.

column - The column identifier

content2Json

protected Map<String,Object> content2Json(Content content,
                                          Collection<SearchUIColumn> searchColumns,
                                          ContentValuesExtractorFactory.SearchModelContentValuesExtractor extractor)

Convert content to json

Parameters:

content - The content

searchColumns - The columns, to know which value to fill

extractor - The properties extractor

Returns:

The json data