Package de.monticore.generating.templateengine.reporting.commons

Class ReportLogHook

java.lang.Object

de.monticore.generating.templateengine.reporting.commons.ReportLogHook

All Implemented Interfaces:

IReportEventHandler, de.se_rwth.commons.logging.ILogHook

public class ReportLogHook
extends Object
implements de.se_rwth.commons.logging.ILogHook, IReportEventHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected ReportManager.ReportManagerFactory	factory	For creating report managers on-demand for newly processed models.
protected String	reportDirectory	Where reports will be written to.
protected Map<String,ReportManager>	reportManagers	Map of model names to actual report managers.

Constructor Summary

Constructors

Constructor	Description
ReportLogHook(String reportDirectory, ReportManager.ReportManagerFactory factory)

Method Summary

Modifier and Type	Method	Description
void	doErrPrint(String msg)
void	doErrPrintStackTrace(Throwable t)
void	doPrint(String msg)
void	doPrintln(String msg)
void	doPrintStackTrace(Throwable t)
void	doWarn(de.se_rwth.commons.logging.Finding warn)
void	doWarn(de.se_rwth.commons.logging.Finding warn, Throwable t)
void	flush(ASTNode ast)
protected ReportManager.ReportManagerFactory	getFactory()
protected String	getReportDirectory()
protected ReportManager	getReportManager()
protected ReportManager	getReportManager(String modelName)
protected Map<String,ReportManager>	getReportManagers()
void	reportAddAfterTemplate(String template, Optional<ASTNode> ast, List<? extends HookPoint> afterHps)
void	reportAddBeforeTemplate(String template, Optional<ASTNode> ast, List<? extends HookPoint> beforeHps)
void	reportAddValue(String name, Object value, int size)
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	reportCallHookPointEnd(String hookName)
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	reportDetailed(String value)
void	reportError(String message)
void	reportErrorInternal(String message)
void	reportErrorUser(String message)
void	reportExecuteStandardTemplate(String templatename, ASTNode ast)
void	reportFileCreation(String fileName)
void	reportFileCreation(String templatename, String qualifiedfilename, String fileextension, ASTNode ast)
void	reportFileCreation(String templateName, Path path, ASTNode ast)
void	reportFileCreation(Path parentPath, Path file)
void	reportFileExistenceChecking(List<Path> parentPath, Path file)
void	reportFileFinalization(String templatename, String qualifiedfilename, String fileextension, ASTNode ast)
void	reportFileFinalization(String templateName, Path path, ASTNode ast)
void	reportHWCExistenceCheck(MCPath mcp, Path fileName, Optional<URL> exists)
void	reportInstantiate(String className, List<Object> params)
void	reportMethodCall(String className, String methodName, List<Object> params)
void	reportModelEnd(String modelname, String filename)
void	reportModelLoad(String qualifiedName)
void	reportModelStart(ASTNode ast, String modelName, String fileName)
void	reportOpenInputFile(String fileName)
void	reportOpenInputFile(Optional<Path> parentPath, Path file)
void	reportParseInputFile(Path inputFilePath, String modelName)
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	reportSymbolTableScope(IScope scope)
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	reportTransformationNewValue(String transformationName, boolean value)
void	reportTransformationNewValue(String transformationName, ASTNode ast)
void	reportTransformationNewValue(String transformationName, String value)
void	reportTransformationObjectChange(String transformationName, ASTNode ast, String attributeName)
void	reportTransformationObjectCreation(String transformationName, ASTNode ast)
void	reportTransformationObjectDeletion(String transformationName, ASTNode ast)
void	reportTransformationObjectMatch(String transformationName, ASTNode ast)
void	reportTransformationOldValue(String transformationName, boolean value)
void	reportTransformationOldValue(String transformationName, ASTNode ast)
void	reportTransformationOldValue(String transformationName, String value)
void	reportTransformationStart(String transformationName)
void	reportUseHandwrittenCodeFile(Path parentDir, Path fileName)
void	reportUserSpecificTemplate(Path parentDir, Path fileName)
void	reportUserWarning(String message)
void	reportWarning(String message)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.se_rwth.commons.logging.ILogHook

