Coverage Report - org.apache.turbine.modules.Layout
 
Classes in this File Line Coverage Branch Coverage Complexity
Layout
55%
5/9
N/A
1
 
 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  
 import org.apache.turbine.util.RunData;
 24  
 
 25  
 /**
 26  
  * This is the base class that defines what a Layout module is.
 27  
  *
 28  
  * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
 29  
  * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
 30  
  * @version $Id: Layout.java 717934 2008-11-15 21:48:47Z tv $
 31  
  */
 32  18
 public abstract class Layout
 33  
     extends Assembler
 34  
 {
 35  
     /** Prefix for layout related classes and templates */
 36  
     public static final String PREFIX = "layouts";
 37  
     
 38  
     /** Property for the size of the layout cache if caching is on */
 39  
     public static final String CACHE_SIZE_KEY = "layout.cache.size";
 40  
     
 41  
     /** The default size for the layout cache */
 42  
     public static final int CACHE_SIZE_DEFAULT = 10;
 43  
 
 44  
     /** Represents Layout Objects */
 45  
     public static final String NAME = "layout";
 46  
 
 47  
     /**
 48  
      * @see org.apache.turbine.modules.Assembler#getPrefix()
 49  
      */
 50  
     public String getPrefix()
 51  
     {
 52  0
         return PREFIX;
 53  
     }
 54  
 
 55  
     /**
 56  
      * A subclass must override this method to build itself.
 57  
      * Subclasses override this method to store the layout in RunData
 58  
      * or to write the layout to the output stream referenced in
 59  
      * RunData.
 60  
      * @deprecated Use PipelineData version instead
 61  
      *
 62  
      * @param data Turbine information.
 63  
      * @exception Exception a generic exception.
 64  
      */
 65  
     protected abstract void doBuild(RunData data)
 66  
         throws Exception;
 67  
 
 68  
     /**
 69  
      * Subclasses can override this method to add additional
 70  
      * functionality.  This method is protected to force clients to
 71  
      * use LayoutLoader to build a Layout.
 72  
      * @deprecated Use PipelineData version instead
 73  
      * @param data Turbine information.
 74  
      * @exception Exception a generic exception.
 75  
      */
 76  
     protected void build(RunData data)
 77  
         throws Exception
 78  
     {
 79  2
         doBuild(data);
 80  2
     }
 81  
 
 82  
 
 83  
     /**
 84  
      * A subclass must override this method to perform itself.  The
 85  
      * Action can also set the screen that is associated with RunData.
 86  
      * Should revert to abstract when RunData is gone.
 87  
      * @param data Turbine information.
 88  
      * @exception Exception a generic exception.
 89  
      */
 90  
     protected void doBuild(PipelineData pipelineData) throws Exception
 91  
     {
 92  0
         RunData data = getRunData(pipelineData);
 93  0
         doBuild(data);
 94  0
     }
 95  
 
 96  
     /**
 97  
      * Subclasses can override this method to add additional
 98  
      * functionality.  This method is protected to force clients to
 99  
      * use ActionLoader to perform an Action.
 100  
      *
 101  
      * @param data Turbine information.
 102  
      * @exception Exception a generic exception.
 103  
      */
 104  
     protected void build(PipelineData pipelineData) throws Exception
 105  
     {
 106  8
         doBuild(pipelineData);
 107  4
     }
 108  
 
 109  
 
 110  
 }