View Javadoc
1 package org.apache.turbine.modules.pages; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 // Turbine Classes 58 import org.apache.turbine.services.template.TurbineTemplate; 59 import org.apache.turbine.util.RunData; 60 61 62 /*** 63 * When building sites using templates, Screens need only be defined 64 * for templates which require dynamic (database or object) data. 65 * 66 * <p> 67 * 68 * This page can be used on sites where the number of Screens can be 69 * much less than the number of templates. The templates can be 70 * grouped in directories with common layouts. Screen modules are 71 * then expected to be placed in packages corresponding with the 72 * templates' directories and follow a specific naming scheme. 73 * 74 * <p> 75 * 76 * The template parameter is parsed and and a Screen whose package 77 * matches the templates path and shares the same name minus any 78 * extension and beginning with a capital letter is searched for. If 79 * not found, a Screen in a package matching the template's path with 80 * name Default is searched for. If still not found, a Screen with 81 * name Default is looked for in packages corresponding to parent 82 * directories in the template's path until a match is found. 83 * 84 * <p> 85 * 86 * For example if data.getParameters().getString("template") returns 87 * /about_us/directions/driving.wm, the search follows 88 * about_us.directions.Driving, about_us.directions.Default, 89 * about_us.Default, Default, WebMacroSiteScreen (i.e. the default 90 * screen set in TurbineResources). 91 * 92 * <p> 93 * 94 * Only one Layout module is used, since it is expected that any 95 * dynamic content will be placed in navigations and screens. The 96 * layout template to be used is found in a similar way to the Screen. 97 * For example the following paths will be searched in the layouts 98 * subdirectory: /about_us/directions/driving.wm, 99 * /about_us/directions/default.wm, /about_us/default.wm, /default.wm, 100 * where wm is the value of the template.default.extension property. 101 * 102 * <p> 103 * 104 * This approach allows a site with largely static content to be 105 * updated and added to regularly by those with little Java 106 * experience. 107 * 108 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a> 109 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> 110 * @version $Id: TemplatePage.java,v 1.1.1.1 2001/08/16 05:08:36 jvanzyl Exp $ 111 */ 112 public class TemplatePage extends DefaultPage 113 { 114 /*** 115 * Works with TemplateService to set up default templates and 116 * corresponding class modules. 117 * 118 * @param data Turbine information. 119 * @exception Exception, a generic exception. 120 */ 121 protected void doBuildAfterAction(RunData data) throws Exception 122 { 123 /* 124 * Either template or screen should be guaranteed by 125 * the SessionValidator 126 * It is occasionally better to specify the screen instead of template 127 * in cases where multiple Screens map to one template. The template 128 * is hardcoded into the Screen in this instance. In this case this 129 * action is skipped. 130 */ 131 if (!data.hasScreen()) 132 { 133 /* 134 * This is effectively getting the "template" parameter 135 * from the parameter parser in rundata. This is coming 136 * from the request for a template. 137 */ 138 String template = data.getTemplateInfo().getScreenTemplate(); 139 140 /* 141 * Get the layout template and the correct Screen. 142 */ 143 String layoutTemplate = 144 TurbineTemplate.getLayoutTemplateName(template); 145 data.getTemplateInfo().setLayoutTemplate(layoutTemplate); 146 147 String screen = TurbineTemplate.getScreenName(template); 148 149 if (screen == null) 150 { 151 throw new Exception("Screen could not be determined. \n" + 152 "No matches were found by TemplateService and the \n" + 153 "services.TemplateService.default.screen property\n" + 154 "was not set."); 155 } 156 data.setScreen(screen); 157 } 158 } 159 }

This page was automatically generated by Maven