doDebug, doDebug, doDebug, doDebug, doError, doError, doErrorUser, doErrorUser, doInfo, doInfo, doTrace, doTrace, formatError, formatErrorUser, formatInfo, formatWarn

Field Details

reportManagers

protected Map<String,ReportManager> reportManagers

Map of model names to actual report managers.

factory

protected ReportManager.ReportManagerFactory factory

For creating report managers on-demand for newly processed models.

reportDirectory

protected String reportDirectory

Where reports will be written to.

Constructor Details

ReportLogHook

public ReportLogHook(String reportDirectory,
 ReportManager.ReportManagerFactory factory)

Parameters:

reportDirectory - for storing the reports

factory - for creating specific report manager configurations

Method Details

doPrintln

public void doPrintln(String msg)

Specified by:

doPrintln in interface de.se_rwth.commons.logging.ILogHook

doErrPrint

public void doErrPrint(String msg)

Specified by:

doErrPrint in interface de.se_rwth.commons.logging.ILogHook

doWarn

public void doWarn(de.se_rwth.commons.logging.Finding warn)

Specified by:

doWarn in interface de.se_rwth.commons.logging.ILogHook

doWarn

public void doWarn(de.se_rwth.commons.logging.Finding warn,
 Throwable t)

Specified by:

doWarn in interface de.se_rwth.commons.logging.ILogHook

doPrintStackTrace

public void doPrintStackTrace(Throwable t)

Specified by:

doPrintStackTrace in interface de.se_rwth.commons.logging.ILogHook

doErrPrintStackTrace

public void doErrPrintStackTrace(Throwable t)

Specified by:

doErrPrintStackTrace in interface de.se_rwth.commons.logging.ILogHook

doPrint

public void doPrint(String msg)

Specified by:

doPrint in interface de.se_rwth.commons.logging.ILogHook

getReportManagers

protected Map<String,ReportManager> getReportManagers()

getReportManager

protected ReportManager getReportManager(String modelName)

getReportManager

protected ReportManager getReportManager()

Returns:

the currently active/responsible report manager instance

getFactory

protected ReportManager.ReportManagerFactory getFactory()

getReportDirectory

protected String getReportDirectory()

reportModelStart

public void reportModelStart(ASTNode ast,
 String modelName,
 String fileName)

Specified by:

reportModelStart in interface IReportEventHandler

reportTemplateStart

public void reportTemplateStart(String templatename,
 ASTNode ast)

Specified by:

reportTemplateStart in interface IReportEventHandler

reportExecuteStandardTemplate

public void reportExecuteStandardTemplate(String templatename,
 ASTNode ast)

Specified by:

reportExecuteStandardTemplate in interface IReportEventHandler

reportFileCreation

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

Specified by:

reportFileCreation in interface IReportEventHandler

reportFileCreation

public void reportFileCreation(String templateName,
 Path path,
 ASTNode ast)

reportFileCreation

public void reportFileCreation(Path parentPath,
 Path file)

Specified by:

reportFileCreation in interface IReportEventHandler

reportFileFinalization

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

Specified by:

reportFileFinalization in interface IReportEventHandler

reportFileFinalization

public void reportFileFinalization(String templateName,
 Path path,
 ASTNode ast)

reportTemplateEnd

public void reportTemplateEnd(String templatename,
 ASTNode ast)

Specified by:

reportTemplateEnd in interface IReportEventHandler

Parameters:

templatename -

ast -

reportModelEnd

public void reportModelEnd(String modelname,
 String filename)

Specified by:

reportModelEnd in interface IReportEventHandler

Parameters:

modelname -

filename -

reportModelLoad

public void reportModelLoad(String qualifiedName)

Specified by:

