Class BaseReportGenerator
java.lang.Object
org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator
- All Implemented Interfaces:
ReportGenerator
- Direct Known Subclasses:
DeclarativeReportGenerator
Base report generator.
- Since:
- 2.1
- Author:
- Roy Wetherall
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected NamespaceService
namespace serviceprotected ReportService
report serviceprotected QName
report type qualified name -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
checkReportApplicability
(NodeRef reportedUponNodeRef) Checks whether the report generator is applicable given the reported upon node reference.generateReport
(NodeRef reportedUponNodeRef, String mimetype) Generate report.protected abstract ContentReader
generateReportContent
(NodeRef reportedUponNodeRef, String mimetype, Map<String, Serializable> properties) Generate report contentprotected abstract Map<QName,
Serializable> generateReportMetadata
(NodeRef reportedUponNodeRef) Generate report meta-dataprotected abstract String
generateReportName
(NodeRef reportedUponNodeRef, String mimetype) Generate the report nameprotected abstract Map<String,
Serializable> generateReportTemplateContext
(NodeRef reportedUponNodeRef) Generate the report template context.void
init()
Init methodvoid
setNamespaceService
(NamespaceService namespaceService) void
setReportService
(ReportService reportService) void
setReportType
(QName reportType)
-
Field Details
-
reportService
report service -
namespaceService
namespace service -
reportType
report type qualified name
-
-
Constructor Details
-
BaseReportGenerator
public BaseReportGenerator()
-
-
Method Details
-
setReportService
- Parameters:
reportService
- report service
-
setNamespaceService
- Parameters:
namespaceService
- namespace service
-
setReportType
- Parameters:
reportType
- report type
-
getReportType
- Specified by:
getReportType
in interfaceReportGenerator
- Returns:
QName
report type- See Also:
-
init
public void init()Init method -
generateReport
Description copied from interface:ReportGenerator
Generate report.- Specified by:
generateReport
in interfaceReportGenerator
- Returns:
- See Also:
-
checkReportApplicability
Checks whether the report generator is applicable given the reported upon node reference.Throws AlfrescoRuntimeException if applicability fails, with reason.
- Parameters:
reportedUponNodeRef
- reported upon node reference
-
generateReportName
Generate the report name -
generateReportTemplateContext
protected abstract Map<String,Serializable> generateReportTemplateContext(NodeRef reportedUponNodeRef) Generate the report template context. -
generateReportMetadata
Generate report meta-data -
generateReportContent
protected abstract ContentReader generateReportContent(NodeRef reportedUponNodeRef, String mimetype, Map<String, Serializable> properties) Generate report content
-