/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.Action__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.action;
    33  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.Action()
          */
    34  import javax.servlet.ServletException;
    35  import javax.servlet.http.HttpServletRequest;
    36  import javax.servlet.http.HttpServletResponse;
    37  
    38  import net.sourceforge.pebble.Constants;
    39  import net.sourceforge.pebble.domain.AbstractBlog;
    40  import net.sourceforge.pebble.util.I18n;
    41  import net.sourceforge.pebble.web.model.Model;
    42  import net.sourceforge.pebble.web.view.View;
    43  
    44  /**
    45   * The superclass for all command/action components delegated to by the
    46   * controller.
    47   *
    48   * @author    Simon Brown
    49   */
    50  public abstract class Action {
    51  
    52    private Model model;
    53  
    54    /**
    55     * Gets the model.
    56     *
    57     * @return  a Model instance
    58     */
           /* 
    P/P     *  Method: Model getModel()
            * 
            *  Preconditions:
            *    init'ed(this.model)
            * 
            *  Postconditions:
            *    return_value == this.model
            *    init'ed(return_value)
            */
    59    public Model getModel() {
    60      return this.model;
    61    }
    62  
    63    /**
    64     * Sets the model.
    65     *
    66     * @param model   a Model instance
    67     */
           /* 
    P/P     *  Method: void setModel(Model)
            * 
            *  Postconditions:
            *    this.model == model
            *    init'ed(this.model)
            */
    68    public void setModel(Model model) {
    69      this.model = model;
    70    }
    71  
    72    /**
    73     * retrieve a localized String for the current blogs locale by key
    74     * @param key
    75     * @return
    76     */
           /* 
    P/P     *  Method: String getLocalizedString(String)
            * 
            *  Preconditions:
            *    this.model != null
            *    this.model.data != null
            * 
            *  Presumptions:
            *    java.util.HashMap:get(...)@63 != null
            * 
            *  Postconditions:
            *    init'ed(return_value)
            */
    77    public String getLocalizedString(String key) {
    78    	return I18n.getMessage(((AbstractBlog)getModel().get(Constants.BLOG_KEY)).getLocale(), key);
    79    }
    80  
    81    
    82    /**
    83     * Performs the processing associated with this action.
    84     *
    85     * @param request     the HttpServletRequest instance
    86     * @param response    the HttpServletResponse instance
    87     * @return  the name of the next view
    88     */
    89    public abstract View process(HttpServletRequest request, HttpServletResponse response)
    90        throws ServletException;
    91  
    92  }