View Javadoc
1   /*
2    * $Source$
3    * $Revision$
4    *
5    * Copyright (C) 2000 William Chesters
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   *     William Chesters <williamc At paneris.org>
42   *     http://paneris.org/~williamc
43   *     Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44   */
45  
46  package org.melati.poem;
47  
48  import java.util.Enumeration;
49  
50  /**
51   * A {@link TailoredQuery} which uses a <code>PreparedStatement</code>.
52   *
53   */ 
54  public class PreparedTailoredQuery extends TailoredQuery {
55    private PreparedStatementFactory statements;
56  
57    /**
58     * Full constructor.
59     * 
60     * @param modifier SQL modifier eg DISTINCT
61     * @param selectedColumns an array of columns we know we need
62     * @param otherTables tables other than the one we belong to
63     * @param whereClause raw SQL where clause
64     * @param orderByClause raw SQL order by clause 
65     */
66    public PreparedTailoredQuery(String modifier,
67                                 Column<?>[] selectedColumns, Table<?>[] otherTables,
68                                 String whereClause, String orderByClause) {
69      super(modifier, selectedColumns, otherTables, whereClause, orderByClause);
70      statements = new PreparedStatementFactory(database, sql);
71    }
72  
73    /**
74     * Constructor with null modifier. 
75     * 
76     * @param selectedColumns an array of columns we know we need
77     * @param otherTables tables other than the one we belong to
78     * @param whereClause raw SQL where clause
79     * @param orderByClause raw SQL order by clause 
80     */
81    public PreparedTailoredQuery(Column<?>[] selectedColumns, Table<?>[] otherTables,
82                                 String whereClause, String orderByClause) {
83      this(null, selectedColumns, otherTables, whereClause, orderByClause);
84    }
85  
86    /**
87     * The results of the query.
88     * @return the results (a TailoredResultSetEnumeration) as an Enumeration.
89     * @see org.melati.poem.TailoredQuery#selection()
90     */
91    public Enumeration<FieldSet> selection() {
92      return new TailoredResultSetEnumeration<FieldSet>(this, statements.resultSet());
93    }
94  
95    /**
96     * @return an enumeration of the Columns in the first row of a ResultSet
97     * {@inheritDoc}
98     * @see org.melati.poem.TailoredQuery#selection_firstRaw()
99     */
100   public Enumeration<Object> selection_firstRaw() {
101     return new FirstRawTailoredResultSetEnumeration<Object>(this,
102                                                     statements.resultSet());
103   }
104 }