Coverage Report

Coverage Report - org.melati.template.TempletLoader

Classes in this File

 /*
  * $Source: /usr/cvsroot/melati/melati/src/main/java/org/melati/template/TempletLoader.java,v $
  * $Revision: 1.14 $
  *
  * Copyright (C) 2000 William Chesters
  *
  * Part of Melati (http://melati.org), a framework for the rapid
  * development of clean, maintainable web applications.
  *
  * Melati is free software; Permission is granted to copy, distribute
  * and/or modify this software under the terms either:
  *
  * a) the GNU General Public License as published by the Free Software
  *    Foundation; either version 2 of the License, or (at your option)
  *    any later version,
  *
  *    or
  *
  * b) any version of the Melati Software License, as published
  *    at http://melati.org
  *
  * You should have received a copy of the GNU General Public License and
  * the Melati Software License along with this program;
  * if not, write to the Free Software Foundation, Inc.,
  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
  * GNU General Public License and visit http://melati.org to obtain the
  * Melati Software License.
  *
  * Feel free to contact the Developers of Melati (http://melati.org),
  * if you would like to work out a different arrangement than the options
  * outlined here.  It is our intention to allow Melati to be used by as
  * wide an audience as possible.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * Contact details for copyright holder:
  *
  *     William Chesters <williamc At paneris.org>
  *     http://paneris.org/~williamc
  *     Obrechtstraat 114, 2517VX Den Haag, The Netherlands
  */
 
 package org.melati.template;
 
 import java.io.IOException;
 
 import org.melati.poem.FieldAttributes;
 
 /**
  * An object which can load a templet given a {@link TemplateEngine}, 
  * a {@link MarkupLanguage} and a means of identifying the templet.
  */
 public interface TempletLoader {
 
   /**
    * Return a templet by name.
    * @param templateEngine the TemplateEngine in use
    * @param markupLanguage the markuplanguage the templet is in
    * @param templetName the name of the templet
    * @return the templet
    * @throws IOException if TemplateEngine does
    * @throws NotFoundException if template not found
    */
   Template templet(TemplateEngine templateEngine, 
                    MarkupLanguage markupLanguage,
                    String templetName)
       throws IOException, NotFoundException;
 
   /**
    * Return a templet by name and purpose.
    * 
    * @param templateEngine the TemplateEngine in use
    * @param markupLanguage the markuplanguage the templet is in
    * @param purpose what the templet is for eg error
    * @param templetName the name of the templet
    * @return the templet
    * @throws IOException if TemplateEngine does
    * @throws NotFoundException if template not found
    */
   Template templet(TemplateEngine templateEngine, 
                    MarkupLanguage markupLanguage,
                    String purpose, String templetName)
       throws IOException, NotFoundException;
   
   /** 
    * Return a templet for a given class, looking for a template 
    * with the same name as the class in the Melati templet directory; giving a full template path as:  
    * <code>org/melati/template/TEMPLATE_ENGINE_NAME/MARKUP_LANGUAGE/java.lang.Object.wm</code>
    * which is the lowest possible template and is always found. 
    * 
    * The template is also looked for in the resource directory for that class.
    * 
    * The search results are cached, so that searches are not repeated.
    *
    * @param templateEngine the TemplateEngine in use
    * @param markupLanguage the markuplanguage the templet is in
    * @param clazz the class name to translate into a template name 
    * @return the templet
    * @throws IOException if TemplateEngine does
    */
 
   Template templet(TemplateEngine templateEngine, 
                    MarkupLanguage markupLanguage,
                    Class clazz)
       throws IOException;
 
   /**
    * Return a templet by Class and Purpose.
    * 
    * The purpose search path is the normal search path with the 
    * purpose appended, separated by a "/".
    * 
    * If there is no template found then the normal search path is 
    * searched. 
    * 
    * The purpose is then re-appended to the supperclasses searchpath 
    * and so on up the tree, stopping at Object, which is always found.
    *    
    * @param templateEngine the TemplateEngine in use
    * @param markupLanguage the markuplanguage the templet is in
    * @param purpose what the templet is for eg error
    * @param clazz Class that templet renders 
    * @return the templet
    * @throws IOException if TemplateEngine does
    */
   Template templet(TemplateEngine templateEngine, 
                    MarkupLanguage markupLanguage,
                    String purpose, Class clazz)
       throws IOException;
 
   /**
    * Return a templet to render a Field.
    * 
    * @param templateEngine the TemplateEngine in use
    * @param markupLanguage the markuplanguage the templet is in
    * @param attributes a FieldAttributes the templet is for eg a Field
    * @return the templet
    * @throws IOException if TemplateEngine does
    */
   Template templet(TemplateEngine templateEngine, 
                    MarkupLanguage markupLanguage,
                    FieldAttributes attributes)
       throws IOException;
 }

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