Package org.ametys.plugins.odfpilotage.helper

Class CostComputationTreeHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentstree.ContentsTreeHelper

org.ametys.odf.tree.ODFContentsTreeHelper

org.ametys.plugins.odfpilotage.helper.ODFContentsTreeHelper

org.ametys.plugins.odfpilotage.helper.CostComputationTreeHelper

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class CostComputationTreeHelper
extends ODFContentsTreeHelper
implements Contextualizable

This component handle the content of the cost modeling tool

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	Workflow helper component
protected Context	_context	The context
protected CostComputationComponent	_costComputationComponent	The cost computation component
protected I18nUtils	_i18nUtils	The I18N utils

Fields inherited from class org.ametys.odf.tree.ODFContentsTreeHelper

_odfHelper, _shareableCourseHelper, _shareableStatusHelper, _workflowProvider, ROLE

Fields inherited from class org.ametys.plugins.contentstree.ContentsTreeHelper

_ametysResolver, _contentTypesEP, _contentTypesHelper, _treeExtensionPoint

Constructor Summary

Constructors

Constructor	Description
CostComputationTreeHelper()

Method Summary

Modifier and Type	Method	Description
protected Map<String,List<Content>>	_getChildrenContent(Content parentContent, TreeConfiguration treeConfiguration, String catalog, String lang)	Get the children contents according the tree configuration
protected CostComputationData	_getCostData()	Get the cost data from user session
protected void	_launchCostComputation(Content content, String catalog, String lang, OverriddenData overriddenData)	Launch the cost computation component algorithm
protected void	_setCostData(CostComputationData costData)	Set the cost data to user session
protected Map<String,Object>	content2Json(Content content, String contentPath)	Get the default JSON representation of a content of the tree
void	contextualize(Context context)
Map<String,Object>	getChildrenContent(String contentId, String treeId, String contentPath, String catalog, String lang)	Get the children contents according the tree configuration
Map<String,Object>	getNodeInformations(String contentId, String catalog, String lang, Map<String,Map<String,String>> overriddenData)	Get the node informations
Map<String,Object>	getOldData()	Retrieve old data to compare with the new computed one
Map<String,Object>	getRootNodeInformations(String contentId, String catalog, String lang, Map<String,Map<String,String>> overriddenData)	Get the root node informations
Map<String,Map<String,Object>>	refresh(Map<String,String> contentsToRefresh, String contentId, String catalog, String lang, Map<String,Map<String,String>> overriddenData)	Launch the cost computation component algorithm with overridden data by the user
Map<String,Object>	saveOverriddenData(Map<String,Map<String,String>> overriddenData)	Save overridden data to the contents
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.plugins.odfpilotage.helper.ODFContentsTreeHelper

content2Json

Methods inherited from class org.ametys.odf.tree.ODFContentsTreeHelper

getProgramItemDisplayCode, getRootNodeInformations, getShareableStatus, getWorkflowStep, isContentMatching, isShared, isSharedByParents

Methods inherited from class org.ametys.plugins.contentstree.ContentsTreeHelper

_getParentContent, _getTreeConfiguration, childContent2Json, filterChildrenContentByRegExp, getChildrenContent, getChildrenContent, getNodeInformations, hasChildrenContent

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 Details

_costComputationComponent

protected CostComputationComponent _costComputationComponent

The cost computation component

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

Workflow helper component

_i18nUtils

protected I18nUtils _i18nUtils

The I18N utils

_context

protected Context _context

The context

Constructor Details

CostComputationTreeHelper

public CostComputationTreeHelper()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ODFContentsTreeHelper

Throws:

ServiceException

_getCostData

protected CostComputationData _getCostData()

Get the cost data from user session

Returns:

the cost data

_setCostData

protected void _setCostData(CostComputationData costData)

Set the cost data to user session

Parameters:

costData - the cost data

_launchCostComputation

protected void _launchCostComputation(Content content,
 String catalog,
 String lang,
 OverriddenData overriddenData)

Launch the cost computation component algorithm

Parameters:

content - the content to compute

catalog - the catalog

lang - the lang

overriddenData - overridden data by the user

_getChildrenContent

protected Map<String,List<Content>> _getChildrenContent(Content parentContent,
 TreeConfiguration treeConfiguration,
 String catalog,
 String lang)

Get the children contents according the tree configuration

Parameters:

parentContent - the root content

treeConfiguration - the tree configuration

catalog - the catalog

lang - the lang

Returns:

the children content for each child attributes

getChildrenContent

public Map<String,Object> getChildrenContent(String contentId,
 String treeId,
 String contentPath,
 String catalog,
 String lang)

Get the children contents according the tree configuration

Parameters:

contentId - the parent content

treeId - the tree configuration

contentPath - the content path

catalog - the catalog

lang - the lang

Returns:

the children content

getRootNodeInformations

public Map<String,Object> getRootNodeInformations(String contentId,
 String catalog,
 String lang,
 Map<String,Map<String,String>> overriddenData)

Get the root node informations

Parameters:

contentId - The content

catalog - the catalog

lang - the lang

overriddenData - overridden data by the user

Returns:

The informations

getNodeInformations

public Map<String,Object> getNodeInformations(String contentId,
 String catalog,
 String lang,
 Map<String,Map<String,String>> overriddenData)

Get the node informations

Parameters:

contentId - The content

catalog - the catalog

lang - the lang

overriddenData - Overridden data by the user

Returns:

The informations

content2Json

protected Map<String,Object> content2Json(Content content,
 String contentPath)

Get the default JSON representation of a content of the tree

Parameters:

content - the content

contentPath - the content path

Returns:

the content as JSON

refresh

public Map<String,Map<String,Object>> refresh(Map<String,String> contentsToRefresh,
 String contentId,
 String catalog,
 String lang,
 Map<String,Map<String,String>> overriddenData)

Launch the cost computation component algorithm with overridden data by the user

Parameters:

contentsToRefresh - all open contents in the tool to refresh

contentId - the root node

catalog - the catalog

lang - the lang

overriddenData - overridden data by the user

Returns:

new values associated with their path

getOldData

public Map<String,Object> getOldData()

Retrieve old data to compare with the new computed one

Returns:

all old data to compare

saveOverriddenData

public Map<String,Object> saveOverriddenData(Map<String,Map<String,String>> overriddenData)

Save overridden data to the contents

Parameters:

overriddenData - overridden data by the user

Returns:

true if the saving is successful