Package 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	Description
static final String	DEFAULT_FILE_NAME
static final String	TEMP_FILE_EXTENSION
static final String	TEMP_FILE_PREFIX
static final String	VELOCITY_CTX_CONFIG_NAME
static final String	VELOCITY_CTX_GENERATED_BY
static final String	VELOCITY_CTX_GENERATED_FOR
static final String	VELOCITY_CTX_GENERATED_TIMESTAMP
static final String	VELOCITY_CTX_REPORT_NAME
static final String	VELOCITY_CTX_REPORTS	Key under which a Velocity context stores a collection with ReportView objects.
static final 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	Description
DefaultReportViewConverterStrategy()

Method Summary

Modifier and Type	Method	Description
protected List<ReportConversionData>	convert(List<ReportView> reports, RendererTemplateModel template, Map<String,Object> context)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811
List<ReportConversionData>	convert(Stream<ReportView> reports, RendererTemplateModel template, Map<String,Object> context)
protected ReportConversionData	convertUsingTemplate(RendererTemplateModel template, Map<String,Object> conversionContext)	Converts the given reports to html format.
protected Map<String,Object>	createConversionContext(List<ReportView> reports, Map<String,Object> context)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811
protected Map<String,Object>	createConversionContext(Map<String,Object> context)	Create context for conversion.
Collection<org.apache.velocity.runtime.directive.Directive>	getCustomDirectives()
I18NService	getI18NService()
protected RendererService	getRendererService()
String	getReportName()
SessionService	getSessionService()
protected ReportViewConverterStrategy	getTextConverterStrategy()
protected Map<String,Object>	prepareAdditionalContext(Map<String,Object> context)	Prepares a Velocity context.
protected void	registerRequiredCustomDirectives()
void	setCustomDirectives(Collection<org.apache.velocity.runtime.directive.Directive> customDirectives)
void	setI18NService(I18NService i18NService)
void	setRendererService(RendererService rendererService)
void	setReportName(String reportName)	Sets a name of the report.
void	setSessionService(SessionService sessionService)
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, convert

Methods inherited from class java.lang.Object

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

Field Details

VELOCITY_CTX_REPORTS

public static final 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 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 String VELOCITY_CTX_GENERATED_TIMESTAMP

See Also:

• Constant Field Values

VELOCITY_CTX_GENERATED_BY

public static final String VELOCITY_CTX_GENERATED_BY

See Also:

• Constant Field Values

VELOCITY_CTX_GENERATED_FOR

public static final String VELOCITY_CTX_GENERATED_FOR

See Also:

• Constant Field Values

VELOCITY_CTX_REPORT_NAME

public static final String VELOCITY_CTX_REPORT_NAME

See Also:

• Constant Field Values

VELOCITY_CTX_CONFIG_NAME

public static final String VELOCITY_CTX_CONFIG_NAME

See Also:

• Constant Field Values

DEFAULT_FILE_NAME

public static final String DEFAULT_FILE_NAME

See Also:

• Constant Field Values

TEMP_FILE_EXTENSION

public static final String TEMP_FILE_EXTENSION

See Also:

• Constant Field Values

TEMP_FILE_PREFIX

public static final String TEMP_FILE_PREFIX

See Also:

• Constant Field Values

Constructor Details

DefaultReportViewConverterStrategy

public DefaultReportViewConverterStrategy()

Method Details

convert

@Deprecated(since="1811",
            forRemoval=true)
protected List<ReportConversionData> convert(List<ReportView> reports,
 RendererTemplateModel template,
 Map<String,Object> context)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811

Description copied from class: AbstractTemplateViewConverterStrategy

Caution: as this method will be removed AbstractTemplateViewConverterStrategy.convert(java.util.stream.Stream, de.hybris.platform.commons.model.renderer.RendererTemplateModel, java.util.Map) will become abstract.

Specified by:

convert in class AbstractTemplateViewConverterStrategy

convert

public List<ReportConversionData> convert(Stream<ReportView> reports,
 RendererTemplateModel template,
 Map<String,Object> context)

Overrides:

convert in class AbstractTemplateViewConverterStrategy

createConversionContext

protected Map<String,Object> createConversionContext(Map<String,Object> context)

Create context for conversion.

Parameters:

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

Returns:

context prepared to perform conversion

createConversionContext

@Deprecated(since="1811",
            forRemoval=true)
protected Map<String,Object> createConversionContext(List<ReportView> reports,
 Map<String,Object> context)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811

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,
 Map<String,Object> conversionContext)

Converts the given reports to html format.

Parameters:

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

conversionContext - conversion context.

Returns:

an object representing a generated report file.

registerRequiredCustomDirectives

protected void registerRequiredCustomDirectives()

prepareAdditionalContext

protected Map<String,Object> prepareAdditionalContext(Map<String,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 String getReportName()

setReportName

public void setReportName(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)

getSessionService

public SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getI18NService

public I18NService getI18NService()

setI18NService

public void setI18NService(I18NService i18NService)

getCustomDirectives

public Collection<org.apache.velocity.runtime.directive.Directive> getCustomDirectives()

setCustomDirectives

public void setCustomDirectives(Collection<org.apache.velocity.runtime.directive.Directive> customDirectives)