org.objectweb.speedo.generation.generator.home
Class HomeGenerator

java.lang.Object
  org.objectweb.speedo.generation.lib.AbstractGeneratorComponent
      org.objectweb.speedo.generation.generator.lib.AbstractVelocityGenerator
          org.objectweb.speedo.generation.generator.lib.SpeedoGenerator
              org.objectweb.speedo.generation.generator.home.HomeGenerator

All Implemented Interfaces:

GeneratorComponent, SupportedGenClass, VelocityGenerator

public class HomeGenerator

extends SpeedoGenerator

Author:

S.Chassande-Barrioz

Nested Class Summary

Nested classes inherited from class org.objectweb.speedo.generation.generator.lib.SpeedoGenerator

SpeedoGenerator.FetchGroup, SpeedoGenerator.Field

Field Summary

static java.lang.String	LOGGER_NAME
static java.lang.String	TEMPLATE_NAME

Fields inherited from class org.objectweb.speedo.generation.generator.lib.SpeedoGenerator

jormTools, PRIMITIVE_TYPES

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, scp

Fields inherited from interface org.objectweb.speedo.genclass.SupportedGenClass

GC_IMPL, GC_IMPL_PREFIX

Constructor Summary

HomeGenerator()

Method Summary

void	generate(SpeedoClass sClass, java.lang.String fileName) This method generates the a file since a SpeedoClass meta object.
protected org.apache.velocity.context.Context	getContext(SpeedoClass jdoClass) This method initialises the Velocity context.
boolean	init()

Methods inherited from class org.objectweb.speedo.generation.generator.lib.SpeedoGenerator

computeUserCaches, computeUserCaches, fillFetchGroupInfo, fillFieldInfo, fillFieldInfo4FetchGroup, fillReferenceInfo, fillRelationInfo, fillUserFieldMappingInfo, getClassNameDef, getCollectionClass, getJavaLangType, getMapping, getPNameGetter, getValueGetter

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, 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, 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

Constructor Detail

HomeGenerator

public HomeGenerator()

Method Detail

init

public boolean init()
             throws SpeedoException

Specified by:

init in interface GeneratorComponent

Specified by:

init in class AbstractVelocityGenerator

Throws:

SpeedoException

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

getContext

protected org.apache.velocity.context.Context getContext(SpeedoClass jdoClass)
                                                  throws SpeedoException

This method initialises the Velocity context.

Overrides:

getContext in class SpeedoGenerator

Parameters:

jdoClass - : the jdoClass which represents the class to generate.

Returns:

a Velocity context.

Throws:

SpeedoException