Package com.xwiki.projectmanagement.chart.displayer

Interface ChartTypeDisplayer

@Unstable
@Role
public interface ChartTypeDisplayer

Defines the template for a chart type displayer. These displayers will be used by the chart macro.

Since:

1.2.0-rc-1

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
List<org.xwiki.rendering.block.Block>	execute(List<com.xwiki.projectmanagement.model.PaginatedResult<com.xwiki.projectmanagement.model.WorkItem>> workItems, String property, List<String> labels, org.xwiki.rendering.transformation.MacroTransformationContext transformationContext, Object typeDisplayerParams)
Map<String,Object>	getParameterTypeTemplate()
Map<String,List<String>>	getParameterTypeValues()

Method Detail

execute

List<org.xwiki.rendering.block.Block> execute(List<com.xwiki.projectmanagement.model.PaginatedResult<com.xwiki.projectmanagement.model.WorkItem>> workItems,
                                              String property,
                                              List<String> labels,
                                              org.xwiki.rendering.transformation.MacroTransformationContext transformationContext,
                                              Object typeDisplayerParams)
                                       throws org.xwiki.rendering.macro.MacroExecutionException

Parameters:

workItems - a list of work items that will be used to display the chart.

property - the main property that will be used to generate the chart on.

labels - the labels associated to each set of work items.

transformationContext - the transformation context of the macro.

typeDisplayerParams - the configuration class for the implementing displayer. It should have the same type as the getParameterTypeTemplate() return value.

Returns:

a list of blocks ready for rendering.

Throws:

org.xwiki.rendering.macro.MacroExecutionException - in case of errors.

getParameterTypeTemplate

Map<String,Object> getParameterTypeTemplate()

Returns:

the class of the configuration used by the implementer.

getParameterTypeValues

Map<String,List<String>> getParameterTypeValues()

Returns:

a map containing the attributes of getParameterTypeTemplate() as keys and a list of possible values for said attribute as values.