/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General Public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General Public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   *
   * See the GNU General Public License in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General Public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: LoadDataAction.java,v $
   * Revision 1.8  2005/04/09 18:04:14  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.7  2005/01/19 12:18:45  colinmacleod
   * Removed magic number from FieldWriterFactory constructor.
   *
   * Revision 1.6  2005/01/07 08:08:19  colinmacleod
   * Moved up a version number.
   * Changed copyright notices to 2005.
   * Updated the documentation:
   *   - started working on multiproject:site docu.
   *   - changed the logo.
   * Added checkstyle and fixed LOADS of style issues.
   * Added separate thirdparty subproject.
   * Added struts (in web), util and webgui (in webtheme) from ivata op.
   *
   * Revision 1.5  2004/12/29 15:11:12  colinmacleod
   * Replaced hard-coded application attribute name with static variable.
   *
   * Revision 1.4  2004/12/23 21:28:16  colinmacleod
   * Modifications to add ivata op compatibility.
   *
   * Revision 1.3  2004/11/12 15:10:41  colinmacleod
   * Moved persistence classes from ivata op as a replacement for
   ValueObjectLocator.
   *
   * Revision 1.2  2004/11/11 13:20:33  colinmacleod
   * Added new data objects.
   * Added logging.
   *
   * Revision 1.1.1.1  2004/05/16 20:40:07  colinmacleod
   * Ready for 0.1 release
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.demo.struts;
  import java.math.BigDecimal;
  import java.util.List;
  import java.util.Vector;
  import javax.servlet.ServletContext;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import javax.servlet.http.HttpSession;
  import org.apache.log4j.Logger;
  import org.apache.struts.action.Action;
  import org.apache.struts.action.ActionForm;
  import org.apache.struts.action.ActionForward;
  import org.apache.struts.action.ActionMapping;
  import com.ivata.mask.Mask;
  import com.ivata.mask.MaskFactory;
  import com.ivata.mask.persistence.PersistenceException;
  import com.ivata.mask.web.demo.catalog.Catalog;
  import com.ivata.mask.web.demo.customer.CustomerDO;
  import com.ivata.mask.web.demo.order.OrderDO;
  import com.ivata.mask.web.demo.order.item.OrderItemDO;
  import com.ivata.mask.web.demo.product.ProductDO;
  import com.ivata.mask.web.field.DefaultFieldWriterFactory;
  import com.ivata.mask.web.field.FieldWriterFactory;
  import com.ivata.mask.web.struts.ListForm;
  /***
   * <p>
   * If you have no data in your Http Session, you are redirected here to create
   * some.
   * </p>
   *
   * @since ivata masks 0.1 (2004-04-30)
   * @author Colin MacLeod
   * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
   * @version $Revision: 1.8 $
   */
 public class LoadDataAction extends Action {
     /***
      * <p>
      * Specifies the path to the mask config file, relative to the webapp root.
      * </p>
      */
     private static final String FILE_NAME = "/WEB-INF/ivataMasks.xml";
     /***
      * <p>
      * This log provides tracing and debugging information.
      * </p>
      */
     private Logger log = Logger.getLogger(LoadDataAction.class);
     /***
      * <p>
      * Add a new customer.
      * </p>
      *
      * @param emailAddress standard email address, such as
      * <code>bob@nowhere.com</code>.
      * @param firstName First name(s) of the customer.
      * @param lastName Last name (surname) of the customer.
      * @param postalAddress Full customer postal address, including carriage
      * returns, region/state, country, etc.
      * @return freshly created customer which has been added to the system.
      */
     private CustomerDO addCustomer(final String emailAddress,
             final String firstName,
             final String lastName,
             final String postalAddress) {
         CustomerDO customer = new CustomerDO();
         customer.setEmailAddress(emailAddress);
         customer.setFirstName(firstName);
         customer.setLastName(lastName);
         customer.setPostalAddress(postalAddress);
         Catalog catalog = Catalog.getInstance();
         try {
             catalog.add(null, customer);
         } catch (PersistenceException e) {
             e.printStackTrace();
             throw new RuntimeException(e);
         }
         return customer;
     }
     /***
      * <p>
      * Add a new order.
      * </p>
      *
      * @param customerParam customer who placed the order.
      * @param itemsParam a <code>List</code> of {@link OrderItemDO} instances.
      * @return new instance of order for the customer and items provided.
      */
     private OrderDO addOrder(final CustomerDO customerParam,
             final List itemsParam) {
         OrderDO order = new OrderDO();
         order.setCustomer(customerParam);
         order.setItems(itemsParam);
         Catalog catalog = Catalog.getInstance();
         try {
             catalog.add(null, order);
         } catch (PersistenceException e) {
             e.printStackTrace();
             throw new RuntimeException(e);
         }
         return order;
     }
     /***
      * <p>
      * Add a new product.
      * </p>
      *
      * @param name Name of the product being added.
      * @param price How much each item of this product will cost.
      * @param description Just some silly text to describe what it <i>really</i>
      * does.
      * @return new product, freshly initialized.
      */
     private ProductDO addProduct(final String name,
             final BigDecimal price,
             final String description) {
         ProductDO product = new ProductDO();
         product.setName(name);
         product.setPrice(price);
         product.setDescription(description);
         Catalog catalog = Catalog.getInstance();
         try {
             catalog.add(null, product);
         } catch (PersistenceException e) {
             throw new RuntimeException(e);
         }
         return product;
     }
     /***
      * <p>
      * Create a new order item.
      * </p>
      *
      * @param product the product which is being ordered.
      * @param quantity number of this product which is being ordered.
      * @return new instance of order item for the product and quantity.
      */
     private OrderItemDO createOrderItem(final ProductDO product,
             final int quantity) {
         OrderItemDO item = new OrderItemDO();
         item.setProduct(product);
         item.setQuantity(quantity);
         Catalog catalog = Catalog.getInstance();
         try {
             catalog.add(null, item);
         } catch (PersistenceException e) {
             e.printStackTrace();
             throw new RuntimeException(e);
         }
         return item;
     }
     /***
      * <p>
      * Generic method called by the <strong>Struts </strong> interface. Always
      * returns success. .
      * </p>
      *
      * @param mapping
      *            The ActionMapping used to select this instance
      * @param form
      *            The optional ActionForm bean for this request (if any)
      * @param request
      *            The non-HTTP request we are processing
      * @param response
      *            The non-HTTP response we are creating
      * @exception Exception
      *                if the application business logic throws an exception
      * @return this method returns a <code>"success"</code>
      * <code>ActionForward</code>
      *         every time.
      */
     public ActionForward execute(final ActionMapping mapping,
             final ActionForm form,
             final HttpServletRequest request,
             final HttpServletResponse response)
             throws Exception {
         // this is just a demo, so we use the HTTP session to contain all our
         // objects. in real life, we'd use something like an IoC container
         Catalog catalog = Catalog.getInstance();
         HttpSession session = request.getSession();
         catalog.reset();
         // first create some products we can buy
         // NOTE: I cheated here - these are hard-coded 'magic numbers' - this is
         // a demo app, after all. :-)
         ProductDO nails = addProduct("10 inch nails", new BigDecimal("1.99"),
                 "pack of 50, 10 inch steel nails");
         ProductDO hammer = addProduct("large hammer", new BigDecimal("4.99"),
                 "huge hammer, good for hitting nails with");
         ProductDO wood = addProduct("block of wood", new BigDecimal("2.99"),
                 "beautifully crafted piece of waste wood. ideal for practise.");
         List products = catalog.findAll(null, ProductDO.class);
         session.setAttribute("products", products);
         // now create some test customers
         CustomerDO johnny = addCustomer("john.tester@test.com", "Johnny",
                 "Tester",
                 "John H Tester\n23 Nowhere Avenue\nNotown\nOuter Nosuchland");
         CustomerDO fred = addCustomer("fred.another@test.com", "Fred",
                 "Another",
                 "Freddie Another\n98 Madeupname Street\nDontexist\nNowayland");
         // and create some test orders for those customers
         List items = new Vector();
         items.add(createOrderItem(nails, 55));
         items.add(createOrderItem(hammer, 2));
         addOrder(johnny, items);
         items = new Vector();
         items.add(createOrderItem(hammer, 2));
         items.add(createOrderItem(wood, 1));
         addOrder(johnny, items);
         items = new Vector();
         items.add(createOrderItem(nails, 25));
         items.add(createOrderItem(hammer, 1));
         items.add(createOrderItem(wood, 5));
         addOrder(fred, items);
         // read in the configuration for the masks
         ServletContext context = servlet.getServletContext();
         FieldWriterFactory fieldWriterFactory = new DefaultFieldWriterFactory(
                 catalog, "/find.action");
         context.setAttribute(FieldWriterFactory.APPLICATION_ATTRIBUTE,
                 fieldWriterFactory);
         MaskFactory maskFactory = catalog.getMaskFactory();
         maskFactory.readConfiguration(context.getResourceAsStream(FILE_NAME));
         context.setAttribute("MaskFactory", maskFactory);
         Mask mask = maskFactory.getMask(ProductDO.class, "list");
         if (mask == null) {
             log.error("ERROR: mask is null");
             throw new NullPointerException("ERROR in LoadDataAction: mask is "
                     + "null");
         }
         ListForm listForm = new ListForm(products, mask, ProductDO.class);
         request.setAttribute(ListForm.REQUEST_ATTRIBUTE, listForm);
         return mapping.findForward("success");
     }
 }