TemplateBean

java.lang.Object
- com.jiowa.template.bean.TemplateBean

Direct Known Subclasses:

Argument_jgt, Attribute_jgt, AttributeDeclaration_jgt, AttributeInit_jgt, Class_jgt, Constructor_jgt, FrenchLetter_jgt, FrenchLetter_jgt.Salutation.Mr, FrenchLetter_jgt.Salutation.Mrs, GermanLetter_jgt, GermanLetter_jgt.Salutation.Mr, GermanLetter_jgt.Salutation.Mrs, Getter_jgt, JavaClass_jgt, JavaClass_jgt.foreachAttribute.Argument, JavaClass_jgt.foreachAttribute.Attribute, JavaClass_jgt.foreachAttribute.AttributeInit, JavaClass_jgt.foreachAttribute.Getter, Letter_jgt, Letter_jgt.Salutation.Mr, Letter_jgt.Salutation.Mrs
```
public abstract class TemplateBean
extends java.lang.Object
```
Base class for template beans which carries some base functionality.
All generated template beans are derived from this class.

Author:

Robert Mencl
Copyright (C) 2012-2016 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 TemplateBean`	`parent` the parent template bean for this bean
`protected java.util.List<BeanPart>`	`partList` The parts of which this bean consists of for the toString() method.
`protected SubTemplateStructureID2ClassMap`	`subTemplateStructureID2ClassMap` Stores all ID to class mappings for a given subtemplate structure identifier.
`protected java.util.SortedSet<java.lang.String>`	`subTemplateStructureIdentifiers` The list of all subtemplate structure identifiers
`protected SubTemplateStructureMap`	`subTemplateStructureMap` The map for sub template structure identifier to a list of template beans.
`protected boolean`	`valuePropagationOn` flag for value propagation
`protected VariableMap`	`variableMap` The key-to-value map for variable names and its values.
`protected java.util.SortedSet<java.lang.String>`	`variables` the set of allowed variable names for this bean (determined through the corresponding template).

Constructor Summary

Constructors
Constructor and Description
`TemplateBean()` Default constructor.
`TemplateBean(TemplateBean parentBean)` Template bean with a given parent bean 'rootBean' which is used for value propagation

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TemplateBean`	`append(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier)` Appends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
`TemplateBean`	`append(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier, TemplateBean parentBean)` Appends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
`TemplateBean`	`append(java.lang.String subTemplateStructureIdentifier, TemplateBean bean)` Appends a template bean to the tail of the template bean list for a given subtemplate structure identifier.
`protected java.lang.StringBuffer`	`applyOperator(TextOperatorPart current, java.lang.StringBuffer buf, java.lang.StringBuffer opbuf)` Applies
`TemplateBean`	`clear(java.lang.String subTemplateStructureIdentifier)` Clears the list for a given subtemplate structure identifier.
`protected java.lang.String`	`computeSubTemplateStructurePartText(SubTemplateStructurePart part)` Computes the text for a given sub-template structure part of the template
`protected java.lang.String`	`computeVariablePartText(VariablePart part)` Computes the text for a given variable part of the template
`protected TemplateBean`	`createSubTemplate(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier)` Creates a new sub-template instance for a given subTemplateIdentifer in the specified sub-template structure.
`protected TemplateBean`	`createSubTemplate(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier, TemplateBean parentBean)` Creates a new sub-template instance for a given subTemplateIdentifer in the specified sub-template structure.
`java.lang.String`	`get(java.lang.String variableName)` Returns the value for a given variable name.
`TemplateBeanList`	`getAll(java.lang.String subTemplateStructureIdentifier)` Returns all elements which have been stored for this sub template structure identifier.
`abstract java.lang.String`	`id()` Returns the id of this template bean
`protected ID2ClassMap`	`id2ClassMap(java.lang.String subTemplateStructureIdentifier)` Returns the template ID to class mapping.
`boolean`	`isValuePropagationOn()` Returns true if value propagation is switched on and false, otherwise.
`protected void`	`logAllVariablesWithNullValuesAsErrors()` Logs all variables with null values as errors.
`TemplateBean`	`parent()` Returns the parent bean of this template bean
`TemplateBean`	`prepend(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier)` Prepends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
`TemplateBean`	`prepend(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier, TemplateBean parentBean)` Prepends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
`TemplateBean`	`prepend(java.lang.String subTemplateStructureIdentifier, TemplateBean bean)` Prepends a template bean to the beginning of the template bean list for a given subtemplate structure identifier.
`protected void`	`putID2ClassMap(java.lang.String subTemplateStructureIdentifier, ID2ClassMap map)` Sets the ID class map for a given subtemplate structure identifier.
`TemplateBean`	`set(java.lang.String variableName, java.lang.String value)` Sets the value for a given variable name.
`TemplateBean`	`setAll(java.lang.String subTemplateStructureIdentifier, TemplateBeanList beanList)` Sets the template bean for a given subtemplate structure.
`TemplateBean`	`setSubTemplate(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier)` Sets a subtemplate in generic way.
`TemplateBean`	`setSubTemplate(java.lang.String subTemplateStructureIdentifier, java.lang.String subTemplateIdentifier, TemplateBean parentBean)` Sets a subtemplate in generic way.
`void`	`setValuePropagation(boolean value)` Sets the value propagation to the given boolean value.
`protected TemplateBeanList`	`subTemplateParentList(TemplateBean parentBean, java.lang.String subTemplateStructureIdentifier)` Delivers the appropriate `TemplateBeanList` for the given sub template structure identifier for all possible parents.
`protected TemplateBeanList`	`subTemplates(java.lang.String subTemplateStructureIdentifier)` Returns the list of template beans for a given sub-template structure identifier.
`protected SubTemplateStructureMap`	`subTemplateStructureMap()` Returns the sub-template structure map of this template bean.
`java.lang.String`	`toString()` Creates the text representation of the template bean with all inserted values.
`void`	`turnValuePropagationOff()` Turns value propagation off
`void`	`turnValuePropagationOn()` Turns value propagation on.
`protected TemplateBeanList`	`typeConvertedSubTemplates(TemplateBeanList list, java.lang.String subTemplateStructureIdentifier)` Converts the types a list of template beans to those which are expected for the given sub template structure identifier.
`protected VariableMap`	`variableMap()` Returns the map with variable values for this template bean.
`protected java.lang.String`	`variableValue(java.lang.String variableName)` Returns the variable value for a given variable name.

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

