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
public class DeclarativeReportGenerator extends BaseReportGenerator
Declarative report generator.- Since:
- 2.1
- Author:
- Roy Wetherall
-
-
Field Summary
Fields Modifier and Type Field Description protected Set<QName>
applicableTypes
applicable reported upon typesprotected ContentService
contentService
content serviceprotected DictionaryService
dictionaryService
dictionary serviceprotected FileFolderService
fileFolderService
file folder serviceprotected static String
KEY_CHILDREN
protected static String
KEY_NODE
model keysprotected MimetypeService
mimetypeService
mimetype serviceprotected static String
MSG_REPORT
message lookupsprotected NodeService
nodeService
node serviceprotected Repository
repository
repository helperprotected SysAdminParams
sysAdminParams
sys admin paramsprotected static NodeRef
TEMPLATE_ROOT
template lookup rootprotected TemplateService
templateService
template service-
Fields inherited from class org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator
namespaceService, reportService, reportType
-
-
Constructor Summary
Constructors Constructor Description DeclarativeReportGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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 Detail
-
MSG_REPORT
protected static final String MSG_REPORT
message lookups- See Also:
- Constant Field Values
-
TEMPLATE_ROOT
protected static final NodeRef TEMPLATE_ROOT
template lookup root
-
KEY_NODE
protected static final String KEY_NODE
model keys- See Also:
- Constant Field Values
-
KEY_CHILDREN
protected static final String KEY_CHILDREN
- See Also:
- Constant Field Values
-
contentService
protected ContentService contentService
content service
-
mimetypeService
protected MimetypeService mimetypeService
mimetype service
-
fileFolderService
protected FileFolderService fileFolderService
file folder service
-
templateService
protected TemplateService templateService
template service
-
repository
protected Repository repository
repository helper
-
nodeService
protected NodeService nodeService
node service
-
dictionaryService
protected DictionaryService dictionaryService
dictionary service
-
sysAdminParams
protected SysAdminParams sysAdminParams
sys admin params
-
-
Method Detail
-
setApplicableTypes
public void setApplicableTypes(Set<QName> applicableTypes)
- Parameters:
applicableTypes
- applicable types
-
setMimetypeService
public void setMimetypeService(MimetypeService mimetypeService)
- Parameters:
mimetypeService
- mimetype service
-
setFileFolderService
public void setFileFolderService(FileFolderService fileFolderService)
- Parameters:
fileFolderService
- file folder service
-
setTemplateService
public void setTemplateService(TemplateService templateService)
- Parameters:
templateService
- template service
-
setContentService
public void setContentService(ContentService contentService)
- Parameters:
contentService
- content service
-
setNodeService
public void setNodeService(NodeService nodeService)
- Parameters:
nodeService
- node service
-
setDictionaryService
public void setDictionaryService(DictionaryService dictionaryService)
- Parameters:
dictionaryService
- dictionary service
-
setRepository
public void setRepository(Repository repository)
- Parameters:
repository
- repository helper
-
setSysAdminParams
public void setSysAdminParams(SysAdminParams sysAdminParams)
- Parameters:
sysAdminParams
- sys admin params
-
generateReportName
protected String generateReportName(NodeRef reportedUponNodeRef, String mimetype)
Description copied from class:BaseReportGenerator
Generate the report name- Specified by:
generateReportName
in classBaseReportGenerator
- See Also:
BaseReportGenerator.generateReportName(org.alfresco.service.cmr.repository.NodeRef, String)
-
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:
BaseReportGenerator.generateReportContent(NodeRef, String, Map)
-
createTemplateModel
protected Map<String,Serializable> createTemplateModel(NodeRef templateNodeRef, NodeRef reportedUponNodeRef, Map<String,Serializable> properties)
Create template model.- Parameters:
templateNodeRef
-reportedUponNodeRef
-properties
-- Returns:
-
checkReportApplicability
protected void checkReportApplicability(NodeRef reportedUponNodeRef)
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:
BaseReportGenerator.checkReportApplicability(org.alfresco.service.cmr.repository.NodeRef)
-
generateReportTemplateContext
protected Map<String,Serializable> generateReportTemplateContext(NodeRef reportedUponNodeRef)
Description copied from class:BaseReportGenerator
Generate the report template context.
-
generateReportMetadata
protected Map<QName,Serializable> generateReportMetadata(NodeRef reportedUponNodeRef)
Description copied from class:BaseReportGenerator
Generate report meta-data- Specified by:
generateReportMetadata
in classBaseReportGenerator
- See Also:
BaseReportGenerator.generateReportMetadata(org.alfresco.service.cmr.repository.NodeRef)
-
-