org.alfresco.module.org_alfresco_module_rm.report.generator

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 and Description
protected Set<org.alfresco.service.namespace.QName>	applicableTypes applicable reported upon types
protected org.alfresco.service.cmr.repository.ContentService	contentService content service
protected org.alfresco.service.cmr.dictionary.DictionaryService	dictionaryService dictionary service
protected org.alfresco.service.cmr.model.FileFolderService	fileFolderService file folder service
protected static String	KEY_CHILDREN
protected static String	KEY_NODE model keys
protected org.alfresco.service.cmr.repository.MimetypeService	mimetypeService mimetype service
protected static String	MSG_REPORT message lookups
protected org.alfresco.service.cmr.repository.NodeService	nodeService node service
protected org.alfresco.repo.model.Repository	repository repository helper
protected org.alfresco.repo.admin.SysAdminParams	sysAdminParams sys admin params
protected static org.alfresco.service.cmr.repository.NodeRef	TEMPLATE_ROOT template lookup root
protected 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 and Description
DeclarativeReportGenerator()

Method Summary

Modifier and Type	Method and 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 content
protected Map<org.alfresco.service.namespace.QName,Serializable>	generateReportMetadata(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef) Generate report meta-data
protected String	generateReportName(org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype) Generate the report name
protected 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

DeclarativeReportGenerator

public DeclarativeReportGenerator()

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 class BaseReportGenerator

See Also:

org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator#generateReportName(org.alfresco.service.cmr.repository.NodeRef)

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 class BaseReportGenerator

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 class BaseReportGenerator

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.

Specified by:

generateReportTemplateContext in class BaseReportGenerator

See Also:

BaseReportGenerator.generateReportTemplateContext(org.alfresco.service.cmr.repository.NodeRef)

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 class BaseReportGenerator

See Also:

BaseReportGenerator.generateReportMetadata(org.alfresco.service.cmr.repository.NodeRef)