View Javadoc
1   /*
2    * $Source$
3    * $Revision$
4    *
5    * Copyright (C) 2008 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   */
43  package org.melati.template.velocity;
44  
45  
46  import java.util.Map;
47  
48  import org.apache.velocity.app.event.EventCartridge;
49  import org.melati.template.TemplateContext;
50  
51  /**
52   * @author timp
53   * @since  14 Apr 2008
54   *
55   */
56  public class VelocityTemplateContext implements TemplateContext {
57  
58    /** The velocity context. */
59    public org.apache.velocity.VelocityContext velocityContext;
60  
61    /**
62     * Constructor.
63     * @param vc context
64     */
65    public VelocityTemplateContext(org.apache.velocity.VelocityContext vc) {    
66      velocityContext = vc;
67      setPropagateExceptionHandling();
68    }    
69  
70    /**
71     * {@inheritDoc}
72     * @see org.melati.template.TemplateContext#put(java.lang.String, java.lang.Object)
73     */
74    public Object put(String s, Object o) {    
75      return velocityContext.put(s,o);    
76    }
77  
78    /**
79     * {@inheritDoc}
80     * @see org.melati.template.TemplateContext#get(java.lang.String)
81     */
82    public Object get(String s) {    
83      return velocityContext.get(s);    
84    }
85  
86    /**
87     * {@inheritDoc}
88     * @see org.melati.template.TemplateContext#getContext()
89     */
90    public Object getContext() {    
91      return velocityContext;    
92    }
93  
94    /**
95     * {@inheritDoc}
96     * @see org.melati.template.TemplateContext#setPassbackExceptionHandling()
97     */
98    public void setPassbackExceptionHandling() {
99      EventCartridge ec = velocityContext.getEventCartridge();    
100     if (ec == null) {    
101       ec = new EventCartridge();    
102       velocityContext.attachEventCartridge(ec);    
103     }    
104     ec.addEventHandler(new PassbackEvaluationExceptionHandler(velocityContext));        
105   }
106 
107   /**
108    * {@inheritDoc}
109    * @see org.melati.template.TemplateContext#setPropagateExceptionHandling()
110    */
111   public void setPropagateExceptionHandling() {
112     EventCartridge ec = velocityContext.getEventCartridge();    
113     if (ec == null) {    
114       ec = new EventCartridge();    
115       velocityContext.attachEventCartridge(ec);    
116     }    
117     ec.addEventHandler(new PropagateEvaluationExceptionHandler());        
118   }
119 
120   @Override
121   public void putAll(Map<String, ?> m) {
122     for (String k : m.keySet()) { 
123       velocityContext.put(k,m.get(k));
124     }
125   }
126 }