KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jpublish > view > freemarker > FreeMarkerViewContext


1 /*--
2
3  Copyright (C) 2001-2003 Aetrion LLC.
4  All rights reserved.
5  
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions
8  are met:
9  
10  1. Redistributions of source code must retain the above copyright
11     notice, this list of conditions, and the following disclaimer.
12  
13  2. Redistributions in binary form must reproduce the above copyright
14     notice, this list of conditions, and the disclaimer that follows
15     these conditions in the documentation and/or other materials
16     provided with the distribution.
17
18  3. The name "JPublish" must not be used to endorse or promote products
19     derived from this software without prior written permission. For
20     written permission, please contact info@aetrion.com.
21  
22  4. Products derived from this software may not be called "JPublish", nor
23     may "JPublish" appear in their name, without prior written permission
24     from Aetrion LLC (info@aetrion.com).
25  
26  In addition, the authors of this software request (but do not require)
27  that you include in the end-user documentation provided with the
28  redistribution and/or in the software itself an acknowledgement equivalent
29  to the following:
30      "This product includes software developed by
31       Aetrion LLC (http://www.aetrion.com/)."
32
33  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43  POSSIBILITY OF SUCH DAMAGE.
44
45  For more information on JPublish, please see <http://www.jpublish.org/>.
46  
47  */
48
49 package org.jpublish.view.freemarker;
50
51 import freemarker.template.*;
52 import org.jpublish.RequestContext;
53
54 /**
55  * Implementation of a TemplateModel which wraps the RequestContext.
56  *
57  * @author Anthony Eden
58  */
59
60 public class FreeMarkerViewContext implements TemplateHashModelEx {
61
62     private RequestContext context;
63
64     /**
65      * Construct a new FreeMarkerViewContext.
66      *
67      * @param context The wrapped RequestContext
68      */
69
70     public FreeMarkerViewContext(RequestContext context) {
71         this.context = context;
72     }
73
74     /**
75      * Get the number of elements in the context.
76      *
77      * @return The number of elements in the context
78      */
79
80     public int size() {
81         return context.getKeys().length;
82     }
83
84     /**
85      * Return true if the context is empty.
86      *
87      * @return True if the context is empty
88      */
89
90     public boolean isEmpty() {
91         return size() == 0;
92     }
93
94     /**
95      * Return the TemplateModel for the specified key.
96      *
97      * @param key The key
98      * @return The TemplateModel
99      * @throws TemplateModelException
100      */
101
102     public TemplateModel get(String JavaDoc key) throws TemplateModelException {
103         return wrapAsTemplateModel(context.get(key));
104     }
105
106     /**
107      * Return a collection representing all keys in the context.
108      *
109      * @return The collection of keys
110      * @throws TemplateModelException
111      */
112
113     public TemplateCollectionModel keys() throws TemplateModelException {
114         return (TemplateCollectionModel) wrapAsTemplateModel(context.getKeys());
115     }
116
117     /**
118      * Return a collection representing all values in the context.
119      *
120      * @return The collection of values
121      * @throws TemplateModelException
122      */
123
124     public TemplateCollectionModel values() throws TemplateModelException {
125         Object JavaDoc[] arr = context.getKeys();
126         arr = (Object JavaDoc[]) arr.clone();
127         for (int i = 0; i < arr.length; i++) {
128             arr[i] = context.get(arr[i].toString());
129         }
130         return (TemplateCollectionModel) wrapAsTemplateModel(arr);
131     }
132
133     /**
134      * Wrap the specified object in a TemplateModel implementation.
135      *
136      * @param obj The object
137      * @return The TemplateModel wrapper
138      * @throws TemplateModelException
139      */
140
141     private TemplateModel wrapAsTemplateModel(Object JavaDoc obj) throws TemplateModelException {
142         return ObjectWrapper.BEANS_WRAPPER.wrap(obj);
143     }
144
145 }
146
Popular Tags