de.hybris.platform.auditreport.service.impl

Class DefaultReportViewConverterStrategy

java.lang.Object

de.hybris.platform.auditreport.service.impl.AbstractTemplateViewConverterStrategy

de.hybris.platform.auditreport.service.impl.DefaultReportViewConverterStrategy

All Implemented Interfaces:

ReportViewConverterStrategy

public class DefaultReportViewConverterStrategy
extends AbstractTemplateViewConverterStrategy

The strategy generates reports by using Apache Velocity templates. Velocity templates can operate on java object (collection with reports, key VELOCITY_CTX_REPORTS) or text representation of that java object (generated by an implementation of the ReportViewConverterStrategy, key VELOCITY_CTX_REPORTS_TEXT).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FILE_NAME
static java.lang.String	VELOCITY_CTX_CONFIG_NAME
static java.lang.String	VELOCITY_CTX_GENERATED_BY
static java.lang.String	VELOCITY_CTX_GENERATED_FOR
static java.lang.String	VELOCITY_CTX_GENERATED_TIMESTAMP
static java.lang.String	VELOCITY_CTX_REPORT_NAME
static java.lang.String	VELOCITY_CTX_REPORTS Key under which a Velocity context stores a collection with ReportView objects.
static java.lang.String	VELOCITY_CTX_REPORTS_TEXT Key under which a Velocity context stores text representation of the collection with ReportView objects.

Fields inherited from class de.hybris.platform.auditreport.service.impl.AbstractTemplateViewConverterStrategy

CTX_CONFIG_NAME, CTX_CURRENT_USER, CTX_REPORT_ID, CTX_ROOT_ITEM, CTX_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
DefaultReportViewConverterStrategy()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<ReportConversionData>	convert(java.util.List<ReportView> reports, RendererTemplateModel template, java.util.Map<java.lang.String,java.lang.Object> context)
protected ReportConversionData	convertUsingTemplate(RendererTemplateModel template, java.lang.Object conversionContext) Converts the given reports to list to HTML format.
protected java.util.Map<java.lang.String,java.lang.Object>	createConversionContext(java.util.List<ReportView> reports, java.util.Map<java.lang.String,java.lang.Object> context) Create context for conversion.
protected RendererService	getRendererService()
java.lang.String	getReportName()
protected ReportViewConverterStrategy	getTextConverterStrategy()
protected java.util.Map<java.lang.String,java.lang.Object>	prepareAdditionalContext(java.util.Map<java.lang.String,java.lang.Object> context) Prepares a Velocity context.
void	setRendererService(RendererService rendererService)
void	setReportName(java.lang.String reportName) Sets a name of the report.
void	setTextConverterStrategy(ReportViewConverterStrategy textConverterStrategy) Sets an implementation of the ReportViewConverterStrategy which generates text representation of the report.

Methods inherited from class de.hybris.platform.auditreport.service.impl.AbstractTemplateViewConverterStrategy

convert

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VELOCITY_CTX_REPORTS

public static final java.lang.String VELOCITY_CTX_REPORTS

Key under which a Velocity context stores a collection with ReportView objects.

See Also:

Constant Field Values

VELOCITY_CTX_REPORTS_TEXT

public static final java.lang.String VELOCITY_CTX_REPORTS_TEXT

Key under which a Velocity context stores text representation of the collection with ReportView objects.

See Also:

VELOCITY_CTX_REPORTS, Constant Field Values

VELOCITY_CTX_GENERATED_TIMESTAMP

public static final java.lang.String VELOCITY_CTX_GENERATED_TIMESTAMP

See Also:

Constant Field Values

VELOCITY_CTX_GENERATED_BY

public static final java.lang.String VELOCITY_CTX_GENERATED_BY

See Also:

Constant Field Values

VELOCITY_CTX_GENERATED_FOR

public static final java.lang.String VELOCITY_CTX_GENERATED_FOR

See Also:

Constant Field Values

VELOCITY_CTX_REPORT_NAME

public static final java.lang.String VELOCITY_CTX_REPORT_NAME

See Also:

Constant Field Values

VELOCITY_CTX_CONFIG_NAME

public static final java.lang.String VELOCITY_CTX_CONFIG_NAME

See Also:

Constant Field Values

DEFAULT_FILE_NAME

public static final java.lang.String DEFAULT_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultReportViewConverterStrategy

public DefaultReportViewConverterStrategy()

Method Detail

convert

protected java.util.List<ReportConversionData> convert(java.util.List<ReportView> reports,
                                                       RendererTemplateModel template,
                                                       java.util.Map<java.lang.String,java.lang.Object> context)

Specified by:

convert in class AbstractTemplateViewConverterStrategy

createConversionContext

protected java.util.Map<java.lang.String,java.lang.Object> createConversionContext(java.util.List<ReportView> reports,
                                                                                   java.util.Map<java.lang.String,java.lang.Object> context)

Create context for conversion.

Parameters:

reports - generated report view

context - a map used to pass in additional jsonData needed by the strategy.

Returns:

context prepared to perform conversion

convertUsingTemplate

protected ReportConversionData convertUsingTemplate(RendererTemplateModel template,
                                                    java.lang.Object conversionContext)

Converts the given reports to list to HTML format.

Parameters:

template - template used to convert the raw data into desired format.

conversionContext - the list of report jsonData to convert.

Returns:

an object representing a collection of generated files.

prepareAdditionalContext

protected java.util.Map<java.lang.String,java.lang.Object> prepareAdditionalContext(java.util.Map<java.lang.String,java.lang.Object> context)

Prepares a Velocity context.

Parameters:

context - original context passed to the AbstractTemplateViewConverterStrategy.convert(List, Map) method.

Returns:

VelocityContext containing the generation timestamp, report id, configuration name and user names (generated by and for).

getReportName

public java.lang.String getReportName()

setReportName

public void setReportName(java.lang.String reportName)

Sets a name of the report. By default the strategy uses DEFAULT_FILE_NAME.

Parameters:

reportName - the report name.

getTextConverterStrategy

protected ReportViewConverterStrategy getTextConverterStrategy()

setTextConverterStrategy

public void setTextConverterStrategy(ReportViewConverterStrategy textConverterStrategy)

Sets an implementation of the ReportViewConverterStrategy which generates text representation of the report.

Parameters:

textConverterStrategy - the strategy which produces text representation of the report.

getRendererService

protected RendererService getRendererService()

setRendererService

public void setRendererService(RendererService rendererService)