pulse - the web application framework Get pulse at SourceForge.net. Fast, secure and Free Open Source software downloads Ohloh project report for pulse-java

org.torweg.pulse.component.statistics.view
Interface IStatisticsPDFReportController<T extends AbstractStatisticsViewControllerResult<?>>

Type Parameters:
T - the underlying implementation of AbstractStatisticsViewControllerResult<?>
All Superinterfaces:
Configurable<AbstractStatisticsViewControllerConfiguration>
All Known Implementing Classes:
GroupAnalysisViewReportController, OverViewReportController, RefererAnalysisViewReportController, TechnicalInformationViewReportController, TimeAnalysisViewReportController

public interface IStatisticsPDFReportController<T extends AbstractStatisticsViewControllerResult<?>>
extends Configurable<AbstractStatisticsViewControllerConfiguration>

Marks a AbstractStatisticsViewController<?,?,?> as being able to generating a PDF-report.

Version:
$Revision: 1914 $
Author:
Daniel Dietz

Method Summary
 java.util.Map<java.lang.String,java.io.File> buildPDFFileMap(AbstractStatisticsViewControllerResult<?> result)
          Returns a map which maps filenames to Files required/used for the creation of the PDF.
 T buildPDFReportResult(Duration duration, Period dataResolution, StatisticsServer server, org.hibernate.Session s)
          Returns an AbstractStatisticsViewControllerResult as required for the creation the PDF for the given Duration, the given Period and the given StatisticsServer .
 T generatePDFReport(ServiceRequest request)
          Generates a PDF-report.
 
Methods inherited from interface org.torweg.pulse.configuration.Configurable
initialize
 

Method Detail

generatePDFReport

T generatePDFReport(ServiceRequest request)
Generates a PDF-report.

The action - should be annotated accordingly.

Parameters:
request - the current ServicecRequest
Returns:
an AbstractStatisticsViewControllerResult<?>

buildPDFFileMap

java.util.Map<java.lang.String,java.io.File> buildPDFFileMap(AbstractStatisticsViewControllerResult<?> result)
Returns a map which maps filenames to Files required/used for the creation of the PDF.

NOTE: null permitted

Parameters:
result - the current result
Returns:
a map which maps the filenames to the Files or null

buildPDFReportResult

T buildPDFReportResult(Duration duration, Period dataResolution, StatisticsServer server,
                       org.hibernate.Session s)
Returns an AbstractStatisticsViewControllerResult as required for the creation the PDF for the given Duration, the given Period and the given StatisticsServer .

NOTE: for request independent creation of the result required for the creation of the PDF.

USED BY: e.g. SendReportEmailJoblet

Parameters:
duration - the Duration
dataResolution - the Period, if null is given the default data resolution Period as configured for the implementing AbstractStatisticsViewController is to be used
server - the StatisticsServer
s - the current HibernateTM-Session
Returns:
an AbstractStatisticsViewControllerResult as required for the creation the PDF