KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > JRDataSource


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.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  * JasperSoft Corporation
24  * 303 Second Street, Suite 450 North
25  * San Francisco, CA 94107
26  * http://www.jaspersoft.com
27  */
28 package net.sf.jasperreports.engine;
29
30
31 /**
32  * This interface represents the abstract representation of a JasperReports data source. All data source types must
33  * implement this interface.
34  * <p>
35  * JasperReports provides default implementations of result set, bean collections and bean arrays data sources.
36  * @author Teodor Danciu (teodord@users.sourceforge.net)
37  * @version $Id: JRDataSource.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
38  */
39 public interface JRDataSource
40 {
41
42
43     /**
44      * Tries to position the cursor on the next element in the data source.
45      * @return true if there is a next record, false otherwise
46      * @throws JRException if any error occurs while trying to move to the next element
47      */
48     public boolean next() throws JRException;
49
50     /**
51      * Gets the field value for the current position.
52      * @return an object containing the field value. The object type must be the field object type.
53      */
54     public Object JavaDoc getFieldValue(JRField jrField) throws JRException;
55
56
57 }
58
Popular Tags