Package de.monticore.generating.templateengine.reporting.reporter

Class SummaryReporter

java.lang.Object

de.monticore.generating.templateengine.reporting.commons.DefaultReportEventHandler

de.monticore.generating.templateengine.reporting.commons.AReporter

de.monticore.generating.templateengine.reporting.reporter.SummaryReporter

All Implemented Interfaces:

IReportEventHandler

Direct Known Subclasses:

StatisticsReporter

public class SummaryReporter
extends AReporter

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	calledUnsetHookpoints
static final String	MAX_AST_DEPTH
static final String	MAX_TEMPLATE_DEPTH
protected int	maxTemplateDepth
static final String	NUM_AST_SPECIFIC_CALLS
static final String	NUM_AST_SPECIFIC_REPLACEMENTS
static final String	NUM_ASTNODE_INSTANCES
static final String	NUM_ASTNODE_TYPES
static final String	NUM_ASTNODE_VISITS
static final String	NUM_CALL_CODE_HOOKPOINTS
static final String	NUM_CALL_STRING_HOOKPOINTS
static final String	NUM_CALL_TEMPLATE_HOOKPOINTS
static final String	NUM_CALLED_EMPTY_HOOKPOINTS
static final String	NUM_CALLS_EMPTY_HOOKPOINTS
static final String	NUM_ERRORS
static final String	NUM_GENERATED_FILES
static final String	NUM_INSTANTIATIONS
static final String	NUM_INTERNAL_ERRORS
static final String	NUM_SET_CODE_HOOKPOINTS
static final String	NUM_SET_STRING_HOOKPOINTS
static final String	NUM_SET_TEMPLATE_HOOKPOINTS
static final String	NUM_TEMPLATE_INCLUDE
static final String	NUM_TEMPLATE_WRITE
static final String	NUM_UNUSED_HWTEMPLATES
static final String	NUM_USED_HWTEMPLATES
static final String	NUM_USED_TEMPLATES
static final String	NUM_USER_ERRORS
static final String	NUM_USER_WARNINGS
static final String	NUM_VARIABLE_ASSIGNMENTS
static final String	NUM_VARIABLES
static final String	NUM_WARNINGS
protected int	numASTNodeVisits
protected int	numASTSpecificCalls
protected int	numASTSpecificReplacements
protected int	numCallCodeHookpoints
protected int	numCallStringHookpoints
protected int	numCallsUnsetHookpoints
protected int	numCallTemplateHookpoints
protected int	numErrors
protected int	numGeneratedFiles
protected int	numInstantiations
protected int	numInternalErrors
protected int	numSetCodeHookpoints
protected int	numSetStringHookpoints
protected int	numSetTemplateHookpoints
protected int	numTemplateIncludes
protected int	numTemplateWrites
protected int	numUserErrors
protected int	numUserWarnings
protected int	numVariableAssignments
protected int	numWarnings
protected ObjectCountVisitor	ocv
protected ReportingRepository	repository
static final String	SIMPLE_FILE_NAME
protected int	templateDepth
protected ITraverser	traverser
protected Set<String>	usedHWTemplates
protected Set<String>	usedTemplates
protected Set<String>	variableNames

Fields inherited from class de.monticore.generating.templateengine.reporting.commons.AReporter

file, fileextension, fileOpen, qualifiedFileName, reportingHelper

Constructor Summary

Constructors

Constructor	Description
SummaryReporter(String outputDir, String modelName, ReportingRepository repository, ITraverser traverser)

Method Summary

