KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > openccm > pss > generator > hibernate > api > HibernateXmlGenerator


1 /*====================================================================
2
3 OpenCCM: The Open CORBA Component Model Platform
4 Copyright (C) 2000-2004 INRIA & USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Alex Andrushchak.
23 Contributor(s): Christophe Demarey.
24
25 ====================================================================*/

26
27 package org.objectweb.openccm.pss.generator.hibernate.api;
28
29 // Package dependencies
30
import java.util.List JavaDoc;
31 import org.objectweb.openccm.generator.common.lib.GenerationException;
32
33 /**
34  * This interface allows you to generate hibernate mapping xml files.
35  *
36  * @author <a HREF="mailto:pretend@ukr.net">Alex Andrushchak</a>
37  * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
38  */

39
40 public interface HibernateXmlGenerator
41     extends org.objectweb.openccm.generator.common.api.Generator
42 {
43     /**
44      * Initialize the generator.
45      *
46      * @param app_name - The application's name.
47      **/

48     public void
49     initialize(String JavaDoc app_name);
50
51     /**
52      * Map a storage type to a hibernate persistent classe in the xml file.
53      *
54      * @param st - The storage type to map.
55      **/

56     public void
57     mapStorageType(org.objectweb.openccm.ast.api.StorageTypeDecl st);
58
59     /**
60      * Generate Hibernate mapping xml files.
61      *
62      * @param base_dir - The base directory where files will be generated.
63      * @param storage_types - Storage Types to include in Hibernate mapping xml files.
64      **/

65     public void
66     to_hibernate_xml(String JavaDoc base_dir,
67                      List JavaDoc storage_types,
68                      String JavaDoc user_properties_file)
69     throws GenerationException;
70 }
Popular Tags