KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Element datasets are used to represent the report data needed to generate a chart or crosstab.
32  * The dataset structure may vary with each chart type or crosstab.
33  * This is the superinterface for all datasets and contains common dataset properties.
34  *
35  * @author Teodor Danciu (teodord@users.sourceforge.net)
36  * @version $Id: JRElementDataset.java 1317 2006-06-30 19:02:41 +0300 (Fri, 30 Jun 2006) lucianc $
37  */
38 public interface JRElementDataset
39 {
40
41     /**
42      * Gets the reset type. This specifies the range of report data used for filling the dataset.
43      * @return one of the reset constants in {@link JRVariable}
44      */
45     public byte getResetType();
46
47     /**
48      * Gets the selected reset group in case of reset type group.
49      */
50     public JRGroup getResetGroup();
51
52     /**
53      * Returns the increment type. This specifies dataset values increment step.
54      * @return one of the reset constants in {@link JRVariable}, since the increment type uses the same
55      * constants as the reset type.
56      */
57     public byte getIncrementType();
58
59     /**
60      * Gets the selected increment group in case of increment type group.
61      */
62     public JRGroup getIncrementGroup();
63
64     /**
65      *
66      */
67     public void collectExpressions(JRExpressionCollector collector);
68
69     /**
70      * Returns the sub dataset run for this chart dataset.
71      *
72      * @return the sub dataset run for this chart dataset
73      */
74     public JRDatasetRun getDatasetRun();
75     
76     /**
77      * Returns the "increment when" expression.
78      * <p>
79      * This expression determines whether a dataset will be incremented or not.
80      * <p>
81      * The expression (if not null) is evaluated before each increment of the dataset.
82      * The increment will be carried on only when the result of the evaluation is <code>Boolean.TRUE</code>;
83      * if the result is null or false, the increment will not be performed.
84      *
85      *
86      * @return the "increment when" expression
87      */
88     public JRExpression getIncrementWhenExpression();
89
90 }
91
Popular Tags