com.credibledoc.substitution.reporting.markdown

Class MarkdownService

java.lang.Object

com.credibledoc.substitution.reporting.markdown.MarkdownService

public class MarkdownService
extends Object

This singleton helps to parse templates from the Configuration.getTemplatesResource() folder, extract Placeholders between Configuration.getPlaceholderBegin() and Configuration.getPlaceholderEnd() tags, create ReportDocuments which represent a content of the placeholders and generate new documents in the Configuration.getTargetDirectory() with the new content instead of placeholders.

Author:

Kyrylo Semenko

Field Summary

Fields

Modifier and Type	Field and Description
private static String	IGNORE_SYNTAX_ERROR_PLACEHOLDER_PARAMETER
private static String	IMAGE_DIRECTORY_NAME
private static MarkdownService	instance Singleton.
private static org.slf4j.Logger	logger
private static String	SLASH
private static String	SVG_FILE_EXTENSION
private static String	SVG_TAG_BEGIN
private static String	SVG_TAG_END
private static String	SVG_TAG_MIDDLE
private static String	SYNTAX_ERROR_GENERATED_KEYWORD

Constructor Summary

Constructors

Constructor and Description
MarkdownService()

Method Summary

Modifier and Type	Method and Description
private void	createDirectoryIfNotExists(File directory)
String	generateDiagram(Placeholder placeholder, String plantUml, SubstitutionContext substitutionContext) Generate SVG image file and a link to the file.
private String	generateSvgFileAndTagForMarkdown(File mdFile, File imageDirectory, String plantUml, Placeholder placeholder, boolean replaceFilterId)
static MarkdownService	getInstance()
private String	replaceFilterId(String svg) Replace all occurrences of the generated ids with constants.

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

SLASH

private static final String SLASH

See Also:

Constant Field Values

IMAGE_DIRECTORY_NAME

private static final String IMAGE_DIRECTORY_NAME

See Also:

Constant Field Values

SVG_FILE_EXTENSION

private static final String SVG_FILE_EXTENSION

See Also:

Constant Field Values

SVG_TAG_BEGIN

private static final String SVG_TAG_BEGIN

See Also:

Constant Field Values

SVG_TAG_MIDDLE

private static final String SVG_TAG_MIDDLE

See Also:

Constant Field Values

SVG_TAG_END

private static final String SVG_TAG_END

See Also:

Constant Field Values

SYNTAX_ERROR_GENERATED_KEYWORD

private static final String SYNTAX_ERROR_GENERATED_KEYWORD

See Also:

Constant Field Values

IGNORE_SYNTAX_ERROR_PLACEHOLDER_PARAMETER

private static final String IGNORE_SYNTAX_ERROR_PLACEHOLDER_PARAMETER

See Also:

Constant Field Values

instance

private static final MarkdownService instance

Singleton.

Constructor Detail

MarkdownService

public MarkdownService()

Method Detail

getInstance

public static MarkdownService getInstance()

Returns:

The MarkdownService singleton.

generateDiagram

public String generateDiagram(Placeholder placeholder,
                              String plantUml,
                              SubstitutionContext substitutionContext)

Generate SVG image file and a link to the file.

• Load template from the Placeholder.getResource() field
• Create a new file from the template in the Configuration.getTargetDirectory() directory
• Create a new IMAGE_DIRECTORY_NAME directory
• Get a ReportDocument form the PlaceholderToReportDocumentService
• Join lines from the Printable.getCacheLines() list
• And return result of the generateSvgFileAndTagForMarkdown(File, File, String, Placeholder, boolean) method

Parameters:

placeholder - the state object

plantUml - PlantUML source notation. If the value is 'null', the value will be obtained from ReportDocument which is stored in PlaceholderToReportDocumentService.getReportDocument(Placeholder).

substitutionContext - the current state

Returns:

A part of markdown document with link to generated SVG image.

generateSvgFileAndTagForMarkdown

private String generateSvgFileAndTagForMarkdown(File mdFile,
                                                File imageDirectory,
                                                String plantUml,
                                                Placeholder placeholder,
                                                boolean replaceFilterId)

replaceFilterId

private String replaceFilterId(String svg)

Replace all occurrences of the generated ids with constants. Example of filter line:

 <filter height="300%" id="f10gnta8ifhhre" width="300%" x="-1" y="-1">
 

Parameters:

svg - for replacing

Returns:

The svg with replaced ids, for example id="f10gnta8ifhhre" will be replaced with id="1"

createDirectoryIfNotExists

private void createDirectoryIfNotExists(File directory)