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

Class DetailedReporter

java.lang.Object

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

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

de.monticore.generating.templateengine.reporting.reporter.DetailedReporter

All Implemented Interfaces:

IReportEventHandler

public class DetailedReporter
extends AReporter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_GLOBAL_VARIABLE
static final String	ERROR
static final String	GENERATED_FILE_CLOSED
static final String	GENERATED_FILE_OPENED
static final String	INSTANTIATE_JAVA_CLASS
protected ReportingRepository	repository
static final String	SET_GLOBAL_VARIABLE
static final String	SIMPLE_FILE_NAME
static final String	TEMPLATE_CALLED
static final String	TEMPLATE_ENDED
protected int	templateDepth
static final String	WARNING

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

file, fileextension, fileOpen, qualifiedFileName, reportingHelper

Constructor Summary

Constructors

Constructor	Description
DetailedReporter(String outputDir, String modelName, ReportingRepository repository)

Method Summary

Modifier and Type	Method	Description
protected static String	calculateLine(String value)
void	flush(ASTNode ast)	Method is called after generation.
protected String	getLineStart(ASTNode node)
void	reportAddValue(String name, Object value, int size)
void	reportDetailed(String value)
void	reportError(String message)
void	reportFileCreation(String templatename, String qualifiedfilename, String fileextension, ASTNode ast)
void	reportFileFinalization(String templatename, String qualifiedfilename, String fileextension, ASTNode ast)
void	reportInstantiate(String className, List<Object> params)
void	reportSetValue(String name, Object value)
protected void	reportTemplateAction(ASTNode astNode, String templatename, String actionType)
void	reportTemplateEnd(String templatename, ASTNode ast)
void	reportTemplateStart(String templatename, ASTNode ast)
void	reportWarning(String message)
protected void	resetVariables()
String	valueStr(ASTNode ast)	Uses ast2idents to print a compact version for any form of object
protected void	writeFooter()
protected void	writeHeader()

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, reportASTSpecificTemplateReplacement, reportCallAfterHookPoint, reportCallBeforeHookPoint, reportCallHookPointEnd, reportCallHookPointStart, reportCallReplacementHookPoint, reportCallSpecificReplacementHookPoint, reportErrorInternal, reportErrorUser, reportExecuteStandardTemplate, reportFileCreation, reportFileCreation, reportFileExistenceChecking, reportHWCExistenceCheck, reportMethodCall, reportModelEnd, reportModelLoad, reportModelStart, reportOpenInputFile, reportOpenInputFile, reportParseInputFile, reportSetAfterTemplate, reportSetBeforeTemplate, reportSetHookPoint, reportSymbolTableScope, reportTemplateInclude, reportTemplateReplacement, reportTemplateWrite, reportTransformationNewValue, reportTransformationNewValue, reportTransformationNewValue, reportTransformationObjectChange, reportTransformationObjectCreation, reportTransformationObjectDeletion, reportTransformationObjectMatch, reportTransformationOldValue, reportTransformationOldValue, reportTransformationOldValue, reportTransformationStart, reportUseHandwrittenCodeFile, reportUserSpecificTemplate, reportUserWarning

Methods inherited from class java.lang.Object

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

Field Details

GENERATED_FILE_OPENED

public static final String GENERATED_FILE_OPENED

See Also:

• Constant Field Values

GENERATED_FILE_CLOSED

public static final String GENERATED_FILE_CLOSED

See Also:

• Constant Field Values

TEMPLATE_CALLED

public static final String TEMPLATE_CALLED

See Also:

• Constant Field Values

TEMPLATE_ENDED

public static final String TEMPLATE_ENDED

See Also:

• Constant Field Values

INSTANTIATE_JAVA_CLASS

public static final String INSTANTIATE_JAVA_CLASS

See Also:

• Constant Field Values

SET_GLOBAL_VARIABLE

public static final String SET_GLOBAL_VARIABLE

See Also:

• Constant Field Values

ADD_GLOBAL_VARIABLE

public static final String ADD_GLOBAL_VARIABLE

See Also:

• Constant Field Values

SIMPLE_FILE_NAME

public static final String SIMPLE_FILE_NAME

See Also:

• Constant Field Values

ERROR

public static final String ERROR

See Also:

• Constant Field Values

WARNING

public static final String WARNING

See Also:

• Constant Field Values

repository

protected ReportingRepository repository

templateDepth

protected int templateDepth

Constructor Details

DetailedReporter

public DetailedReporter(String outputDir,
 String modelName,
 ReportingRepository repository)

Method Details

writeHeader

protected void writeHeader()

Specified by:

writeHeader in class AReporter

writeFooter

protected void writeFooter()

reportTemplateStart

public void reportTemplateStart(String templatename,
 ASTNode ast)

Specified by:

reportTemplateStart in interface IReportEventHandler

Overrides:

reportTemplateStart in class DefaultReportEventHandler

valueStr

public String valueStr(ASTNode ast)

Uses ast2idents to print a compact version for any form of object

Parameters:

ast - node to be printed

Returns:

usable representation (one liner)

reportTemplateEnd

public void reportTemplateEnd(String templatename,
 ASTNode ast)

Specified by:

reportTemplateEnd in interface IReportEventHandler

Overrides:

reportTemplateEnd in class DefaultReportEventHandler

Parameters:

templatename -

ast -

See Also:

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

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:

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

reportSetValue

public void reportSetValue(String name,
 Object value)

Specified by:

reportSetValue in interface IReportEventHandler

Overrides:

reportSetValue in class DefaultReportEventHandler

Parameters:

name -

value -

See Also:

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

reportAddValue

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

Specified by:

reportAddValue in interface IReportEventHandler

Overrides:

reportAddValue in class DefaultReportEventHandler

Parameters:

name -

value -

size -

See Also:

• DefaultReportEventHandler.reportAddValue(java.lang.String, java.lang.Object, int)

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)

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)

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:

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

reportFileFinalization

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

Specified by:

reportFileFinalization in interface IReportEventHandler

Overrides:

reportFileFinalization in class DefaultReportEventHandler

See Also:

• IReportEventHandler.reportFileFinalization(java.lang.String, java.lang.String, java.lang.String, de.monticore.ast.ASTNode)

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

resetVariables

protected void resetVariables()

getLineStart

protected String getLineStart(ASTNode node)

reportDetailed

public void reportDetailed(String value)

Specified by:

reportDetailed in interface IReportEventHandler

Overrides:

reportDetailed in class DefaultReportEventHandler

See Also:

• DefaultReportEventHandler.reportDetailed(java.lang.String)

calculateLine

protected static String calculateLine(String value)

reportTemplateAction

protected void reportTemplateAction(ASTNode astNode,
 String templatename,
 String actionType)