org.objectweb.speedo.generation.api
Interface GeneratorComponent

All Known Subinterfaces:
VelocityGenerator
All Known Implementing Classes:
AbstractEnhancer, AbstractEnhancerComponent, AbstractGenerator, AbstractGeneratorComponent, AbstractMetaInfoVisitor, AbstractParser, AbstractSpeedoGenerator, AbstractVelocityGenerator, CascadeDeleteSetter, Compiler, DataStoreId, DiscriminatorVisitor, EJBAnnotationParser, EJBDescParser, EJBEnhancer, EJBGenerator, EJBHomeGenerator, EJBPersistenceParser, EJBSMIVisitor, ExtensionVerifier, FieldConverterVisitor, FieldsGenerator, HomeGenerator, IndexVisitor, InheritanceVisitor, JavaLangShorcutVisitor, JDO2Parser, JDOEnhancer, JDOGenerator, JDOHomeGenerator, JDOParser, JDOPersistentClassEnhancer, JDOSMIVisitor, JMICleanerVisitor, JormGenerator, JormMIGenerator, KeyFieldChecker, MappingExtension2Jdo, MetaDataAnalyzer, MetaInfoVisitorImpl, MetaInfoVisitors, MISerializer, ObjectIdGenerator, ORMappingGenerator, PersistenceAwareEnhancer, PersistentClassEnhancer, PrimaryKeyFieldAdder, Recompiler, ReverseFieldAdder, TupleExtensionCopier, UpToDateVisitor, VersionFieldAdder

public interface GeneratorComponent

Defines a component of the Speedo generator.

Author:
S.Chassande-Barrioz

Method Summary
 SpeedoCompilerParameter getSpeedoCompilerParameter()
          Retrieves the parameters holder
 java.lang.String getSummary()
           
 java.lang.String getTitle()
           
 boolean init()
          Initializes the component
 void process()
          Do the job of the component.
 void setSpeedoCompilerParameter(SpeedoCompilerParameter scp)
          Assignes the parameters holder
 

Method Detail

setSpeedoCompilerParameter

void setSpeedoCompilerParameter(SpeedoCompilerParameter scp)
Assignes the parameters holder


getSpeedoCompilerParameter

SpeedoCompilerParameter getSpeedoCompilerParameter()
Retrieves the parameters holder


init

boolean init()
             throws SpeedoException
Initializes the component

Returns:
boolean value indicating if the process method can be called.
Throws:
SpeedoException - if the component initialization fails

process

void process()
             throws SpeedoException
Do the job of the component.

Throws:
SpeedoException - if the component initialization fails

getTitle

java.lang.String getTitle()
Returns:
a short string (less than 30 characters) representing the title of the component. This string must indicate job of the component.

getSummary

java.lang.String getSummary()
Returns:
a short string (less than 50 characters) summarizing the job of component (ex: how many files generated or compiled, ...)