Class BaseReportGenerator
- java.lang.Object
-
- org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator
-
- All Implemented Interfaces:
ReportGenerator
- Direct Known Subclasses:
DeclarativeReportGenerator
public abstract class BaseReportGenerator extends Object implements ReportGenerator
Base report generator.- Since:
- 2.1
- Author:
- Roy Wetherall
-
-
Field Summary
Fields Modifier and Type Field Description protected org.alfresco.service.namespace.NamespaceService
namespaceService
namespace serviceprotected ReportService
reportService
report serviceprotected org.alfresco.service.namespace.QName
reportType
report type qualified name
-
Constructor Summary
Constructors Constructor Description BaseReportGenerator()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
checkReportApplicability(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Checks whether the report generator is applicable given the reported upon node reference.Report
generateReport(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype)
Generate report.protected abstract org.alfresco.service.cmr.repository.ContentReader
generateReportContent(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype, Map<String,Serializable> properties)
Generate report contentprotected abstract Map<org.alfresco.service.namespace.QName,Serializable>
generateReportMetadata(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Generate report meta-dataprotected abstract String
generateReportName(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype)
Generate the report nameprotected abstract Map<String,Serializable>
generateReportTemplateContext(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Generate the report template context.org.alfresco.service.namespace.QName
getReportType()
void
init()
Init methodvoid
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void
setReportService(ReportService reportService)
void
setReportType(org.alfresco.service.namespace.QName reportType)
-
-
-
Field Detail
-
reportService
protected ReportService reportService
report service
-
namespaceService
protected org.alfresco.service.namespace.NamespaceService namespaceService
namespace service
-
reportType
protected org.alfresco.service.namespace.QName reportType
report type qualified name
-
-
Method Detail
-
setReportService
public void setReportService(ReportService reportService)
- Parameters:
reportService
- report service
-
setNamespaceService
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
- Parameters:
namespaceService
- namespace service
-
setReportType
public void setReportType(org.alfresco.service.namespace.QName reportType)
- Parameters:
reportType
- report type
-
getReportType
public org.alfresco.service.namespace.QName getReportType()
- Specified by:
getReportType
in interfaceReportGenerator
- Returns:
QName
report type- See Also:
ReportGenerator.getReportType()
-
init
public void init()
Init method
-
generateReport
public Report generateReport(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype)
Description copied from interface:ReportGenerator
Generate report.- Specified by:
generateReport
in interfaceReportGenerator
- Returns:
- See Also:
ReportGenerator.generateReport(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
-
checkReportApplicability
protected abstract void checkReportApplicability(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
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
protected abstract String generateReportName(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype)
Generate the report name
-
generateReportTemplateContext
protected abstract Map<String,Serializable> generateReportTemplateContext(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Generate the report template context.
-
generateReportMetadata
protected abstract Map<org.alfresco.service.namespace.QName,Serializable> generateReportMetadata(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Generate report meta-data
-
generateReportContent
protected abstract org.alfresco.service.cmr.repository.ContentReader generateReportContent(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype, Map<String,Serializable> properties)
Generate report content
-
-