1 package org.apache.turbine.modules; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import org.apache.turbine.pipeline.PipelineData; 23 24 /** 25 * This is the base class that defines what a Layout module is. 26 * 27 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> 28 * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a> 29 * @version $Id: Layout.java 1773378 2016-12-09 13:19:59Z tv $ 30 */ 31 public abstract class Layout 32 extends Assembler 33 { 34 /** Prefix for layout related classes and templates */ 35 public static final String PREFIX = "layouts"; 36 37 /** Property for the size of the layout cache if caching is on */ 38 public static final String CACHE_SIZE_KEY = "layout.cache.size"; 39 40 /** The default size for the layout cache */ 41 public static final int CACHE_SIZE_DEFAULT = 10; 42 43 /** Represents Layout Objects */ 44 public static final String NAME = "layout"; 45 46 /** 47 * @see org.apache.turbine.modules.Assembler#getPrefix() 48 */ 49 @Override 50 public String getPrefix() 51 { 52 return PREFIX; 53 } 54 55 /** 56 * A subclass must override this method to perform itself. The 57 * Action can also set the screen that is associated with PipelineData. 58 * @param pipelineData Turbine information. 59 * @throws Exception a generic exception. 60 */ 61 protected abstract void doBuild(PipelineData pipelineData) throws Exception; 62 63 /** 64 * Subclasses can override this method to add additional 65 * functionality. This method is protected to force clients to 66 * use ActionLoader to perform an Action. 67 * 68 * @param pipelineData Turbine information. 69 * @throws Exception a generic exception. 70 */ 71 protected void build(PipelineData pipelineData) throws Exception 72 { 73 doBuild(pipelineData); 74 } 75 }