Modifier and Type	Method	Description
void	flush(ASTNode ast)	Method is called after generation.
void	reportASTSpecificTemplateReplacement(String oldTemplate, ASTNode node, HookPoint newHp)
void	reportCallAfterHookPoint(String oldTemplate, Collection<HookPoint> afterHPs, ASTNode ast)
void	reportCallBeforeHookPoint(String oldTemplate, Collection<HookPoint> beforeHPs, ASTNode ast)
void	reportCallHookPointStart(String hookName, HookPoint hp, ASTNode ast)
void	reportCallReplacementHookPoint(String oldTemplate, List<HookPoint> hps, ASTNode ast)
void	reportCallSpecificReplacementHookPoint(String oldTemplate, List<HookPoint> hps, ASTNode ast)
void	reportError(String message)
void	reportErrorInternal(String message)
void	reportErrorUser(String message)
void	reportFileCreation(String templatename, String qualifiedfilename, String fileextension, ASTNode ast)
void	reportInstantiate(String className, List<Object> params)
void	reportSetAfterTemplate(String template, Optional<ASTNode> ast, List<? extends HookPoint> afterHps)
void	reportSetBeforeTemplate(String template, Optional<ASTNode> ast, List<? extends HookPoint> beforeHps)
void	reportSetHookPoint(String hookName, HookPoint hp)
void	reportSetValue(String name, Object value)
void	reportTemplateEnd(String templatename, ASTNode ast)
void	reportTemplateInclude(String templateName, ASTNode ast)
void	reportTemplateReplacement(String oldTemplate, List<? extends HookPoint> newHps)
void	reportTemplateStart(String templatename, ASTNode ast)
void	reportTemplateWrite(String templateName, ASTNode ast)
void	reportUserWarning(String message)
void	reportWarning(String message)
protected void	resetVariables()
protected void	writeContent(ASTNode ast)
protected void	writeFooter()
protected void	writeHeader()
protected void	writeSummaryLine(String string, int number)

Methods inherited from class de.monticore.generating.templateengine.reporting.commons.AReporter

closeFile, openFile, writeLine

Methods inherited from class de.monticore.generating.templateengine.reporting.commons.DefaultReportEventHandler

reportAddAfterTemplate, reportAddBeforeTemplate, reportAddValue, reportCallHookPointEnd, reportDetailed, reportExecuteStandardTemplate, reportFileCreation, reportFileCreation, reportFileExistenceChecking, reportFileFinalization, reportHWCExistenceCheck, reportMethodCall, reportModelEnd, reportModelLoad, reportModelStart, reportOpenInputFile, reportOpenInputFile, reportParseInputFile, reportSymbolTableScope, reportTransformationNewValue, reportTransformationNewValue, reportTransformationNewValue, reportTransformationObjectChange, reportTransformationObjectCreation, reportTransformationObjectDeletion, reportTransformationObjectMatch, reportTransformationOldValue, reportTransformationOldValue, reportTransformationOldValue, reportTransformationStart, reportUseHandwrittenCodeFile, reportUserSpecificTemplate

Methods inherited from class java.lang.Object

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

Field Details

NUM_TEMPLATE_INCLUDE

public static final String NUM_TEMPLATE_INCLUDE

See Also:

• Constant Field Values

NUM_TEMPLATE_WRITE

public static final String NUM_TEMPLATE_WRITE

See Also:

• Constant Field Values

NUM_GENERATED_FILES

public static final String NUM_GENERATED_FILES

See Also:

• Constant Field Values

NUM_INSTANTIATIONS

public static final String NUM_INSTANTIATIONS

See Also:

• Constant Field Values

NUM_VARIABLES

public static final String NUM_VARIABLES

See Also:

• Constant Field Values

NUM_VARIABLE_ASSIGNMENTS

public static final String NUM_VARIABLE_ASSIGNMENTS

See Also:

• Constant Field Values

NUM_WARNINGS

public static final String NUM_WARNINGS

See Also:

• Constant Field Values

NUM_USER_WARNINGS

public static final String NUM_USER_WARNINGS

See Also:

• Constant Field Values

NUM_ERRORS

public static final String NUM_ERRORS

See Also:

• Constant Field Values

NUM_USER_ERRORS

public static final String NUM_USER_ERRORS

See Also:

• Constant Field Values

NUM_INTERNAL_ERRORS

public static final String NUM_INTERNAL_ERRORS

See Also:

• Constant Field Values

MAX_TEMPLATE_DEPTH

public static final String MAX_TEMPLATE_DEPTH

See Also:

• Constant Field Values

MAX_AST_DEPTH

public static final String MAX_AST_DEPTH

See Also:

• Constant Field Values

NUM_USED_TEMPLATES

public static final String NUM_USED_TEMPLATES

See Also:

• Constant Field Values

NUM_USED_HWTEMPLATES

public static final String NUM_USED_HWTEMPLATES

See Also:

• Constant Field Values

NUM_UNUSED_HWTEMPLATES

public static final String NUM_UNUSED_HWTEMPLATES

See Also:

• Constant Field Values

NUM_ASTNODE_VISITS

public static final String NUM_ASTNODE_VISITS

See Also:

• Constant Field Values

NUM_ASTNODE_TYPES

public static final String NUM_ASTNODE_TYPES