- Field Detail
  - parent
```
protected TemplateBean parent
```
    the parent template bean for this bean
  - valuePropagationOn
```
protected boolean valuePropagationOn
```
    flag for value propagation
  - variableMap
```
protected VariableMap variableMap
```
    The key-to-value map for variable names and its values.
  - variables
```
protected java.util.SortedSet<java.lang.String> variables
```
    the set of allowed variable names for this bean (determined through the corresponding template).
  - subTemplateStructureMap
```
protected SubTemplateStructureMap subTemplateStructureMap
```
    The map for sub template structure identifier to a list of template beans.
  - subTemplateStructureID2ClassMap
```
protected SubTemplateStructureID2ClassMap subTemplateStructureID2ClassMap
```
    Stores all ID to class mappings for a given subtemplate structure identifier. Needed for subtemplate value propagation.
  - subTemplateStructureIdentifiers
```
protected java.util.SortedSet<java.lang.String> subTemplateStructureIdentifiers
```
    The list of all subtemplate structure identifiers
  - partList
```
protected java.util.List<BeanPart> partList
```
    The parts of which this bean consists of for the toString() method. Usually filled only by the super classes.
- Constructor Detail
  - TemplateBean
```
public TemplateBean()
```
    Default constructor.
  - TemplateBean
```
public TemplateBean(TemplateBean parentBean)
```
    Template bean with a given parent bean 'rootBean' which is used for value propagation
    
    Parameters:
    
    parentBean - parent bean
- Method Detail
  - id
```
public abstract java.lang.String id()
```
    Returns the id of this template bean
    
    Returns:
    
    template id
  - parent
```
public TemplateBean parent()
```
    Returns the parent bean of this template bean
    
    Returns:
    
    parent bean
  - get
```
public java.lang.String get(java.lang.String variableName)
```
    Returns the value for a given variable name.
    
    Parameters:
    
    variableName - variable name string
    
    Returns:
    
    the variable value
  - set
```
public TemplateBean set(java.lang.String variableName,
                        java.lang.String value)
```
    Sets the value for a given variable name.
    
    Parameters:
    
    variableName - variable name
    
    value - value for variable
    
    Returns:
    
    the reference to this (modified) template bean
  - setSubTemplate
```
public TemplateBean setSubTemplate(java.lang.String subTemplateStructureIdentifier,
                                   java.lang.String subTemplateIdentifier)
```
    Sets a subtemplate in generic way. It creates in instance of a template bean for the given subtemplate identifier via reflection.
    
    Parameters:
    
    subTemplateStructureIdentifier - identifier for the subtemplate structure
    
    subTemplateIdentifier - identifier for the subtemplate (i.e. the name of the inline subtemplate or the filename of the external subtemplate)
    
    Returns:
    
    the reference to the created subtemplate
  - setSubTemplate
