JiowaTemplateBeanGenerator

java.lang.Object
- com.jiowa.template.bean.generator.JiowaTemplateBeanGenerator

Direct Known Subclasses:

JiowaCodeGenTemplateBeanGenerator
```
public abstract class JiowaTemplateBeanGenerator
extends java.lang.Object
```
This class generates the template beans for all templates within the template directory. The configuration of this class occurs via the JiowaTemplateConfig class, which is able to read multiple property files and using "property overloading and inheritance".

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 static java.lang.String`	`BEAN_TEMPLATE_COMPILER_RESULT_CLASSNAME` Java class name for compile time result errrors and warnings
`protected static java.lang.String`	`BEAN_TEMPLATE_COMPILER_RESULT_FILENAME` Java class file name for compile time errors
`protected static java.lang.String`	`BEAN_TEMPLATE_FILENAME` Root bean generator template
`protected java.io.File`	`beanOutputDirectory` Output directory for template beans
`protected java.io.File`	`beanOutputDirectoryWithoutPackageName`
`protected Template`	`beanTemplate` The parsed bean template
`protected TemplateMap`	`beanTemplateMap` TemplateMap for bean generator templates
`protected static java.lang.String`	`BGT` Suffix for bean generator templates
`protected static java.lang.String`	`CHECK_TEMPLATE_SYNTAX_ONLY_CMD` Flag if only a syntax check on the templates has to be performed
`protected boolean`	`checkTemplateSyntaxOnly` If set to true this flag causes to check only syntax and deliver appropriate errors/warnings in the console without generating any template beans.
`protected static java.lang.String`	`COMPILER_RESULT_PACKAGE`
`protected Template`	`compileTimeResultTemplate` The parsed compile time result template which is used to force a compile time error if syntax errors are present in the templates
`protected JiowaTemplateConfig`	`config` Contains the template configuration text from the property file.
`protected static java.lang.String`	`JAR_FILE_SUFFIX` File suffix for jar files
`protected java.util.Set<java.lang.String>`	`messages` Set of messages to be printed
`protected TemplateNotation`	`notation` The given template notation
`protected static int`	`NUMBER_OF_TEMPLATE_NAMES_TO_SHOW_IN_LOG_MESSAGE` number of templates to show in log message
`protected com.jiowa.util.tuple.Tuple<java.io.File,java.util.jar.JarFile>`	`resourceLocation` Location for the configuration for the template bean generator
`protected TemplateMap`	`templateMap` TemplateMap for user templates
`protected java.lang.Boolean`	`upToDateFlag` is set to true if timestamps indicate that no re-generation is necessary
`protected static java.lang.String`	`VERSION_FILE_SUFFIX` Suffix for the template bean version file

Constructor Summary

Constructors
Constructor and Description
`JiowaTemplateBeanGenerator(JiowaTemplateConfig config, boolean checkTemplateSyntaxOnly)` Basic constructor for the template bean generator: see `JiowaTemplateConfig` for usage of the config class.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`checkProtectedRegionsInTemplates()`
`protected TagValueMap`	`computeSubTemplateStructureTagMap(SubTemplateStructureTag tag)` Computes the pre-compiled toString()-method text for a subtemplate structure tag.
`protected TagValueMap`	`computeTextOperatorTagMap(TextOperatorTag tag)`
`protected TagValueMap`	`computeTextTagMap(TextTag tag)` Computes the `TagValueMap` for `TextTag`s
`protected TagValueMap`	`computeVariableTagMap(VariableTag tag)` Computes the pre-compiled toString()-method text for variable tag.
`protected TemplateMapLoader`	`createBeanTemplateMapLoader()` Ceates the bean template map loader to load all bean templates for the resource location.
`protected java.lang.String`	`createCommentedErrorsString()`
`protected java.lang.String`	`createErrorsString()`
`protected java.lang.String`	`createID(java.lang.String templateName)`
`protected java.lang.String`	`createMessageString(java.util.List<com.jiowa.logging.LogEntry> list, java.lang.String prefixString)`
`protected java.lang.String`	`createWarningsString()`
`protected com.jiowa.util.tuple.Tuple<java.io.File,java.util.jar.JarFile>`	`determineResourceLocation()` Determines the resource location for the template bean generator configuration.
`protected java.lang.String`	`determineRunningVersion()`
`void`	`generate()` Generates the template beans.
`protected java.lang.String`	`generateCompileTimeResultClass(Template template)`
`protected java.lang.String`	`generateTemplateBean(Template template, java.lang.String packageName)` Generates the text of a template bean out of an template.
`protected void`	`initialize()` Initializes the bean template map.
`protected boolean`	`isUpToDate()` Checks if anything has to be (re-)generated at all.
`protected TemplateMap`	`loadBeanTemplateMap()`
`protected TemplateMap`	`loadCurrentTemplateMap(TemplateDirs2Package dirs2Package)` Loads the template map for the given template directory set.
`protected void`	`logUniqueErrorMessage(java.lang.String msg)` Logs an error message only if it does not have been logged before.
`protected boolean`	`previousTemplateBeansHaveBeenGeneratedBySameProgramVersion()` Returns true if the already existing template beans have been generated by the same program version and false, otherwise.
`protected void`	`printSummarizingMessages()` Prints summarizing messages after the generation process.
`protected void`	`processBeanPartInitializer(java.util.List<Tag> list, TagValueMap map)` Initializes the bean for the toString() method, i.e.
`protected void`	`processSubTemplateStructure(java.lang.String identifier, java.util.Collection<AbstractSubTemplateTag> subTemplates, TagValueMap map)`
`protected void`	`processSubTemplateStructure(SubTemplateStructureTag subStructureTag, TagValueMap map)` Process a single subtemplate structure, i.e. process all subtemplates and inline subtemplates and prepare the next recursive call of this method until all substructures have been processed.
`protected void`	`processSubTemplateStructureList(java.util.List<SubTemplateStructureTag> tagList, TagValueMap map)`
`protected void`	`processVariableList(java.util.List<VariableTag> tagList, TagValueMap map)`
`protected void`	`writeSource(java.lang.String filePath, java.lang.String beanText)` Writes the bean text to a file.
`protected void`	`writeVersionFile()` Writes the program version to the bean directory in order to being able to find out which program version wrote all beans.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - config
```
protected JiowaTemplateConfig config
```
    Contains the template configuration text from the property file.
  - BGT
```
protected static final java.lang.String BGT
```
    Suffix for bean generator templates
    
    See Also:
    
    Constant Field Values
  - BEAN_TEMPLATE_FILENAME
```
protected static final java.lang.String BEAN_TEMPLATE_FILENAME
```
    Root bean generator template
    
    See Also:
    
    Constant Field Values
  - BEAN_TEMPLATE_COMPILER_RESULT_CLASSNAME
```
protected static final java.lang.String BEAN_TEMPLATE_COMPILER_RESULT_CLASSNAME
```
    Java class name for compile time result errrors and warnings
    
    See Also:
    
    Constant Field Values
  - BEAN_TEMPLATE_COMPILER_RESULT_FILENAME
```
protected static final java.lang.String BEAN_TEMPLATE_COMPILER_RESULT_FILENAME
```
    Java class file name for compile time errors
    
    See Also:
    
    Constant Field Values
  - beanTemplate
```
protected Template beanTemplate
```
    The parsed bean template
  - compileTimeResultTemplate
```
protected Template compileTimeResultTemplate
```
    The parsed compile time result template which is used to force a compile time error if syntax errors are present in the templates
  - beanOutputDirectory
```
protected java.io.File beanOutputDirectory
```
    Output directory for template beans
  - beanOutputDirectoryWithoutPackageName
```
protected java.io.File beanOutputDirectoryWithoutPackageName
```
  - beanTemplateMap
```
protected TemplateMap beanTemplateMap
```
    TemplateMap for bean generator templates
  - templateMap
```
protected TemplateMap templateMap
```
    TemplateMap for user templates
  - notation
```
protected TemplateNotation notation
```
    The given template notation
  - NUMBER_OF_TEMPLATE_NAMES_TO_SHOW_IN_LOG_MESSAGE
```
protected static final int NUMBER_OF_TEMPLATE_NAMES_TO_SHOW_IN_LOG_MESSAGE
```
    number of templates to show in log message
    
    See Also:
    
    Constant Field Values
  - resourceLocation
```
protected com.jiowa.util.tuple.Tuple<java.io.File,java.util.jar.JarFile> resourceLocation
```
    Location for the configuration for the template bean generator
  - upToDateFlag
```
protected java.lang.Boolean upToDateFlag
```
    is set to true if timestamps indicate that no re-generation is necessary
  - messages
```
protected java.util.Set<java.lang.String> messages
```
    Set of messages to be printed
  - checkTemplateSyntaxOnly
```
protected boolean checkTemplateSyntaxOnly
```
    If set to true this flag causes to check only syntax and deliver appropriate errors/warnings in the console without generating any template beans.
  - CHECK_TEMPLATE_SYNTAX_ONLY_CMD
```
protected static final java.lang.String CHECK_TEMPLATE_SYNTAX_ONLY_CMD
```
    Flag if only a syntax check on the templates has to be performed
    
    See Also:
    
    Constant Field Values
  - JAR_FILE_SUFFIX
```
protected static final java.lang.String JAR_FILE_SUFFIX
```
    File suffix for jar files
    
    See Also:
    
    Constant Field Values
  - VERSION_FILE_SUFFIX
```
protected static final java.lang.String VERSION_FILE_SUFFIX
```
    Suffix for the template bean version file
    
    See Also:
    
    Constant Field Values
  - COMPILER_RESULT_PACKAGE
```
protected static final java.lang.String COMPILER_RESULT_PACKAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JiowaTemplateBeanGenerator
```
public JiowaTemplateBeanGenerator(JiowaTemplateConfig config,
                                  boolean checkTemplateSyntaxOnly)
```
    Basic constructor for the template bean generator: see JiowaTemplateConfig for usage of the config class.
    
    Parameters:
    
    config - the configuration for the template bean generation
    
    checkTemplateSyntaxOnly - a flag if only a syntax has to be performed
