KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > crosstabs > JRCrosstabBucket


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.crosstabs;
29
30 import net.sf.jasperreports.engine.JRExpression;
31
32 /**
33  * Crosstab groups bucketing information interface.
34  * <p>
35  * The bucketing informartion consists of the grouping expression
36  * and sorting information.
37  * The buckets can be sorted according to the natural sorting (if the values
38  * implement {@link java.lang.Comparable Comparable}) or using a comparator.
39  *
40  * @author Lucian Chirita (lucianc@users.sourceforge.net)
41  * @version $Id: JRCrosstabBucket.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
42  */
43 public interface JRCrosstabBucket
44 {
45     /**
46      * Returns the bucket sorting type.
47      * <p>
48      * The possible values are:
49      * <ul>
50      * <li>{@link net.sf.jasperreports.crosstabs.fill.calculation.BucketDefinition#ORDER_ASCENDING Bucket.ORDER_ASCENDING}</li>
51      * <li>{@link net.sf.jasperreports.crosstabs.fill.calculation.BucketDefinition#ORDER_DESCENDING Bucket.ORDER_DESCENDING}</li>
52      * </ul>
53      *
54      * @return the bucket sorting type
55      */
56     public byte getOrder();
57     
58     
59     /**
60      * Returns the grouping expression.
61      *
62      * @return the grouping expression
63      */
64     public JRExpression getExpression();
65     
66     
67     /**
68      * Returns the comparator expression.
69      * <p>
70      * The result of this expression is used to sort the buckets, in ascending or
71      * descending order (given by {@link #getOrder() getOrder()}.
72      *
73      * @return the comparator expression
74      */
75     public JRExpression getComparatorExpression();
76 }
77
Popular Tags