```
public TemplateBean setSubTemplate(java.lang.String subTemplateStructureIdentifier,
                                   java.lang.String subTemplateIdentifier,
                                   TemplateBean parentBean)
```
    Sets a subtemplate in generic way. It creates in instance of a template bean for the given subtemplate identifier via reflection.
    
    Parameters:
    
    subTemplateStructureIdentifier - identifier for the subtemplate structure
    
    subTemplateIdentifier - identifier for the subtemplate (i.e. the name of the inline subtemplate or the filename of the external subtemplate)
    
    parentBean - the parent bean reference
    
    Returns:
    
    the reference to the created subtemplate
  - getAll
```
public TemplateBeanList getAll(java.lang.String subTemplateStructureIdentifier)
```
    Returns all elements which have been stored for this sub template structure identifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - identifier
    
    Returns:
    
    list of template beans
  - setAll
```
public TemplateBean setAll(java.lang.String subTemplateStructureIdentifier,
                           TemplateBeanList beanList)
```
    Sets the template bean for a given subtemplate structure.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier of the subtemplate structure
    
    beanList - the list of template beans
    
    Returns:
    
    the reference to this modified template bean.
  - clear
```
public TemplateBean clear(java.lang.String subTemplateStructureIdentifier)
```
    Clears the list for a given subtemplate structure identifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier for a subtemplate structure
    
    Returns:
    
    the reference to this modified template bean.
  - prepend
```
public TemplateBean prepend(java.lang.String subTemplateStructureIdentifier,
                            TemplateBean bean)
```
    Prepends a template bean to the beginning of the template bean list for a given subtemplate structure identifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the given identifier
    
    bean - the template bean
    
    Returns:
    
    the reference to the modified template bean
  - prepend
```
public TemplateBean prepend(java.lang.String subTemplateStructureIdentifier,
                            java.lang.String subTemplateIdentifier)
```
    Prepends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier for the sub-template structure
    
    subTemplateIdentifier - the identifier for sub-template for which the corresponding class is created.
    
    Returns:
    
    template bean
  - prepend
```
public TemplateBean prepend(java.lang.String subTemplateStructureIdentifier,
                            java.lang.String subTemplateIdentifier,
                            TemplateBean parentBean)
```
    Prepends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier for the sub-template structure
    
    subTemplateIdentifier - the identifier for sub-template for which the corresponding class is created.
    
    parentBean - the reference to parent bean
    
    Returns:
    
    template bean
  - append
```
public TemplateBean append(java.lang.String subTemplateStructureIdentifier,
                           TemplateBean bean)
```
    Appends a template bean to the tail of the template bean list for a given subtemplate structure identifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the given identifier
    
    bean - the template bean
    
    Returns:
    
    the reference to the modified template bean
  - append
```
public TemplateBean append(java.lang.String subTemplateStructureIdentifier,
                           java.lang.String subTemplateIdentifier)
```
    Appends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier for the sub-template structure
    
    subTemplateIdentifier - the identifier for sub-template for which the corresponding class is created.
    
    Returns:
  - append
```
public TemplateBean append(java.lang.String subTemplateStructureIdentifier,
                           java.lang.String subTemplateIdentifier,
                           TemplateBean parentBean)
```
    Appends a new template bean instance for the given subTemplateIdentifier to the list of template beans for the subTemplateStructureIdentifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier for the sub-template structure
    
    subTemplateIdentifier - the identifier for sub-template for which the corresponding class is created.
    
    parentBean - reference to parent bean
    
    Returns:
    
    this template bean
  - isValuePropagationOn
```
public boolean isValuePropagationOn()
```
    Returns true if value propagation is switched on and false, otherwise.
    
    Returns:
    
    boolean value for value propagation status
  - setValuePropagation
```
public void setValuePropagation(boolean value)
```
    Sets the value propagation to the given boolean value.
    
    Parameters:
    
    value - true/false for value propagation status.
  - turnValuePropagationOn
```
public void turnValuePropagationOn()
```
    Turns value propagation on.
  - turnValuePropagationOff
```
public void turnValuePropagationOff()
```
    Turns value propagation off
  - toString
```
public java.lang.String toString()
```
    Creates the text representation of the template bean with all inserted values.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the text which represents the template bean after inserting all variable values and subtemplates
  - variableValue
```
protected java.lang.String variableValue(java.lang.String variableName)
```
    Returns the variable value for a given variable name.
    
    Parameters:
    
    variableName - variable name
    
    Returns:
    
    variable value
  - subTemplateParentList
```
protected TemplateBeanList subTemplateParentList(TemplateBean parentBean,
                                                 java.lang.String subTemplateStructureIdentifier)
```
    Delivers the appropriate TemplateBeanList for the given sub template structure identifier for all possible parents.
    
    Parameters:
    
    parentBean - parent tempalte bean
    
    subTemplateStructureIdentifier - identifier
    
    Returns:
    
    template bean list
  - typeConvertedSubTemplates
