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<org.alfresco.service.namespace.QName>
applicableTypes
applicable reported upon typesprotected org.alfresco.service.cmr.repository.ContentService
contentService
content serviceprotected org.alfresco.service.cmr.dictionary.DictionaryService
dictionaryService
dictionary serviceprotected org.alfresco.service.cmr.model.FileFolderService
fileFolderService
file folder serviceprotected static String
KEY_CHILDREN
protected static String
KEY_NODE
model keysprotected org.alfresco.service.cmr.repository.MimetypeService
mimetypeService
mimetype serviceprotected static String
MSG_REPORT
message lookupsprotected org.alfresco.service.cmr.repository.NodeService
nodeService
node serviceprotected org.alfresco.repo.model.Repository
repository
repository helperprotected org.alfresco.repo.admin.SysAdminParams
sysAdminParams
sys admin paramsprotected static org.alfresco.service.cmr.repository.NodeRef
TEMPLATE_ROOT
template lookup rootprotected org.alfresco.service.cmr.repository.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(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Checks whether the report generator is applicable given the reported upon node reference.protected Map<String,Serializable>
createTemplateModel(org.alfresco.service.cmr.repository.NodeRef templateNodeRef, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, Map<String,Serializable> properties)
Create template model.protected org.alfresco.service.cmr.repository.ContentReader
generateReportContent(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype, Map<String,Serializable> properties)
Generate report contentprotected Map<org.alfresco.service.namespace.QName,Serializable>
generateReportMetadata(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Generate report meta-dataprotected String
generateReportName(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype)
Generate the report nameprotected Map<String,Serializable>
generateReportTemplateContext(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Generate the report template context.void
setApplicableTypes(Set<org.alfresco.service.namespace.QName> applicableTypes)
void
setContentService(org.alfresco.service.cmr.repository.ContentService contentService)
void
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void
setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)
void
setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
void
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void
setRepository(org.alfresco.repo.model.Repository repository)
void
setSysAdminParams(org.alfresco.repo.admin.SysAdminParams sysAdminParams)
void
setTemplateService(org.alfresco.service.cmr.repository.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 org.alfresco.service.cmr.repository.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
-
applicableTypes
protected Set<org.alfresco.service.namespace.QName> applicableTypes
applicable reported upon types
-
contentService
protected org.alfresco.service.cmr.repository.ContentService contentService
content service
-
mimetypeService
protected org.alfresco.service.cmr.repository.MimetypeService mimetypeService
mimetype service
-
fileFolderService
protected org.alfresco.service.cmr.model.FileFolderService fileFolderService
file folder service
-
templateService
protected org.alfresco.service.cmr.repository.TemplateService templateService
template service
-
repository
protected org.alfresco.repo.model.Repository repository
repository helper
-
nodeService
protected org.alfresco.service.cmr.repository.NodeService nodeService
node service
-
dictionaryService
protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService
dictionary service
-
sysAdminParams
protected org.alfresco.repo.admin.SysAdminParams sysAdminParams
sys admin params
-
-
Method Detail
-
setApplicableTypes
public void setApplicableTypes(Set<org.alfresco.service.namespace.QName> applicableTypes)
- Parameters:
applicableTypes
- applicable types
-
setMimetypeService
public void setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
- Parameters:
mimetypeService
- mimetype service
-
setFileFolderService
public void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)
- Parameters:
fileFolderService
- file folder service
-
setTemplateService
public void setTemplateService(org.alfresco.service.cmr.repository.TemplateService templateService)
- Parameters:
templateService
- template service
-
setContentService
public void setContentService(org.alfresco.service.cmr.repository.ContentService contentService)
- Parameters:
contentService
- content service
-
setNodeService
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
- Parameters:
nodeService
- node service
-
setDictionaryService
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
- Parameters:
dictionaryService
- dictionary service
-
setRepository
public void setRepository(org.alfresco.repo.model.Repository repository)
- Parameters:
repository
- repository helper
-
setSysAdminParams
public void setSysAdminParams(org.alfresco.repo.admin.SysAdminParams sysAdminParams)
- Parameters:
sysAdminParams
- sys admin params
-
generateReportName
protected String generateReportName(org.alfresco.service.cmr.repository.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 org.alfresco.service.cmr.repository.ContentReader generateReportContent(org.alfresco.service.cmr.repository.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(org.alfresco.service.cmr.repository.NodeRef templateNodeRef, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, Map<String,Serializable> properties)
Create template model.- Parameters:
templateNodeRef
-reportedUponNodeRef
-properties
-- Returns:
-
checkReportApplicability
protected void checkReportApplicability(org.alfresco.service.cmr.repository.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(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)
Description copied from class:BaseReportGenerator
Generate the report template context.
-
generateReportMetadata
protected Map<org.alfresco.service.namespace.QName,Serializable> generateReportMetadata(org.alfresco.service.cmr.repository.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)
-
-