KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > dbforms > event > NavNewEvent


1 /*
2  * $Header: /cvsroot/jdbforms/dbforms/src/org/dbforms/event/NavNewEvent.java,v 1.17 2004/10/20 10:51:29 hkollmann Exp $
3  * $Revision: 1.17 $
4  * $Date: 2004/10/20 10:51:29 $
5  *
6  * DbForms - a Rapid Application Development Framework
7  * Copyright (C) 2001 Joachim Peer <joepeer@excite.com>
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22  */
23
24 package org.dbforms.event;
25
26 import org.apache.commons.logging.Log;
27 import org.apache.commons.logging.LogFactory;
28
29 import org.dbforms.config.DbEventInterceptorData;
30 import org.dbforms.config.DbFormsConfig;
31 import org.dbforms.config.FieldValue;
32 import org.dbforms.config.ResultSetVector;
33 import org.dbforms.config.Table;
34
35 import java.sql.SQLException JavaDoc;
36
37 import javax.servlet.http.HttpServletRequest JavaDoc;
38
39
40
41 /**
42  * <p>
43  * This event signalizes to the framework that the user wants to initializa a
44  * new dataset
45  * </p>
46  * #fixme: lousy description
47  *
48  * @author Joe Peer
49  */
50 public class NavNewEvent extends NavigationEvent {
51    private static Log logCat = LogFactory.getLog(NavNewEvent.class.getName()); // logging category for this class
52
53    /**
54     * Creates a new NavNewEvent object.
55     *
56     * @param action DOCUMENT ME!
57     * @param request DOCUMENT ME!
58     * @param config DOCUMENT ME!
59     */
60    public NavNewEvent(String JavaDoc action,
61                       HttpServletRequest JavaDoc request,
62                       DbFormsConfig config) {
63       super(action, request, config);
64    }
65
66
67    /**
68     * Creates a new NavNewEvent object.
69     *
70     * @param table DOCUMENT ME!
71     * @param request DOCUMENT ME!
72     * @param config DOCUMENT ME!
73     */
74    public NavNewEvent(Table table,
75                       HttpServletRequest JavaDoc request,
76                       DbFormsConfig config) {
77       super(table, request, config);
78    }
79
80    /**
81     * Process the current event.
82     *
83     * @param childFieldValues FieldValue array used to restrict a set of data
84     * @param orderConstraint FieldValue array used to build a cumulation of
85     * rules for ordering (sorting) and restricting fields to the actual
86     * block of data
87     * @param sqlFilter DOCUMENT ME!
88     * @param sqlFilterParams DOCUMENT ME!
89     * @param count record count
90     * @param firstPosition a string identifying the first resultset position
91     * @param lastPosition a string identifying the last resultset position
92     * @param dbConnectionName name of the used db connection. Can be used to
93     * get an own db connection, e.g. to hold it during the session
94     * (see DataSourceJDBC for example!)
95     * @param con the JDBC Connection object
96     *
97     * @return a ResultSetVector object
98     *
99     * @exception SQLException if any error occurs
100     */
101    public ResultSetVector processEvent(FieldValue[] childFieldValues,
102                                        FieldValue[] orderConstraint,
103                                        String JavaDoc sqlFilter,
104                                        FieldValue[] sqlFilterParams,
105                                        int count,
106                                        String JavaDoc firstPosition,
107                                        String JavaDoc lastPosition,
108                                        DbEventInterceptorData interceptorData)
109                                 throws SQLException JavaDoc {
110       logCat.info("processed NavNewEvent");
111
112       return null;
113    }
114 }
115
Popular Tags