Class DeclarativeReportGenerator
java.lang.Object
org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator
org.alfresco.module.org_alfresco_module_rm.report.generator.DeclarativeReportGenerator
- All Implemented Interfaces:
ReportGenerator
- Direct Known Subclasses:
TransferReportGenerator
Declarative report generator.
- Since:
- 2.1
- Author:
- Roy Wetherall
-
Field Summary
FieldsModifier and TypeFieldDescriptionapplicable reported upon typesprotected ContentService
content serviceprotected DictionaryService
dictionary serviceprotected FileFolderService
file folder serviceprotected static final String
protected static final String
model keysprotected MimetypeService
mimetype serviceprotected static final String
message lookupsprotected NodeService
node serviceprotected Repository
repository helperprotected SysAdminParams
sys admin paramsprotected static final NodeRef
template lookup rootprotected TemplateService
template serviceFields inherited from class org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator
namespaceService, reportService, reportType
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
checkReportApplicability
(NodeRef reportedUponNodeRef) Checks whether the report generator is applicable given the reported upon node reference.protected Map<String,
Serializable> createTemplateModel
(NodeRef templateNodeRef, NodeRef reportedUponNodeRef, Map<String, Serializable> properties) Create template model.protected ContentReader
generateReportContent
(NodeRef reportedUponNodeRef, String mimetype, Map<String, Serializable> properties) Generate report contentprotected Map<QName,
Serializable> generateReportMetadata
(NodeRef reportedUponNodeRef) Generate report meta-dataprotected String
generateReportName
(NodeRef reportedUponNodeRef, String mimetype) Generate the report nameprotected Map<String,
Serializable> generateReportTemplateContext
(NodeRef reportedUponNodeRef) Generate the report template context.void
setApplicableTypes
(Set<QName> applicableTypes) void
setContentService
(ContentService contentService) void
setDictionaryService
(DictionaryService dictionaryService) void
setFileFolderService
(FileFolderService fileFolderService) void
setMimetypeService
(MimetypeService mimetypeService) void
setNodeService
(NodeService nodeService) void
setRepository
(Repository repository) void
setSysAdminParams
(SysAdminParams sysAdminParams) void
setTemplateService
(TemplateService templateService) Methods inherited from class org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator
generateReport, getReportType, init, setNamespaceService, setReportService, setReportType
-
Field Details
-
MSG_REPORT
message lookups- See Also:
-
TEMPLATE_ROOT
template lookup root -
KEY_NODE
model keys- See Also:
-
KEY_CHILDREN
- See Also:
-
applicableTypes
applicable reported upon types -
contentService
content service -
mimetypeService
mimetype service -
fileFolderService
file folder service -
templateService
template service -
repository
repository helper -
nodeService
node service -
dictionaryService
dictionary service -
sysAdminParams
sys admin params
-
-
Constructor Details
-
DeclarativeReportGenerator
public DeclarativeReportGenerator()
-
-
Method Details
-
setApplicableTypes
- Parameters:
applicableTypes
- applicable types
-
setMimetypeService
- Parameters:
mimetypeService
- mimetype service
-
setFileFolderService
- Parameters:
fileFolderService
- file folder service
-
setTemplateService
- Parameters:
templateService
- template service
-
setContentService
- Parameters:
contentService
- content service
-
setNodeService
- Parameters:
nodeService
- node service
-
setDictionaryService
- Parameters:
dictionaryService
- dictionary service
-
setRepository
- Parameters:
repository
- repository helper
-
setSysAdminParams
- Parameters:
sysAdminParams
- sys admin params
-
generateReportName
Description copied from class:BaseReportGenerator
Generate the report name- Specified by:
generateReportName
in classBaseReportGenerator
- See Also:
-
generateReportContent
protected ContentReader generateReportContent(NodeRef reportedUponNodeRef, String mimetype, Map<String, Serializable> properties) Description copied from class:BaseReportGenerator
Generate report content- Specified by:
generateReportContent
in classBaseReportGenerator
- See Also:
-
createTemplateModel
protected Map<String,Serializable> createTemplateModel(NodeRef templateNodeRef, NodeRef reportedUponNodeRef, Map<String, Serializable> properties) Create template model.- Parameters:
templateNodeRef
-reportedUponNodeRef
-properties
-- Returns:
-
checkReportApplicability
Description copied from class:BaseReportGenerator
Checks whether the report generator is applicable given the reported upon node reference.Throws AlfrescoRuntimeException if applicability fails, with reason.
- Specified by:
checkReportApplicability
in classBaseReportGenerator
- Parameters:
reportedUponNodeRef
- reported upon node reference- See Also:
-
generateReportTemplateContext
Description copied from class:BaseReportGenerator
Generate the report template context. -
generateReportMetadata
Description copied from class:BaseReportGenerator
Generate report meta-data- Specified by:
generateReportMetadata
in classBaseReportGenerator
- See Also:
-