reportModelLoad in interface IReportEventHandler

Parameters:

qualifiedName -

reportSetValue

public void reportSetValue(String name,
 Object value)

Specified by:

reportSetValue in interface IReportEventHandler

Parameters:

name -

value -

reportAddValue

public void reportAddValue(String name,
 Object value,
 int size)

Specified by:

reportAddValue in interface IReportEventHandler

Parameters:

name -

value -

size -

reportInstantiate

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

Specified by:

reportInstantiate in interface IReportEventHandler

Parameters:

className -

params -

reportTemplateInclude

public void reportTemplateInclude(String templateName,
 ASTNode ast)

Specified by:

reportTemplateInclude in interface IReportEventHandler

Parameters:

templateName -

ast -

reportTemplateWrite

public void reportTemplateWrite(String templateName,
 ASTNode ast)

Specified by:

reportTemplateWrite in interface IReportEventHandler

Parameters:

templateName -

ast -

reportSetHookPoint

public void reportSetHookPoint(String hookName,
 HookPoint hp)

Specified by:

reportSetHookPoint in interface IReportEventHandler

Parameters:

hookName -

hp -

reportCallHookPointStart

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

Specified by:

reportCallHookPointStart in interface IReportEventHandler

Parameters:

hookName -

hp -

ast -

reportCallHookPointEnd

public void reportCallHookPointEnd(String hookName)

Specified by:

reportCallHookPointEnd in interface IReportEventHandler

Parameters:

hookName -

reportASTSpecificTemplateReplacement

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

Specified by:

reportASTSpecificTemplateReplacement in interface IReportEventHandler

Parameters:

oldTemplate -

node -

newHp -

reportCallSpecificReplacementHookPoint

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

Specified by:

reportCallSpecificReplacementHookPoint in interface IReportEventHandler

Parameters:

oldTemplate -

hps -

ast -

reportCallReplacementHookPoint

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

Specified by:

reportCallReplacementHookPoint in interface IReportEventHandler

Parameters:

oldTemplate -

hps -

ast -

reportCallBeforeHookPoint

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

Specified by:

reportCallBeforeHookPoint in interface IReportEventHandler

Parameters:

oldTemplate -

beforeHPs -

ast -

reportCallAfterHookPoint

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

Specified by:

reportCallAfterHookPoint in interface IReportEventHandler

Parameters:

oldTemplate -

afterHPs -

ast -

reportTemplateReplacement

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

Specified by:

reportTemplateReplacement in interface IReportEventHandler

Parameters:

oldTemplate -

newHps -

reportSetBeforeTemplate

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

Specified by:

reportSetBeforeTemplate in interface IReportEventHandler

Parameters:

template -

beforeHps -

reportSetAfterTemplate

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

Specified by:

reportSetAfterTemplate in interface IReportEventHandler

Parameters:

template -

afterHps -

reportAddAfterTemplate

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

Specified by:

reportAddAfterTemplate in interface IReportEventHandler

Parameters:

template -

ast -

afterHps -

reportAddBeforeTemplate

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

Specified by:

reportAddBeforeTemplate in interface IReportEventHandler

Parameters:

template -

ast -

beforeHps -

reportTransformationStart

public void reportTransformationStart(String transformationName)

Specified by:

reportTransformationStart in interface IReportEventHandler

Parameters:

transformationName -

flush

public void flush(ASTNode ast)

Specified by:

flush in interface IReportEventHandler

reportUseHandwrittenCodeFile

public void reportUseHandwrittenCodeFile(Path parentDir,
 Path fileName)

Specified by:

reportUseHandwrittenCodeFile in interface IReportEventHandler

Parameters:

fileName -

reportHWCExistenceCheck

public void reportHWCExistenceCheck(MCPath mcp,
 Path fileName,
 Optional<URL> exists)

Specified by:

reportHWCExistenceCheck in interface IReportEventHandler

reportUserSpecificTemplate

