org.objectweb.speedo.generation.generator.objectid
Class ObjectIdGenerator

java.lang.Object
  extended by org.objectweb.speedo.generation.lib.AbstractGeneratorComponent
      extended by org.objectweb.speedo.generation.generator.lib.AbstractVelocityGenerator
          extended by org.objectweb.speedo.generation.generator.objectid.ObjectIdGenerator
All Implemented Interfaces:
GeneratorComponent, VelocityGenerator

public class ObjectIdGenerator
extends AbstractVelocityGenerator

Author:
S.Chassande-Barrioz

Nested Class Summary
 class ObjectIdGenerator.Field
           
 
Field Summary
static java.lang.String LOGGER_NAME
           
static java.lang.String OBJECTID_SUFFIX
           
static java.lang.String TEMPLATE_NAME
           
 
Fields inherited from class org.objectweb.speedo.generation.generator.lib.AbstractVelocityGenerator
fs, template, TEMPLATE_DIR, ve
 
Fields inherited from class org.objectweb.speedo.generation.lib.AbstractGeneratorComponent
debug, logger, personality, scp
 
Constructor Summary
ObjectIdGenerator(Personality p)
           
 
Method Summary
 void generate(SpeedoClass sClass, java.lang.String fileName)
          This method generates the a file since a SpeedoClass meta object.
 boolean init()
          Initializes the component
 
Methods inherited from class org.objectweb.speedo.generation.generator.lib.AbstractVelocityGenerator
computeTemplate, getExternalsTemplate, getVelocityEngine, isClassicalType, isContainerIdField, process, setVelocityEngine
 
Methods inherited from class org.objectweb.speedo.generation.lib.AbstractGeneratorComponent
getLogger, getSpeedoCompilerParameter, getSummary, getTitle, setLogger, setSpeedoCompilerParameter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.objectweb.speedo.generation.api.GeneratorComponent
getSpeedoCompilerParameter, getSummary, getTitle, setSpeedoCompilerParameter
 

Field Detail

LOGGER_NAME

public static final java.lang.String LOGGER_NAME
See Also:
Constant Field Values

TEMPLATE_NAME

public static final java.lang.String TEMPLATE_NAME
See Also:
Constant Field Values

OBJECTID_SUFFIX

public static final java.lang.String OBJECTID_SUFFIX
See Also:
Constant Field Values
Constructor Detail

ObjectIdGenerator

public ObjectIdGenerator(Personality p)
Method Detail

init

public boolean init()
             throws SpeedoException
Description copied from interface: GeneratorComponent
Initializes the component

Specified by:
init in interface GeneratorComponent
Specified by:
init in class AbstractVelocityGenerator
Returns:
boolean value indicating if the process method can be called.
Throws:
SpeedoException - if the component initialization fails

generate

public void generate(SpeedoClass sClass,
                     java.lang.String fileName)
              throws SpeedoException
This method generates the a file since a SpeedoClass meta object.

Specified by:
generate in interface VelocityGenerator
Specified by:
generate in class AbstractVelocityGenerator
Parameters:
sClass - is the speedo meta object.
fileName - name of the new file.
Throws:
SpeedoGenerationException - If there is a problem during writing the new file.
SpeedoException