```
protected TemplateBeanList typeConvertedSubTemplates(TemplateBeanList list,
                                                     java.lang.String subTemplateStructureIdentifier)
```
    Converts the types a list of template beans to those which are expected for the given sub template structure identifier.
    
    Parameters:
    
    list - the list of template beans
    
    subTemplateStructureIdentifier - the identifier for the sub template structure
    
    Returns:
    
    the template bean list with correct target sub template types
  - subTemplates
```
protected TemplateBeanList subTemplates(java.lang.String subTemplateStructureIdentifier)
```
    Returns the list of template beans for a given sub-template structure identifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - sub structure identifier
    
    Returns:
    
    list of template beans for given identifier
  - variableMap
```
protected VariableMap variableMap()
```
    Returns the map with variable values for this template bean.
    
    Returns:
    
    variable map
  - subTemplateStructureMap
```
protected SubTemplateStructureMap subTemplateStructureMap()
```
    Returns the sub-template structure map of this template bean.
    
    Returns:
    
    the sub-template structure map
  - createSubTemplate
```
protected TemplateBean createSubTemplate(java.lang.String subTemplateStructureIdentifier,
                                         java.lang.String subTemplateIdentifier,
                                         TemplateBean parentBean)
```
    Creates a new sub-template instance for a given subTemplateIdentifer in the specified sub-template structure.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier of the sub-template structure
    
    subTemplateIdentifier - the identifier for the subtemplate
    
    parentBean - the reference to the parent bean
    
    Returns:
    
    the new template bean instance
  - createSubTemplate
```
protected TemplateBean createSubTemplate(java.lang.String subTemplateStructureIdentifier,
                                         java.lang.String subTemplateIdentifier)
```
    Creates a new sub-template instance for a given subTemplateIdentifer in the specified sub-template structure.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier of the sub-template structure
    
    subTemplateIdentifier - the identifier for the subtemplate
    
    Returns:
    
    the new template bean instance
  - id2ClassMap
```
protected ID2ClassMap id2ClassMap(java.lang.String subTemplateStructureIdentifier)
```
    Returns the template ID to class mapping. This ensures that subtemplate value propagation works even for obfuscated template beans.
    
    Parameters:
    
    sub - template structure identifier
    
    Returns:
    
    ID to template bean class map
  - putID2ClassMap
```
protected void putID2ClassMap(java.lang.String subTemplateStructureIdentifier,
                              ID2ClassMap map)
```
    Sets the ID class map for a given subtemplate structure identifier.
    
    Parameters:
    
    subTemplateStructureIdentifier - the identifier for the substructure
    
    map - ID to template bean class map
  - applyOperator
```
protected java.lang.StringBuffer applyOperator(TextOperatorPart current,
                                               java.lang.StringBuffer buf,
                                               java.lang.StringBuffer opbuf)
```
    Applies
    
    Parameters:
    
    current - TextOperatorPart
    
    buf - text to be operated on
    
    opbuf - operator string buffer
    
    Returns:
    
    string after the text operator has been applied
  - computeVariablePartText
```
protected java.lang.String computeVariablePartText(VariablePart part)
```
    Computes the text for a given variable part of the template
    
    Parameters:
    
    part - the variable part
    
    Returns:
    
    text representation of this variable part
  - computeSubTemplateStructurePartText
```
protected java.lang.String computeSubTemplateStructurePartText(SubTemplateStructurePart part)
```
    Computes the text for a given sub-template structure part of the template
    
    Parameters:
    
    part - the variable part
    
    Returns:
    
    text representation of this sub-template structure part
  - logAllVariablesWithNullValuesAsErrors
```
protected void logAllVariablesWithNullValuesAsErrors()
```
    Logs all variables with null values as errors.

Class TemplateBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parent

valuePropagationOn

variableMap

variables

subTemplateStructureMap

subTemplateStructureID2ClassMap

subTemplateStructureIdentifiers

partList

Constructor Detail

TemplateBean

TemplateBean

Method Detail

id

parent

get

set

setSubTemplate

setSubTemplate

getAll

setAll

clear

prepend

prepend

prepend

append

append

append

isValuePropagationOn

setValuePropagation

turnValuePropagationOn

turnValuePropagationOff

toString

variableValue

subTemplateParentList

typeConvertedSubTemplates

subTemplates

variableMap

subTemplateStructureMap

createSubTemplate

createSubTemplate

id2ClassMap

putID2ClassMap

applyOperator

computeVariablePartText

computeSubTemplateStructurePartText

logAllVariablesWithNullValuesAsErrors