public void reportUserSpecificTemplate(Path parentDir,
 Path fileName)

Specified by:

reportUserSpecificTemplate in interface IReportEventHandler

Parameters:

fileName -

reportWarning

public void reportWarning(String message)

Specified by:

reportWarning in interface IReportEventHandler

Parameters:

message -

reportUserWarning

public void reportUserWarning(String message)

Specified by:

reportUserWarning in interface IReportEventHandler

Parameters:

message -

reportError

public void reportError(String message)

Specified by:

reportError in interface IReportEventHandler

Parameters:

message -

reportErrorUser

public void reportErrorUser(String message)

Specified by:

reportErrorUser in interface IReportEventHandler

Parameters:

message -

reportErrorInternal

public void reportErrorInternal(String message)

Specified by:

reportErrorInternal in interface IReportEventHandler

Parameters:

message -

reportTransformationObjectChange

public void reportTransformationObjectChange(String transformationName,
 ASTNode ast,
 String attributeName)

Specified by:

reportTransformationObjectChange in interface IReportEventHandler

Parameters:

transformationName -

attributeName -

reportTransformationObjectCreation

public void reportTransformationObjectCreation(String transformationName,
 ASTNode ast)

Specified by:

reportTransformationObjectCreation in interface IReportEventHandler

Parameters:

transformationName -

reportTransformationObjectDeletion

public void reportTransformationObjectDeletion(String transformationName,
 ASTNode ast)

Specified by:

reportTransformationObjectDeletion in interface IReportEventHandler

Parameters:

transformationName -

ast -

reportDetailed

public void reportDetailed(String value)

Specified by:

reportDetailed in interface IReportEventHandler

reportOpenInputFile

public void reportOpenInputFile(Optional<Path> parentPath,
 Path file)

Specified by:

reportOpenInputFile in interface IReportEventHandler

reportParseInputFile

public void reportParseInputFile(Path inputFilePath,
 String modelName)

Specified by:

reportParseInputFile in interface IReportEventHandler

reportSymbolTableScope

public void reportSymbolTableScope(IScope scope)

Specified by:

reportSymbolTableScope in interface IReportEventHandler

Parameters:

scope -

reportMethodCall

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

Specified by:

reportMethodCall in interface IReportEventHandler

Parameters:

className -

methodName -

params -

reportTransformationObjectMatch

public void reportTransformationObjectMatch(String transformationName,
 ASTNode ast)

Specified by:

reportTransformationObjectMatch in interface IReportEventHandler

reportTransformationOldValue

public void reportTransformationOldValue(String transformationName,
 ASTNode ast)

Specified by:

reportTransformationOldValue in interface IReportEventHandler

reportTransformationNewValue

public void reportTransformationNewValue(String transformationName,
 ASTNode ast)

Specified by:

reportTransformationNewValue in interface IReportEventHandler

reportTransformationOldValue

public void reportTransformationOldValue(String transformationName,
 String value)

Specified by:

reportTransformationOldValue in interface IReportEventHandler

reportTransformationNewValue

public void reportTransformationNewValue(String transformationName,
 String value)

Specified by:

reportTransformationNewValue in interface IReportEventHandler

reportTransformationOldValue

public void reportTransformationOldValue(String transformationName,
 boolean value)

Specified by:

reportTransformationOldValue in interface IReportEventHandler

reportTransformationNewValue

public void reportTransformationNewValue(String transformationName,
 boolean value)

Specified by:

reportTransformationNewValue in interface IReportEventHandler

reportFileCreation

public void reportFileCreation(String fileName)

Specified by:

reportFileCreation in interface IReportEventHandler

reportOpenInputFile

public void reportOpenInputFile(String fileName)

Specified by:

reportOpenInputFile in interface IReportEventHandler

reportFileExistenceChecking

public void reportFileExistenceChecking(List<Path> parentPath,
 Path file)

Specified by:

reportFileExistenceChecking in interface IReportEventHandler