01: /**
02: * Speedo: an implementation of JDO compliant personality on top of JORM generic
03: * I/O sub-system.
04: * Copyright (C) 2001-2004 France Telecom R&D
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * version 2 of the License, or (at your option) any later version.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this library; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: *
20: *
21: *
22: * Contact: speedo@objectweb.org
23: *
24: * Authors: S.Chassande-Barrioz.
25: *
26: */package org.objectweb.speedo.generation.generator.api;
27:
28: import org.apache.velocity.app.VelocityEngine;
29: import org.objectweb.speedo.api.SpeedoException;
30: import org.objectweb.speedo.generation.api.GeneratorComponent;
31: import org.objectweb.speedo.metadata.SpeedoClass;
32:
33: import java.util.Collection;
34:
35: /**
36: * This interface represents a component of a generator which generates a file
37: * with the Velocity tool. The use of this interface permits to reuse the
38: * VelocityEngine in order have better generation performance. Indeed the
39: * VelocityEngine initialization is very cheap.
40: *
41: * @author S.Chassande-Barrioz
42: */
43: public interface VelocityGenerator extends GeneratorComponent {
44:
45: /**
46: * It assignes the VelocityEngine instance which must be used during the
47: * veleocity generatioin.
48: * @param ve is the VelocityEngine instance to use.
49: */
50: void setVelocityEngine(VelocityEngine ve);
51:
52: /**
53: * @return the VelocityEngine used during the velocity generation.
54: */
55: VelocityEngine getVelocityEngine();
56:
57: /**
58: * @return a collection of the file names which contains macros. This file
59: * name list will be given to the VelocityEngine during its initialization.
60: */
61: Collection getExternalsTemplate();
62:
63: /**
64: * It generates the file name corresponding to the Speedo meta object given
65: * in parameter.
66: * @param sClass is the speedo meta object which represents a persistent class
67: * @param fileName is the generated file name
68: * @throws SpeedoException
69: */
70: void generate(SpeedoClass sClass, String fileName)
71: throws SpeedoException;
72: }
|