JdoXmlGenerator


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): Christophe Demarey.
23  Contributor(s): ______________________________________.
24  
25  ====================================================================*/
26  
27  package org.objectweb.openccm.pss.generator.jdo.api;
28  
29  // Package dependencies
30  import org.objectweb.openccm.ast.api.StorageTypeDecl;
31  import org.objectweb.openccm.generator.common.lib.GenerationException;
32  import java.util.List  ;
33  
34  /**
35   * This interface allows you to generate xml JDO files for storage types.
36   *
37   * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
38   * 
39   * @version 0.1
40   */
41  
42  public interface JdoXmlGenerator
43           extends org.objectweb.openccm.generator.common.api.Generator
44  {
45      /**
46       * Initialize the generator.
47       *
48       * @param app_name - The application's name.
49       **/
50      public void
51      initialize( String   app_name );
52  
53      /**
54       * Map a storage type to a JDO persistent capable classe in the xml file.
55       *
56       * @param st - The storage type to map.
57       **/
58      public void
59      mapStorageType( StorageTypeDecl st );
60  
61      /**
62       * Generate xml JDO files.
63       *
64       * @param base_dir - The base directory where files will be generated.
65       * @param storage_types - Storage Types to include in xml JDO files.
66       * @param user_properties_file - The name of user jdo properties file.
67       **/
68      public void
69      to_jdo_xml(String   base_dir,
70                 List   storage_types,
71                 String   user_properties_file)
72      throws GenerationException;
73  }
74
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags