Package org.ametys.odf.tree

Class ODFContentsTreeHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentstree.ContentsTreeHelper

org.ametys.odf.tree.ODFContentsTreeHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

ContentsWithViewTreeGridHelper, CostComputationTreeHelper, CoursePartsTreeHelper

public class ODFContentsTreeHelper
extends ContentsTreeHelper

Helper ODF contents tree adding indicators

Field Summary

Fields

Modifier and Type	Field	Description
protected ODFTreeIndicatorExtensionPoint	_odfTreeIndicatorEP	Extension point for indicators
static final String	ROLE	The Avalon role

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

_ametysResolver, _contentTypesEP, _contentTypesHelper, _treeExtensionPoint

Constructor Summary

Constructors

Constructor	Description
ODFContentsTreeHelper()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	content2Json(Content content)	Get the default JSON representation of a content of the tree
protected Map<String,Object>	getIndicatorData(Content content)	Get the indicator data to JSON format
<T extends ProgramItem & Content> String	getProgramItemDisplayCode(T programItem)	Get the ProgramItem code we want to display.
protected boolean	isContentMatching(Content content, String value)	Determines if content matches the filter regexp
void	service(ServiceManager smanager)

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

_addChildren, _getParentContent, _getTreeConfiguration, childContent2Json, filterChildrenContentByRegExp, getChildrenContent, getChildrenContent, getNodeInformations, getRootNodeInformations, hasAutoExpandTargets, hasChildrenContent, isAnAutoExpandTarget

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

ROLE

public static final String ROLE

The Avalon role

_odfTreeIndicatorEP

protected ODFTreeIndicatorExtensionPoint _odfTreeIndicatorEP

Extension point for indicators

Constructor Details

ODFContentsTreeHelper

public ODFContentsTreeHelper()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ContentsTreeHelper

Throws:

ServiceException

content2Json

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

Description copied from class: ContentsTreeHelper

Get the default JSON representation of a content of the tree

Overrides:

content2Json in class ContentsTreeHelper

Parameters:

content - the content

Returns:

the content as JSON

getIndicatorData

protected Map<String,Object> getIndicatorData(Content content)

Get the indicator data to JSON format

Parameters:

content - the contet

Returns:

the indicator data to JSON format

getProgramItemDisplayCode

public <T extends ProgramItem & Content> String getProgramItemDisplayCode(T programItem)

Get the ProgramItem code we want to display.

Type Parameters:

T - The type of the program element, should be a subclasse of ProgramItem and Content

Parameters:

programItem - The program item

Returns:

The code to display

isContentMatching

protected boolean isContentMatching(Content content,
 String value)

Description copied from class: ContentsTreeHelper

Determines if content matches the filter regexp

Overrides:

isContentMatching in class ContentsTreeHelper

Parameters:

content - the content

value - the value to match

Returns:

true if the content match