com.jiowa.codegen.generator

Class AbstractGenerator

java.lang.Object

com.jiowa.codegen.generator.AbstractGenerator

All Implemented Interfaces:

Generator

Direct Known Subclasses:

ClassGenerator, LetterGenerator

public abstract class AbstractGenerator
extends java.lang.Object
implements Generator

Abstract source generator class which serves as base class for all generators.

Link to the corresponding slide in the tutorial on slideshare.

Author:

Robert Mencl

Copyright (C) 2012-2015 JIOWA Business Solutions GmbH, Bettinastr. 30 , 60325 Frankfurt am Main, Germany
Homepage: www.jiowa.de
All rights reserved.

Download: www.jiowa.de/download.html
License: www.jiowa.de/license.html

Field Summary

Fields

Modifier and Type	Field and Description
protected JiowaCodeGenConfig	config configuration class for code generation
protected java.lang.String	destinationDirectory destination directory for the generated source code

Constructor Summary

Constructors

Constructor and Description
AbstractGenerator(JiowaCodeGenConfig config) Each generator carries a config class which contains all necessary information for a generator from a given property file

Method Summary

Modifier and Type	Method and Description
abstract void	generate() Starts the generation process of this code generator.
protected JiowaCodeGenConfig	getConfig() Returns the application configuration class for this class.
protected java.lang.String	getDestinationDirectory() Returns the destination directory for the generated source code.
protected java.lang.String	updateSourceFile(java.lang.String relativePathAndFilename, java.lang.String source) Updates an existing source file (protected regions are also considered) and additionally returns the source text as result (for possible further computations).
protected java.lang.String	updateSourceFile(java.lang.String relativePathAndFilename, TemplateBean t) Updates an existing source file (protected regions are also considered) and additionally returns the source text as result (for possible further computations).

Methods inherited from class java.lang.Object

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

Field Detail

destinationDirectory

protected java.lang.String destinationDirectory

destination directory for the generated source code

config

protected JiowaCodeGenConfig config

configuration class for code generation

Constructor Detail

AbstractGenerator

public AbstractGenerator(JiowaCodeGenConfig config)

Each generator carries a config class which contains all necessary information for a generator from a given property file

Parameters:

config - the codegen config

Method Detail

getConfig

protected JiowaCodeGenConfig getConfig()

Returns the application configuration class for this class.

generate

public abstract void generate()

Starts the generation process of this code generator. This method must be implemented in derived generators.

Specified by:

generate in interface Generator

getDestinationDirectory

protected java.lang.String getDestinationDirectory()

Returns the destination directory for the generated source code.

Returns:

source code destination directory

updateSourceFile

protected java.lang.String updateSourceFile(java.lang.String relativePathAndFilename,
                                            TemplateBean t)

Updates an existing source file (protected regions are also considered) and additionally returns the source text as result (for possible further computations).

Parameters:

relativePathAndFilename - filepath relative to the given destination directory which is defined in JiowaCodeGenConfig via the property file (usually jiowa.codegen.properties).

t - the template bean

Returns:

the updated source

updateSourceFile

protected java.lang.String updateSourceFile(java.lang.String relativePathAndFilename,
                                            java.lang.String source)

Updates an existing source file (protected regions are also considered) and additionally returns the source text as result (for possible further computations).

Parameters:

relativePathAndFilename - filepath relative to the given destination directory which is defined in JiowaCodeGenConfig via the property file (usually jiowa.codegen.properties).

source - new text source

Returns:

the updated source