com.credibledoc.substitution.reporting.reportdocument.creator

Class ReportDocumentCreatorService

java.lang.Object

com.credibledoc.substitution.reporting.reportdocument.creator.ReportDocumentCreatorService

public class ReportDocumentCreatorService
extends Object

Stateless service for working with ReportDocumentCreators.

Author:

Kyrylo Semenko

Field Summary

Fields

Modifier and Type	Field and Description
private static ReportDocumentCreatorService	instance Singleton.
private static org.slf4j.Logger	logger
private static String	SOURCE_FILE_RELATIVE_PATH_PLACEHOLDER_PARAMETER

Constructor Summary

Constructors

Constructor and Description
ReportDocumentCreatorService()

Method Summary

Modifier and Type	Method and Description
void	addReportDocumentCreators(Collection<ReportDocumentCreator> reportDocumentCreators, ReportingContext reportingContext) Add all items to the ReportDocumentCreatorRepository.getMap() entries.
private void	createReportDocumentForPlaceholder(Placeholder placeholder, ReportDocumentCreator reportDocumentCreator, CombinerContext combinerContext, SubstitutionContext substitutionContext, ReportingContext reportingContext, EnricherContext enricherContext) Prepare relations between Placeholders and ReportDocuments.
void	createReportDocuments(CombinerContext combinerContext, ReportingContext reportingContext, SubstitutionContext substitutionContext, EnricherContext enricherContext, List<TemplateResource> templateResources) Iterate Placeholders from template resources and for each Placeholder find the appropriate ReportDocumentCreator from the ReportDocumentCreatorRepository.
static ReportDocumentCreatorService	getInstance()
private void	prepareReport(FileWithSources fileWithSources, ReportDocument reportDocument, CombinerContext combinerContext, ReportingContext reportingContext) Create a new Report

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

SOURCE_FILE_RELATIVE_PATH_PLACEHOLDER_PARAMETER

private static final String SOURCE_FILE_RELATIVE_PATH_PLACEHOLDER_PARAMETER

See Also:

Constant Field Values

instance

private static final ReportDocumentCreatorService instance

Singleton.

Constructor Detail

ReportDocumentCreatorService

public ReportDocumentCreatorService()

Method Detail

getInstance

public static ReportDocumentCreatorService getInstance()

Returns:

The ReportDocumentCreatorService singleton.

addReportDocumentCreators

public void addReportDocumentCreators(Collection<ReportDocumentCreator> reportDocumentCreators,
                                      ReportingContext reportingContext)

Add all items to the ReportDocumentCreatorRepository.getMap() entries.

Parameters:

reportDocumentCreators - items for addition

reportingContext - contains the ReportDocumentCreatorRepository data store

createReportDocuments

public void createReportDocuments(CombinerContext combinerContext,
                                  ReportingContext reportingContext,
                                  SubstitutionContext substitutionContext,
                                  EnricherContext enricherContext,
                                  List<TemplateResource> templateResources)

Iterate Placeholders from template resources and for each Placeholder find the appropriate ReportDocumentCreator from the ReportDocumentCreatorRepository. Then create a ReportDocument for the Placeholder.

Parameters:

combinerContext - the current state

reportingContext - the current state

substitutionContext - the current state

enricherContext - the current state

templateResources - contains templates with placeholders

createReportDocumentForPlaceholder

private void createReportDocumentForPlaceholder(Placeholder placeholder,
                                                ReportDocumentCreator reportDocumentCreator,
                                                CombinerContext combinerContext,
                                                SubstitutionContext substitutionContext,
                                                ReportingContext reportingContext,
                                                EnricherContext enricherContext)

Prepare relations between Placeholders and ReportDocuments.

Create ReportDocument, see the ReportDocumentCreator.prepareReportDocument(EnricherContext) method.

Put the Placeholder and ReportDocument to the PlaceholderToReportDocumentRepository.

Add the ReportDocument to the ReportDocumentRepository.getReportDocuments() list.

Add the Placeholder to the PlaceholderRepository.getPlaceholders() list.

Parameters:

placeholder - for addition

reportDocumentCreator - for addition

combinerContext - the current state

substitutionContext - the current state

reportingContext - the current state

enricherContext - the current state

prepareReport

private void prepareReport(FileWithSources fileWithSources,
                           ReportDocument reportDocument,
                           CombinerContext combinerContext,
                           ReportingContext reportingContext)

Create a new Report

Parameters:

fileWithSources - a source file

reportDocument - belonging to the Report

combinerContext - the current state

reportingContext - the current state