Package 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

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.core.ui.script.ScriptHandler

ScriptHandler.ResultProcessor

Field Summary

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

_context, _currentUserProvider, _i18nUtils, _rightManager, _scriptBindingEP, RIGHT_EXECUTE_SCRIPTS, ROLE

Constructor Summary

Constructors

Constructor	Description
CmsScriptHandler()

Method Summary

Modifier and Type	Method	Description
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.
protected void	_handleColumnConfiguration(MutableConfiguration columnConf, String column)	Add/modify column configuration
protected ScriptExecArguments	buildExecArguments(Map<String,Object> arguments)	Builds the ScriptExecArguments object from the untyped JS object (seen as a Map in Java)
Map<String,Object>	content2Json(Content content, Collection<SearchUIColumn> searchColumns, ContentValuesExtractorFactory.SearchModelContentValuesExtractor extractor)	Convert content to json
SearchUIModel	getOrCreateModel(Collection<String> columns, List<Content> contents, String defaultModelId)	Computes the model associated with the given contents and result columns. Used by scripts functions creating reports or search results.
protected ScriptHandler.ResultProcessor	getProcessor()	Returns the ScriptHandler.ResultProcessor used to process script result.
protected Object	processScriptResult(Map<String,Object> results, Object scriptResult, ScriptExecArguments execArgs)	Process the result of the script
void	service(ServiceManager serviceManager)

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

_executeScript, contextualize, executeScript, executeScript, executeScript, getScriptBindingDescription, getWorkspaceName

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

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

buildExecArguments

protected ScriptExecArguments buildExecArguments(Map<String,Object> arguments)

Description copied from class: ScriptHandler

Builds the ScriptExecArguments object from the untyped JS object (seen as a Map in Java)

Overrides:

buildExecArguments in class ScriptHandler

Parameters:

arguments - The untyped JS object

Returns:

the ScriptExecArguments

processScriptResult

protected Object processScriptResult(Map<String,Object> results,
                                     Object scriptResult,
                                     ScriptExecArguments execArgs)

Description copied from class: ScriptHandler

Process the result of the script

Overrides:

processScriptResult in class ScriptHandler

Parameters:

results - The results map, available to fill

scriptResult - The result of the script

execArgs - The script execution arguments

Returns:

The processed result

getProcessor

protected ScriptHandler.ResultProcessor getProcessor()

Description copied from class: ScriptHandler

Returns the ScriptHandler.ResultProcessor used to process script result.

Overrides:

getProcessor in class ScriptHandler

Returns:

the ScriptHandler.ResultProcessor.

getOrCreateModel

public SearchUIModel getOrCreateModel(Collection<String> columns,
                                      List<Content> contents,
                                      String defaultModelId)
                               throws Exception

Computes the model associated with the given contents and result columns.
Used by scripts functions creating reports or search results.

Parameters:

columns - the columns of the results

contents - the contents for the results (one content per line)

defaultModelId - the fallback model

Returns:

the computed search model

Throws:

Exception - if something went wrong.

_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

_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

public 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