View Javadoc
1   /*
2    * $Source$
3    * $Revision$
4    *
5    * Copyright (C) 2000 Myles Chippendale
6    *
7    * Part of Melati (http://melati.org), a framework for the rapid
8    * development of clean, maintainable web applications.
9    *
10   * Melati is free software; Permission is granted to copy, distribute
11   * and/or modify this software under the terms either:
12   *
13   * a) the GNU General Public License as published by the Free Software
14   *    Foundation; either version 2 of the License, or (at your option)
15   *    any later version,
16   *
17   *    or
18   *
19   * b) any version of the Melati Software License, as published
20   *    at http://melati.org
21   *
22   * You should have received a copy of the GNU General Public License and
23   * the Melati Software License along with this program;
24   * if not, write to the Free Software Foundation, Inc.,
25   * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26   * GNU General Public License and visit http://melati.org to obtain the
27   * Melati Software License.
28   *
29   * Feel free to contact the Developers of Melati (http://melati.org),
30   * if you would like to work out a different arrangement than the options
31   * outlined here.  It is our intention to allow Melati to be used by as
32   * wide an audience as possible.
33   *
34   * This program is distributed in the hope that it will be useful,
35   * but WITHOUT ANY WARRANTY; without even the implied warranty of
36   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
37   * GNU General Public License for more details.
38   *
39   * Contact details for copyright holder:
40   *
41   *     Mylesc Chippendale <mylesc AT paneris.org>
42   *     http://paneris.org/
43   *     29 Stanley Road, Oxford, OX4 1QY, UK
44   */
45  
46  package org.melati.servlet;
47  
48  import java.util.Hashtable;
49  
50  import org.melati.Melati;
51  
52  /**
53   * A way to implement policies about how to save uploaded files.
54   */
55  public abstract class FormDataAdaptorFactory {
56    
57    /**
58     * We need to establish the user and set up any request specific melati stuff
59     * so that we can verify the user has permission for this task, and use
60     * melati Table / Objects to manipulate what the FormDataAdaptor does.
61     *
62     * Please note that when uploading a file for a record that has not yet been
63     * inserted (ie whilst adding), melati.getObject will return null.
64     *
65     * @param melati the {@link Melati}
66     * @param field  a {@link MultipartFormField} to process
67     * @return a new {@link FormDataAdaptor}
68     */
69    
70    public FormDataAdaptor get(final Melati melati, 
71                               final MultipartFormField field) {
72  
73      final Hashtable<String, FormDataAdaptor> holder = new Hashtable<String, FormDataAdaptor>();
74      if (melati.getDatabase() == null) {
75        holder.put("hereiam",getIt(melati,field));
76      } else {
77        melati.loadTableAndObject();
78        holder.put("hereiam",getIt(melati,field));
79      }
80      return holder.get("hereiam");
81    }
82    
83    /**
84     * Implements different policies for saving uploaded files depending
85     * on the details of the file and the state of the application.
86     *
87     * @param     melati  the state of (this call to) the application
88     * @param     field   details of the uploaded file
89     * @return    an adaptor which will save the contents of the file
90     */
91    public abstract FormDataAdaptor getIt(Melati melati, 
92                                          MultipartFormField field);
93  }
94