/* 
    P/P   *  Method: net.sourceforge.pebble.web.view.View__static_init
          */
     1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.web.view;
    33  
    34  import net.sourceforge.pebble.web.model.Model;
    35  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.view.View()
          */
    36  import javax.servlet.ServletContext;
    37  import javax.servlet.ServletException;
    38  import javax.servlet.http.HttpServletRequest;
    39  import javax.servlet.http.HttpServletResponse;
    40  
    41  /**
    42   * Represents a view component and prepares the model for display.
    43   *
    44   * @author    Simon Brown
    45   */
    46  public abstract class View {
    47  
    48    private Model model;
    49    private ServletContext servletContext;
    50  
    51    /**
    52     * Gets the content type of this view.
    53     *
    54     * @return the content type as a String
    55     */
    56    public abstract String getContentType();
    57  
    58    /**
    59     * Gets the model.
    60     *
    61     * @return  a Model instance
    62     */
           /* 
    P/P     *  Method: Model getModel()
            * 
            *  Preconditions:
            *    init'ed(this.model)
            * 
            *  Postconditions:
            *    return_value == this.model
            *    init'ed(return_value)
            */
    63    public Model getModel() {
    64      return this.model;
    65    }
    66  
    67    /**
    68     * Sets the model.
    69     *
    70     * @param model   a Model instance
    71     */
           /* 
    P/P     *  Method: void setModel(Model)
            * 
            *  Postconditions:
            *    this.model == model
            *    init'ed(this.model)
            */
    72    public void setModel(Model model) {
    73      this.model = model;
    74    }
    75  
    76  
    77    /**
    78     * Gets the ServletContext in which this view is operating.
    79     *
    80     * @return    a ServletContext instance
    81     */
    82    public ServletContext getServletContext() {
             /* 
    P/P       *  Method: ServletContext getServletContext()
              * 
              *  Preconditions:
              *    init'ed(this.servletContext)
              * 
              *  Postconditions:
              *    return_value == this.servletContext
              *    init'ed(return_value)
              */
    83      return servletContext;
    84    }
    85  
    86    /**
    87     * Gets the ServletContext in which this view is operating.
    88     *
    89     * @param   servletContext    a ServletContext instance
    90     */
    91    public void setServletContext(ServletContext servletContext) {
             /* 
    P/P       *  Method: void setServletContext(ServletContext)
              * 
              *  Postconditions:
              *    this.servletContext == servletContext
              *    init'ed(this.servletContext)
              */
    92      this.servletContext = servletContext;
    93    }
    94  
    95    /**
    96     * Prepares the view for presentation.
    97     */
           /* 
    P/P     *  Method: void prepare()
            */
    98    public void prepare() {
    99    }
   100  
   101    /**
   102     * Dispatches this view.
   103     *
   104     * @param request     the HttpServletRequest instance
   105     * @param response    the HttpServletResponse instance
   106     * @param context     the ServletContext instance
   107     */
   108    public abstract void dispatch(HttpServletRequest request, HttpServletResponse response, ServletContext context)
   109        throws ServletException;
   110  
   111  }