1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 William Chesters
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 * William Chesters <williamc At paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.template;
47
48
49 import org.melati.poem.FieldAttributes;
50
51 /**
52 * An object which can load a templet given a {@link TemplateEngine},
53 * a {@link MarkupLanguage} and a means of identifying the templet.
54 */
55 public interface TempletLoader {
56
57 /**
58 * Return a templet by name.
59 * @param templateEngine the TemplateEngine in use
60 * @param markupLanguage the markuplanguage the templet is in
61 * @param templetName the name of the templet
62 * @return the templet
63 * @throws NotFoundException if template not found
64 */
65 Template templet(TemplateEngine templateEngine,
66 MarkupLanguage markupLanguage,
67 String templetName)
68 throws NotFoundException;
69
70 /**
71 * Return a templet by name and purpose.
72 *
73 * @param templateEngine the TemplateEngine in use
74 * @param markupLanguage the markuplanguage the templet is in
75 * @param purpose what the templet is for eg error
76 * @param templetName the name of the templet
77 * @return the templet
78 * @throws NotFoundException if template not found
79 */
80 Template templet(TemplateEngine templateEngine,
81 MarkupLanguage markupLanguage,
82 String purpose, String templetName)
83 throws NotFoundException;
84
85 /**
86 * Return a templet for a given class, looking for a template
87 * with the same name as the class in the Melati templet directory; giving a full template path as:
88 * <code>org/melati/template/TEMPLATE_ENGINE_NAME/MARKUP_LANGUAGE/java.lang.Object.wm</code>
89 * which is the lowest possible template and is always found.
90 *
91 * The template is also looked for in the resource directory for that class.
92 *
93 * The search results are cached, so that searches are not repeated.
94 *
95 * @param templateEngine the TemplateEngine in use
96 * @param markupLanguage the markuplanguage the templet is in
97 * @param clazz the class name to translate into a template name
98 * @return the templet
99 */
100
101 Template templet(TemplateEngine templateEngine,
102 MarkupLanguage markupLanguage,
103 Class<?> clazz);
104
105 /**
106 * Return a templet by Class and Purpose.
107 *
108 * The purpose search path is the normal search path with the
109 * purpose appended, separated by a "/".
110 *
111 * If there is no template found then the normal search path is
112 * searched.
113 *
114 * The purpose is then re-appended to the supperclasses searchpath
115 * and so on up the tree, stopping at Object, which is always found.
116 *
117 * @param templateEngine the TemplateEngine in use
118 * @param markupLanguage the markuplanguage the templet is in
119 * @param purpose what the templet is for eg error
120 * @param clazz Class that templet renders
121 * @return the templet
122 */
123 Template templet(TemplateEngine templateEngine,
124 MarkupLanguage markupLanguage,
125 String purpose, Class<?> clazz);
126
127 /**
128 * Return a templet to render a Field.
129 *
130 * @param templateEngine the TemplateEngine in use
131 * @param markupLanguage the markuplanguage the templet is in
132 * @param attributes a FieldAttributes the templet is for eg a Field
133 * @return the templet
134 */
135 Template templet(TemplateEngine templateEngine,
136 MarkupLanguage markupLanguage,
137 FieldAttributes<?> attributes);
138 }