- Method Detail
  - generate
```
public void generate()
```
    Generates the template beans.
  - checkProtectedRegionsInTemplates
```
protected abstract void checkProtectedRegionsInTemplates()
```
  - printSummarizingMessages
```
protected void printSummarizingMessages()
```
    Prints summarizing messages after the generation process.
  - writeVersionFile
```
protected void writeVersionFile()
```
    Writes the program version to the bean directory in order to being able to find out which program version wrote all beans.
  - createWarningsString
```
protected java.lang.String createWarningsString()
```
  - createErrorsString
```
protected java.lang.String createErrorsString()
```
  - createCommentedErrorsString
```
protected java.lang.String createCommentedErrorsString()
```
  - createMessageString
```
protected java.lang.String createMessageString(java.util.List<com.jiowa.logging.LogEntry> list,
                                               java.lang.String prefixString)
```
  - generateCompileTimeResultClass
```
protected java.lang.String generateCompileTimeResultClass(Template template)
```
  - determineRunningVersion
```
protected java.lang.String determineRunningVersion()
```
  - generateTemplateBean
```
protected java.lang.String generateTemplateBean(Template template,
                                                java.lang.String packageName)
```
    Generates the text of a template bean out of an template.
    
    Parameters:
    
    template - the template instance
    
    packageName - package name for the template bean
    
    Returns:
    
    the template bean as java source
  - processVariableList
