Package de.monticore.generating.templateengine.reporting.artifacts

Class ArtifactReporter

java.lang.Object

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

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

de.monticore.generating.templateengine.reporting.artifacts.ArtifactReporter

All Implemented Interfaces:

IReportEventHandler

Direct Known Subclasses:

ArtifactGmlReporter, ArtifactGVReporter

public class ArtifactReporter
extends AReporter

Creates a dependency Graph based on a generator run. Dependency Graph can be printed via various printers.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ElementType>	filters
protected AFormatter	formatter
protected RootPkg	rootPkg	Base of the generated dependency graph

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

file, fileextension, fileOpen, qualifiedFileName, reportingHelper

Constructor Summary

Constructors

Constructor	Description
ArtifactReporter(String path, String qualifiedFileName, String fileextension, AFormatter formatter, ElementType... filters)

Method Summary

Modifier and Type	Method	Description
void	addFilter(ElementType filter)	Allow elements of type filter to be displayed.
void	addFilters(ElementType... filters)	Add multiple filters at once
void	count(Element element)
protected void	createElementLink(Element element)	Creates a link from the top element of the stack to the given element.
void	flush(ASTNode node)	Method is called after generation.
protected Element	handleTemplate(String templatename)
void	reportFileCreation(String templatename, String qualifiedfilename, String fileextension, ASTNode ast)
void	reportInstantiate(String className, List<Object> params)
void	reportModelStart(ASTNode ast, String modelName, String fileName)
void	reportTemplateEnd(String templatename, ASTNode ast)
void	reportTemplateStart(String templatename, ASTNode ast)
protected void	resetVariables()
protected void	writeContent()
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, reportAddValue, reportASTSpecificTemplateReplacement, reportCallAfterHookPoint, reportCallBeforeHookPoint, reportCallHookPointEnd, reportCallHookPointStart, reportCallReplacementHookPoint, reportCallSpecificReplacementHookPoint, reportDetailed, reportError, reportErrorInternal, reportErrorUser, reportExecuteStandardTemplate, reportFileCreation, reportFileCreation, reportFileExistenceChecking, reportFileFinalization, reportHWCExistenceCheck, reportMethodCall, reportModelEnd, reportModelLoad, reportOpenInputFile, reportOpenInputFile, reportParseInputFile, reportSetAfterTemplate, reportSetBeforeTemplate, reportSetHookPoint, reportSetValue, reportSymbolTableScope, reportTemplateInclude, reportTemplateReplacement, reportTemplateWrite, reportTransformationNewValue, reportTransformationNewValue, reportTransformationNewValue, reportTransformationObjectChange, reportTransformationObjectCreation, reportTransformationObjectDeletion, reportTransformationObjectMatch, reportTransformationOldValue, reportTransformationOldValue, reportTransformationOldValue, reportTransformationStart, reportUseHandwrittenCodeFile, reportUserSpecificTemplate, reportUserWarning, reportWarning

Methods inherited from class java.lang.Object

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

Field Details

rootPkg

protected RootPkg rootPkg

Base of the generated dependency graph

formatter

protected AFormatter formatter

filters

protected List<ElementType> filters

Constructor Details

ArtifactReporter

public ArtifactReporter(String path,
 String qualifiedFileName,
 String fileextension,
 AFormatter formatter,
 ElementType... filters)

Method Details

addFilter

public void addFilter(ElementType filter)

Allow elements of type filter to be displayed. First invocation disables all other types

addFilters

public void addFilters(ElementType... filters)

Add multiple filters at once

See Also:

• addFilter(de.monticore.generating.templateengine.reporting.artifacts.model.ElementType)

reportModelStart

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

Specified by:

reportModelStart in interface IReportEventHandler

Overrides:

reportModelStart in class DefaultReportEventHandler

reportTemplateEnd

public void reportTemplateEnd(String templatename,
 ASTNode ast)

Specified by:

reportTemplateEnd in interface IReportEventHandler

Overrides:

reportTemplateEnd in class DefaultReportEventHandler

Parameters:

templatename -

ast -

reportTemplateStart

public void reportTemplateStart(String templatename,
 ASTNode ast)

Specified by:

reportTemplateStart in interface IReportEventHandler

Overrides:

reportTemplateStart in class DefaultReportEventHandler

reportFileCreation

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

Specified by:

reportFileCreation in interface IReportEventHandler

Overrides:

reportFileCreation in class DefaultReportEventHandler

handleTemplate

protected Element handleTemplate(String templatename)

Parameters:

templatename -

Returns:

reportInstantiate

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

Specified by:

reportInstantiate in interface IReportEventHandler

Overrides:

reportInstantiate in class DefaultReportEventHandler

Parameters:

className -

params -

flush

public void flush(ASTNode node)

Description copied from class: AReporter

Method is called after generation.

Specified by:

flush in interface IReportEventHandler

Overrides:

flush in class AReporter

Parameters:

node - Compilation unit AST or null on error

resetVariables

protected void resetVariables()

writeContent

protected void writeContent()

createElementLink

protected void createElementLink(Element element)

Creates a link from the top element of the stack to the given element. This only works if the stack is not empty.

Parameters:

element -

count

public void count(Element element)

writeHeader

protected void writeHeader()

Specified by:

writeHeader in class AReporter

See Also:

• AReporter.writeHeader()