PSDLtoJavaCommand


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.common.api;
28  
29  // Package dependencies
30  import org.objectweb.openccm.ast.api.FileScope;
31  
32  
33  /**
34   * Interface of the psdl_java command.
35   *
36   * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
37   *
38   * @version 0.1
39   */
40  
41  public interface PSDLtoJavaCommand
42           extends org.objectweb.openccm.command.api.Compiler,
43                   org.objectweb.openccm.command.api.Generator
44  {
45      /**
46       * Obtains the output directory.
47       *
48       * @result The output directory.
49       */
50      public String  
51      getOutputDirectory();
52  
53      /**
54       * Obtains the user properties file name.
55       *
56       * @result The user properties file name.
57       */
58      public String  
59      getUserPropertiesFile();
60  
61      /**
62       * Obtains the persistent framework choosen.
63       *
64       * @result The persistent framework choosen.
65       */
66      public String  
67      getBackend();
68  
69      /**
70       * Generates PSDL Mapping from an AST FileScope instance.
71       *
72       * Note that checkComponentRepository() and initAST() methods
73       * must be called before.
74       *
75       * @param filescope The source AST FileScope returned by the compile() method.
76       * @param inputfile - The source file.
77       * @param base_dir - The base directory for java mapping.
78       * @param user_properties_file - The user jdo properties file.
79       * @param backend - The target persistent framework.
80       *
81       * @return True if ok, else false.
82       */
83      public boolean
84      generate_java_mapping(FileScope filescope,
85                            String   inputfile,
86                            String   base_dir,
87                            String   user_properties_file,
88                            String   backend);
89  }
90
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags