View Javadoc
1   /*
2    * $Source$
3    * $Revision$
4    *
5    * Copyright (C) 2005 Tim Pizey
6    *
7    * Part of Melati (http://melati.org), a framework for the rapid
8    * development of clean, maintainable web applications.
9    *
10   * Melati is free software; Permission is granted to copy, distribute
11   * and/or modify this software under the terms either:
12   *
13   * a) the GNU General Public License as published by the Free Software
14   *    Foundation; either version 2 of the License, or (at your option)
15   *    any later version,
16   *
17   *    or
18   *
19   * b) any version of the Melati Software License, as published
20   *    at http://melati.org
21   *
22   * You should have received a copy of the GNU General Public License and
23   * the Melati Software License along with this program;
24   * if not, write to the Free Software Foundation, Inc.,
25   * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26   * GNU General Public License and visit http://melati.org to obtain the
27   * Melati Software License.
28   *
29   * Feel free to contact the Developers of Melati (http://melati.org),
30   * if you would like to work out a different arrangement than the options
31   * outlined here.  It is our intention to allow Melati to be used by as
32   * wide an audience as possible.
33   *
34   * This program is distributed in the hope that it will be useful,
35   * but WITHOUT ANY WARRANTY; without even the implied warranty of
36   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
37   * GNU General Public License for more details.
38   *
39   * Contact details for copyright holder:
40   *
41   *     Tim Pizey <timp At paneris.org>
42   *     http://paneris.org/~timp
43   */
44  package org.melati.app;
45  
46  import org.melati.Melati;
47  import org.melati.template.TemplateContext;
48  
49  /**
50   * An example of how to use a Template Engine with a Poem database
51   * from the command line.
52   *
53   * Invoke:
54   *
55   * java -cp melati.jar:site\properties:lib\hsqldb.jar: \
56   *  lib\webmacro.jar:lib\servlet.jar \
57   *  org.melati.app.TemplateApp poemtest user 0 \
58   *  org/melati/app/TemplateAppExample
59   *
60   * Where poemtest is your database, user is your table, 0 is the record id and 
61   * org/melati/app/TemplateAppExample is the full name of a template.
62   * 
63   * From within Maven try: 
64   * 
65       &lt;plugin&gt;
66         &lt;groupId&gt;org.codehaus.mojo&lt;/groupId&gt;
67         &lt;artifactId&gt;exec-maven-plugin&lt;/artifactId&gt;
68         &lt;executions&gt;
69           &lt;execution&gt;
70            &lt;id&gt;generate&lt;/id&gt;
71            &lt;phase&gt;test&lt;/phase&gt;
72            &lt;goals&gt;
73             &lt;goal&gt;java&lt;/goal&gt;
74            &lt;/goals&gt;
75            &lt;configuration&gt;
76             &lt;mainClass&gt;org.melati.app.TemplateApp&lt;/mainClass&gt;
77             &lt;arguments&gt;
78               &lt;argument&gt;mydb&lt;/argument&gt;
79               &lt;argument&gt;mytable&lt;/argument&gt;
80               &lt;argument&gt;mytroid&lt;/argument&gt;
81               &lt;argument&gt;mytemplate&lt;/argument&gt;
82               &lt;argument&gt;-output&lt;/argument&gt;
83               &lt;argument&gt;${basedir}/src/main/webapp/WEB-INF/web.xml&lt;/argument&gt;
84             &lt;/arguments&gt;
85             &lt;cleanupDaemonThreads&gt;true&lt;/cleanupDaemonThreads&gt;
86            &lt;/configuration&gt;
87           &lt;/execution&gt;
88         &lt;/executions&gt;
89      &lt;/plugin&gt;
90  
91   * 
92   * 
93   *
94   */
95  public class TemplateApp extends AbstractTemplateApp {
96  
97    /**
98     * The main method to override.
99     *
100    * @param melati A {@link Melati} with arguments and properties set
101    * @param templateContext A {@link TemplateContext} containing a {@link Melati}
102    * @return the name of a template to expand
103    * @throws Exception if anything goes wrong
104    * @see org.melati.app.AbstractTemplateApp#doTemplateRequest
105    *         (org.melati.Melati, org.melati.template.ServletTemplateContext)
106    */
107   protected String doTemplateRequest(Melati melati,
108       TemplateContext templateContext) throws Exception {
109     return melati.getMethod();
110   }
111 
112   /**
113    * The main entry point.
114    *
115    * @param args in format <code>db table troid method</code>
116    *             where method is a template name
117    */
118   public static void main(String[] args) throws Exception {
119     TemplateApp me = new TemplateApp();
120     me.run(args);
121   }
122 }