```
protected void processVariableList(java.util.List<VariableTag> tagList,
                                   TagValueMap map)
```
  - processSubTemplateStructureList
```
protected void processSubTemplateStructureList(java.util.List<SubTemplateStructureTag> tagList,
                                               TagValueMap map)
```
  - createID
```
protected java.lang.String createID(java.lang.String templateName)
```
  - processSubTemplateStructure
```
protected void processSubTemplateStructure(java.lang.String identifier,
                                           java.util.Collection<AbstractSubTemplateTag> subTemplates,
                                           TagValueMap map)
```
  - processSubTemplateStructure
```
protected void processSubTemplateStructure(SubTemplateStructureTag subStructureTag,
                                           TagValueMap map)
```
    Process a single subtemplate structure, i.e. process all subtemplates and inline subtemplates and prepare the next recursive call of this method until all substructures have been processed.
    
    Parameters:
    
    subStructureTag - tag for the sub structure
    
    map - the tag value map
  - processBeanPartInitializer
```
protected void processBeanPartInitializer(java.util.List<Tag> list,
                                          TagValueMap map)
```
    Initializes the bean for the toString() method, i.e. the bean is pre-constructed out of text parts, variable parts, and subtemplate structure parts.
    
    Parameters:
    
    list - the list of tags to be processed
    
    map - map with tag to value mappings
  - computeTextOperatorTagMap
```
protected TagValueMap computeTextOperatorTagMap(TextOperatorTag tag)
```
  - computeTextTagMap
```
protected TagValueMap computeTextTagMap(TextTag tag)
```
    Computes the TagValueMap for TextTags
    
    Parameters:
    
    tag - the TextTag
    
    Returns:
    
    the TagValueMap
  - computeVariableTagMap
```
protected TagValueMap computeVariableTagMap(VariableTag tag)
```
    Computes the pre-compiled toString()-method text for variable tag.
    
    Parameters:
    
    tag - the variable tag
    
    Returns:
    
    the tag value map
  - computeSubTemplateStructureTagMap
```
protected TagValueMap computeSubTemplateStructureTagMap(SubTemplateStructureTag tag)
```
    Computes the pre-compiled toString()-method text for a subtemplate structure tag.
    
    Parameters:
    
    tag - the substructure tag
    
    Returns:
    
    the tag value map
  - writeSource
```
protected void writeSource(java.lang.String filePath,
                           java.lang.String beanText)
```
    Writes the bean text to a file.
    
    Parameters:
    
    filePath - the file
    
    beanText - source code for the bean
  - determineResourceLocation
```
protected com.jiowa.util.tuple.Tuple<java.io.File,java.util.jar.JarFile> determineResourceLocation()
```
    Determines the resource location for the template bean generator configuration.
    
    Returns:
    
    the result as tuple of file or jar file
  - previousTemplateBeansHaveBeenGeneratedBySameProgramVersion
```
protected boolean previousTemplateBeansHaveBeenGeneratedBySameProgramVersion()
```
    Returns true if the already existing template beans have been generated by the same program version and false, otherwise.
    
    Returns:
    
    the result of this check
  - isUpToDate
```
protected boolean isUpToDate()
```
    Checks if anything has to be (re-)generated at all.
    
    Returns:
    
    true if template beans are up to date, false otherwise.
  - createBeanTemplateMapLoader
```
protected TemplateMapLoader createBeanTemplateMapLoader()
```
    Ceates the bean template map loader to load all bean templates for the resource location.
    
    Returns:
    
    the template map loader for all bean templates
  - loadBeanTemplateMap
```
protected TemplateMap loadBeanTemplateMap()
```
    Returns:
    
    the bean template map
  - loadCurrentTemplateMap
```
protected TemplateMap loadCurrentTemplateMap(TemplateDirs2Package dirs2Package)
```
    Loads the template map for the given template directory set.
    
    Parameters:
    
    dirs2Package - template directory set to package name mapping
    
    Returns:
    
    the loaded template map
  - initialize
```
protected void initialize()
```
    Initializes the bean template map.
  - logUniqueErrorMessage
```
protected void logUniqueErrorMessage(java.lang.String msg)
```
    Logs an error message only if it does not have been logged before.
    
    Parameters:
    
    msg - the message

Class JiowaTemplateBeanGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

config

BGT

BEAN_TEMPLATE_FILENAME

BEAN_TEMPLATE_COMPILER_RESULT_CLASSNAME

BEAN_TEMPLATE_COMPILER_RESULT_FILENAME

beanTemplate

compileTimeResultTemplate

beanOutputDirectory

beanOutputDirectoryWithoutPackageName

beanTemplateMap

templateMap

notation

NUMBER_OF_TEMPLATE_NAMES_TO_SHOW_IN_LOG_MESSAGE

resourceLocation

upToDateFlag

messages

checkTemplateSyntaxOnly

CHECK_TEMPLATE_SYNTAX_ONLY_CMD

JAR_FILE_SUFFIX

VERSION_FILE_SUFFIX

COMPILER_RESULT_PACKAGE

Constructor Detail

JiowaTemplateBeanGenerator

Method Detail

generate

checkProtectedRegionsInTemplates

printSummarizingMessages

writeVersionFile

createWarningsString

createErrorsString

createCommentedErrorsString

createMessageString

generateCompileTimeResultClass

determineRunningVersion

generateTemplateBean

processVariableList

processSubTemplateStructureList

createID

processSubTemplateStructure

processSubTemplateStructure

processBeanPartInitializer

computeTextOperatorTagMap

computeTextTagMap

computeVariableTagMap

computeSubTemplateStructureTagMap

writeSource

determineResourceLocation

previousTemplateBeansHaveBeenGeneratedBySameProgramVersion

isUpToDate

createBeanTemplateMapLoader

loadBeanTemplateMap

loadCurrentTemplateMap

initialize

logUniqueErrorMessage