KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > fill > JRSubreportRunner


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.fill;
29
30 import net.sf.jasperreports.engine.JRException;
31
32
33 /**
34  * Subreport runner interface.
35  *
36  * @author Lucian Chirita (lucianc@users.sourceforge.net)
37  * @version $Id: JRSubreportRunner.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
38  */
39 public interface JRSubreportRunner
40 {
41     /**
42      * Decides whether the subreport filling has ended or not.
43      *
44      * @return <code>true</code> iff the subreport filling has not ended
45      */
46     boolean isFilling();
47
48     /**
49      * Starts to fill the subreport.
50      * <p>
51      * This method is always called by a thread owning the lock on the subreport filler.
52      *
53      * @return the result of the fill process
54      * @throws JRException
55      */
56     JRSubreportRunResult start() throws JRException;
57
58     /**
59      * Resumes the filling of a subreport.
60      * <p>
61      * This method is called after the fill has been suspended by
62      * {@link #suspend() suspend} and the subreport should continue on the new page.
63      * <p>
64      * This method is always called by a thread owning the lock on the subreport filler.
65      *
66      * @return the result of the fill process
67      * @throws JRException
68      */
69     JRSubreportRunResult resume() throws JRException;
70
71     /**
72      * Resets the runner, preparing it for a new fill.
73      *
74      * @throws JRException
75      */
76     void reset() throws JRException;
77
78     /**
79      * Cancels the current fill process.
80      * <p>
81      * This method is called when a subreport is placed on a non splitting band
82      * and needs to rewind.
83      * <p>
84      * This method is always called by a thread owning the lock on the subreport filler.
85      *
86      * @throws JRException
87      */
88     void cancel() throws JRException;
89
90     /**
91      * Suspends the current fill.
92      * <p>
93      * This method is called when the subreport reaches the end of a page
94      * and needs to wait for the master to create a new page.
95      * <p>
96      * This method is always called by a thread owning the lock on the subreport filler.
97      *
98      * @throws JRException
99      */
100     void suspend() throws JRException;
101 }
102
Popular Tags