KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jpublish > view > ViewRenderer


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;
50
51 import java.io.*;
52
53 import com.anthonyeden.lib.config.Configuration;
54 import com.anthonyeden.lib.config.ConfigurationException;
55 import org.jpublish.RequestContext;
56 import org.jpublish.SiteContext;
57
58 /**
59  * Standard interface for rendering views.
60  *
61  * @author Anthony Eden
62  */
63
64 public interface ViewRenderer {
65
66     /**
67      * Get the SiteContext.
68      *
69      * @return The SiteContext
70      */
71
72     public SiteContext getSiteContext();
73
74     /**
75      * Set the SiteContext.
76      *
77      * @param siteContext The SiteContext
78      */
79
80     public void setSiteContext(SiteContext siteContext);
81
82     /**
83      * Initialize the ViewRenderer.
84      */
85
86     public void init();
87
88     /**
89      * Render the view.
90      *
91      * @param context The RequestContext
92      * @param path The path to the content
93      * @param out The Writer to write the rendered view
94      * @throws IOException
95      * @throws ViewRenderException
96      */
97
98     public void render(RequestContext context, String JavaDoc path, Writer out)
99             throws IOException, ViewRenderException;
100
101     /**
102      * Render the view.
103      *
104      * @param context The RequestContext
105      * @param path The path to the content
106      * @param out The OutputStream to write the rendered view
107      * @throws IOException
108      * @throws ViewRenderException
109      */
110
111     public void render(RequestContext context, String JavaDoc path, OutputStream out)
112             throws IOException, ViewRenderException;
113
114     /**
115      * Render the view.
116      *
117      * @param context The RequestContext
118      * @param path The path to the content
119      * @param in The Reader providing the raw content
120      * @param out The Writer to write the rendered view
121      * @throws IOException
122      * @throws ViewRenderException
123      */
124
125     public void render(RequestContext context, String JavaDoc path, Reader in,
126             Writer out) throws IOException, ViewRenderException;
127
128     /**
129      * Render the view.
130      *
131      * @param context The RequestContext
132      * @param path The path to the content
133      * @param in The InputStream providing the raw content
134      * @param out The OutputStream to write the rendered view
135      * @throws IOException
136      * @throws ViewRenderException
137      */
138
139     public void render(RequestContext context, String JavaDoc path, InputStream in,
140             OutputStream out) throws IOException, ViewRenderException;
141
142     /**
143      * Load the configuration for the view.
144      *
145      * @param configuration The configuration object
146      */
147
148     public void loadConfiguration(Configuration configuration)
149             throws ConfigurationException;
150
151 }
152
Popular Tags