01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * 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 java.util.Set;
31:
32: import net.sf.jasperreports.engine.JRPrintElement;
33:
34: /**
35: * Interface implemented by print elements that can record field/variable values.
36: * <p/>
37: * An element having {@link net.sf.jasperreports.engine.JRExpression#EVALUATION_TIME_AUTO Auto evaluation time}
38: * will generate an instance of this type as print element.
39: * This instance will be responsible of storing field/variable values until the element can be evaluated.
40: *
41: * @author Lucian Chirita (lucianc@users.sourceforge.net)
42: * @version $Id: JRRecordedValuesPrintElement.java 1229 2006-04-19 10:27:35Z teodord $
43: * @see net.sf.jasperreports.engine.JRExpression#EVALUATION_TIME_AUTO
44: */
45: public interface JRRecordedValuesPrintElement extends JRPrintElement {
46: /**
47: * Initializes the recorded values set.
48: *
49: * @param evaluationTimes future times when the values will be recorded
50: */
51: void initRecordedValues(Set evaluationTimes);
52:
53: /**
54: * Returns the recorded values set.
55: *
56: * @return the recorded values set
57: */
58: JRRecordedValues getRecordedValues();
59:
60: /**
61: * Releases the recorded values set.
62: * <p/>
63: * This is called when all the recorded values are available and the element has been evaluated.
64: */
65: void deleteRecordedValues();
66: }
|