See Also:

• Constant Field Values

NUM_ASTNODE_INSTANCES

public static final String NUM_ASTNODE_INSTANCES

See Also:

• Constant Field Values

NUM_AST_SPECIFIC_REPLACEMENTS

public static final String NUM_AST_SPECIFIC_REPLACEMENTS

See Also:

• Constant Field Values

NUM_AST_SPECIFIC_CALLS

public static final String NUM_AST_SPECIFIC_CALLS

See Also:

• Constant Field Values

NUM_SET_CODE_HOOKPOINTS

public static final String NUM_SET_CODE_HOOKPOINTS

See Also:

• Constant Field Values

NUM_CALL_CODE_HOOKPOINTS

public static final String NUM_CALL_CODE_HOOKPOINTS

See Also:

• Constant Field Values

NUM_SET_TEMPLATE_HOOKPOINTS

public static final String NUM_SET_TEMPLATE_HOOKPOINTS

See Also:

• Constant Field Values

NUM_CALL_TEMPLATE_HOOKPOINTS

public static final String NUM_CALL_TEMPLATE_HOOKPOINTS

See Also:

• Constant Field Values

NUM_SET_STRING_HOOKPOINTS

public static final String NUM_SET_STRING_HOOKPOINTS

See Also:

• Constant Field Values

NUM_CALL_STRING_HOOKPOINTS

public static final String NUM_CALL_STRING_HOOKPOINTS

See Also:

• Constant Field Values

NUM_CALLS_EMPTY_HOOKPOINTS

public static final String NUM_CALLS_EMPTY_HOOKPOINTS

See Also:

• Constant Field Values

NUM_CALLED_EMPTY_HOOKPOINTS

public static final String NUM_CALLED_EMPTY_HOOKPOINTS

See Also:

• Constant Field Values

SIMPLE_FILE_NAME

public static final String SIMPLE_FILE_NAME

See Also:

• Constant Field Values

numTemplateIncludes

protected int numTemplateIncludes

numTemplateWrites

protected int numTemplateWrites

numGeneratedFiles

protected int numGeneratedFiles

numInstantiations

protected int numInstantiations

numVariableAssignments

protected int numVariableAssignments

numWarnings

protected int numWarnings

numUserWarnings

protected int numUserWarnings

numErrors

protected int numErrors

numUserErrors

protected int numUserErrors

numInternalErrors

protected int numInternalErrors

templateDepth

protected int templateDepth

maxTemplateDepth

protected int maxTemplateDepth

numASTNodeVisits

protected int numASTNodeVisits

numASTSpecificReplacements

protected int numASTSpecificReplacements

numASTSpecificCalls

protected int numASTSpecificCalls

numSetCodeHookpoints

protected int numSetCodeHookpoints

numCallCodeHookpoints

protected int numCallCodeHookpoints

numSetTemplateHookpoints

protected int numSetTemplateHookpoints

numCallTemplateHookpoints

protected int numCallTemplateHookpoints

numSetStringHookpoints

protected int numSetStringHookpoints

numCallStringHookpoints

protected int numCallStringHookpoints

numCallsUnsetHookpoints

protected int numCallsUnsetHookpoints

variableNames

protected Set<String> variableNames

usedTemplates

protected Set<String> usedTemplates

usedHWTemplates

protected Set<String> usedHWTemplates

calledUnsetHookpoints

protected Set<String> calledUnsetHookpoints

repository

protected ReportingRepository repository

traverser

protected ITraverser traverser

ocv

protected ObjectCountVisitor ocv

Constructor Details

SummaryReporter

public SummaryReporter(String outputDir,
 String modelName,
 ReportingRepository repository,
 ITraverser traverser)

Method Details

reportWarning

public void reportWarning(String message)

Specified by:

reportWarning in interface IReportEventHandler

Overrides:

reportWarning in class DefaultReportEventHandler

Parameters:

message -

See Also:

• DefaultReportEventHandler.reportWarning(java.lang.String)

reportUserWarning

public void reportUserWarning(String message)

Specified by:

reportUserWarning in interface IReportEventHandler

Overrides:

reportUserWarning in class DefaultReportEventHandler

Parameters:

message -

See Also:

• DefaultReportEventHandler.reportUserWarning(java.lang.String)

reportError

public void reportError(String message)

Specified by:

reportError in interface IReportEventHandler

Overrides:

