View Javadoc
1   /*
2    * $Source$
3    * $Revision$
4    *
5    * Copyright (C) 2000 Tim Joyce
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 Joyce <timj At paneris.org>
42   *     http://paneris.org/
43   */
44  
45  package org.melati.template.velocity;
46  
47  import org.melati.util.MelatiBugMelatiException;
48  import org.melati.util.MelatiWriter;
49  import org.melati.template.TemplateContext;
50  import org.melati.template.TemplateEngineException;
51  
52  import org.apache.velocity.VelocityContext;
53  import org.apache.velocity.exception.ParseErrorException;
54  import org.apache.velocity.exception.ResourceNotFoundException;
55  import org.apache.velocity.runtime.RuntimeSingleton;
56  
57  /**
58   * A Velocity Template for use with Melati.
59   */
60  
61  public class VelocityTemplate implements org.melati.template.Template {
62    private org.apache.velocity.Template template;
63  
64    /**
65     * Constructor.
66     * @param templateName name or Template
67     * @throws ParseErrorException if there is a problem paring the template
68     * @throws ResourceNotFoundException if the template is not found
69     */
70    public VelocityTemplate(String templateName) 
71        throws ParseErrorException, ResourceNotFoundException {
72      try {
73        template = RuntimeSingleton.getTemplate(templateName);
74      } catch (ResourceNotFoundException e) {
75        throw e;
76      } catch (ParseErrorException e) {
77        throw e;
78      } catch (Exception e) {
79        throw new MelatiBugMelatiException("Problem getting Velocity template", e);
80      }
81    }
82    
83    /**
84     * {@inheritDoc}
85     * @see org.melati.template.Template#write
86     * (org.melati.util.MelatiWriter, org.melati.template.TemplateContext)
87     */
88    public void write(MelatiWriter out, TemplateContext templateContext) throws TemplateEngineException {
89      try {
90        template.merge((VelocityContext)templateContext.getContext(),out);
91      } catch (Exception e) {
92        throw new TemplateEngineException(e);
93      }
94    }
95  
96  }