reportError in class DefaultReportEventHandler

Parameters:

message -

See Also:

• DefaultReportEventHandler.reportError(java.lang.String)

reportErrorUser

public void reportErrorUser(String message)

Specified by:

reportErrorUser in interface IReportEventHandler

Overrides:

reportErrorUser in class DefaultReportEventHandler

Parameters:

message -

See Also:

• DefaultReportEventHandler.reportErrorUser(java.lang.String)

reportErrorInternal

public void reportErrorInternal(String message)

Specified by:

reportErrorInternal in interface IReportEventHandler

Overrides:

reportErrorInternal in class DefaultReportEventHandler

Parameters:

message -

See Also:

• DefaultReportEventHandler.reportErrorInternal(java.lang.String)

reportFileCreation

public void reportFileCreation(String templatename,
 String qualifiedfilename,
 String fileextension,
 ASTNode ast)

Specified by:

reportFileCreation in interface IReportEventHandler

Overrides:

reportFileCreation in class DefaultReportEventHandler

See Also:

• DefaultReportEventHandler.reportFileCreation(java.lang.String, java.lang.String, java.lang.String, de.monticore.ast.ASTNode)

reportSetValue

public void reportSetValue(String name,
 Object value)

Specified by:

reportSetValue in interface IReportEventHandler

Overrides:

reportSetValue in class DefaultReportEventHandler

Parameters:

name -

value -

See Also:

• DefaultReportEventHandler.reportSetValue(java.lang.String, java.lang.Object)

reportInstantiate

public void reportInstantiate(String className,
 List<Object> params)

Specified by:

reportInstantiate in interface IReportEventHandler

Overrides:

reportInstantiate in class DefaultReportEventHandler

Parameters:

className -

params -

See Also:

• DefaultReportEventHandler.reportInstantiate(java.lang.String, java.util.List)

reportTemplateInclude

public void reportTemplateInclude(String templateName,
 ASTNode ast)

Specified by:

reportTemplateInclude in interface IReportEventHandler

Overrides:

reportTemplateInclude in class DefaultReportEventHandler

Parameters:

templateName -

ast -

See Also:

• DefaultReportEventHandler.reportTemplateInclude(java.lang.String, de.monticore.ast.ASTNode)

reportTemplateWrite

public void reportTemplateWrite(String templateName,
 ASTNode ast)

Specified by:

reportTemplateWrite in interface IReportEventHandler

Overrides:

reportTemplateWrite in class DefaultReportEventHandler

Parameters:

templateName -

ast -

See Also:

• DefaultReportEventHandler.reportTemplateWrite(java.lang.String, de.monticore.ast.ASTNode)

reportTemplateStart

public void reportTemplateStart(String templatename,
 ASTNode ast)

Specified by:

reportTemplateStart in interface IReportEventHandler

Overrides:

reportTemplateStart in class DefaultReportEventHandler

See Also:

• DefaultReportEventHandler.reportTemplateStart(java.lang.String, de.monticore.ast.ASTNode)

reportTemplateEnd

public void reportTemplateEnd(String templatename,
 ASTNode ast)

Specified by:

reportTemplateEnd in interface IReportEventHandler

Overrides:

reportTemplateEnd in class DefaultReportEventHandler

Parameters:

templatename -

ast -

See Also:

• DefaultReportEventHandler.reportTemplateEnd(java.lang.String, de.monticore.ast.ASTNode)

reportCallAfterHookPoint

public void reportCallAfterHookPoint(String oldTemplate,
 Collection<HookPoint> afterHPs,
 ASTNode ast)

Specified by:

reportCallAfterHookPoint in interface IReportEventHandler

Overrides:

reportCallAfterHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

afterHPs -

ast -

See Also:

• DefaultReportEventHandler.reportCallAfterHookPoint(java.lang.String, java.util.Collection, de.monticore.ast.ASTNode)

reportCallBeforeHookPoint

public void reportCallBeforeHookPoint(String oldTemplate,
 Collection<HookPoint> beforeHPs,
 ASTNode ast)

Specified by:

reportCallBeforeHookPoint in interface IReportEventHandler

Overrides:

reportCallBeforeHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

beforeHPs -

ast -

See Also:

• DefaultReportEventHandler.reportCallBeforeHookPoint(java.lang.String, java.util.Collection, de.monticore.ast.ASTNode)

reportCallReplacementHookPoint

public void reportCallReplacementHookPoint(String oldTemplate,
 List<HookPoint> hps,
 ASTNode ast)

Specified by:

reportCallReplacementHookPoint in interface IReportEventHandler

Overrides:

reportCallReplacementHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

hps -

ast -

See Also:

• DefaultReportEventHandler.reportCallReplacementHookPoint(java.lang.String, java.util.List, de.monticore.ast.ASTNode)

reportCallSpecificReplacementHookPoint

public void reportCallSpecificReplacementHookPoint(String oldTemplate,
 List<HookPoint> hps,
 ASTNode ast)

Specified by:

reportCallSpecificReplacementHookPoint in interface IReportEventHandler

Overrides:

reportCallSpecificReplacementHookPoint in class DefaultReportEventHandler

Parameters:

oldTemplate -

hps -

ast -

See Also:

• DefaultReportEventHandler.reportCallSpecificReplacementHookPoint(java.lang.String, java.util.List, de.monticore.ast.ASTNode)

writeContent

protected void writeContent(ASTNode ast)

writeSummaryLine

protected void writeSummaryLine(String string,
 int number)

resetVariables

protected void resetVariables()

flush

public void flush(ASTNode ast)

Description copied from class: AReporter

Method is called after generation.

Specified by:

flush in interface IReportEventHandler

Overrides:

flush in class AReporter

Parameters:

ast - Compilation unit AST or null on error

writeFooter

protected void writeFooter()

reportSetHookPoint

public void reportSetHookPoint(String hookName,
 HookPoint hp)

Specified by:

reportSetHookPoint in interface IReportEventHandler

Overrides:

reportSetHookPoint in class DefaultReportEventHandler

Parameters:

hookName -

hp -

See Also:

• DefaultReportEventHandler.reportSetHookPoint(java.lang.String, de.monticore.generating.templateengine.HookPoint)

reportCallHookPointStart

public void reportCallHookPointStart(String hookName,
 HookPoint hp,
 ASTNode ast)

Specified by:

reportCallHookPointStart in interface IReportEventHandler

Overrides:

reportCallHookPointStart in class DefaultReportEventHandler

Parameters:

hookName -

hp -

ast -

See Also:

• DefaultReportEventHandler.reportCallHookPointStart(java.lang.String, de.monticore.generating.templateengine.HookPoint, de.monticore.ast.ASTNode)

reportASTSpecificTemplateReplacement

public void reportASTSpecificTemplateReplacement(String oldTemplate,
 ASTNode node,
 HookPoint newHp)

Specified by:

reportASTSpecificTemplateReplacement in interface IReportEventHandler

Overrides:

reportASTSpecificTemplateReplacement in class DefaultReportEventHandler

Parameters:

oldTemplate -

node -

newHp -

See Also:

• DefaultReportEventHandler.reportASTSpecificTemplateReplacement(java.lang.String, de.monticore.ast.ASTNode, de.monticore.generating.templateengine.HookPoint)

reportSetBeforeTemplate

public void reportSetBeforeTemplate(String template,
 Optional<ASTNode> ast,
 List<? extends HookPoint> beforeHps)

Specified by:

reportSetBeforeTemplate in interface IReportEventHandler

Overrides:

reportSetBeforeTemplate in class DefaultReportEventHandler

Parameters:

template -

beforeHps -

See Also:

• DefaultReportEventHandler.reportSetBeforeTemplate(java.lang.String, Optional, java.util.List)

reportSetAfterTemplate

public void reportSetAfterTemplate(String template,
 Optional<ASTNode> ast,
 List<? extends HookPoint> afterHps)

Specified by:

reportSetAfterTemplate in interface IReportEventHandler

Overrides:

reportSetAfterTemplate in class DefaultReportEventHandler

Parameters:

template -

afterHps -

See Also:

• DefaultReportEventHandler.reportSetAfterTemplate(java.lang.String, Optional, java.util.List)

reportTemplateReplacement

public void reportTemplateReplacement(String oldTemplate,
 List<? extends HookPoint> newHps)

Specified by:

reportTemplateReplacement in interface IReportEventHandler

Overrides:

reportTemplateReplacement in class DefaultReportEventHandler

Parameters:

oldTemplate -

newHps -

See Also:

• IReportEventHandler.reportTemplateReplacement(java.lang.String, java.util.List)

writeHeader

protected void writeHeader()

Specified by:

writeHeader in class AReporter