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.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 10:27:35Z teodord $
42: */
43: public interface JRCrosstabBucket {
44: /**
45: * Returns the bucket sorting type.
46: * <p>
47: * The possible values are:
48: * <ul>
49: * <li>{@link net.sf.jasperreports.crosstabs.fill.calculation.BucketDefinition#ORDER_ASCENDING Bucket.ORDER_ASCENDING}</li>
50: * <li>{@link net.sf.jasperreports.crosstabs.fill.calculation.BucketDefinition#ORDER_DESCENDING Bucket.ORDER_DESCENDING}</li>
51: * </ul>
52: *
53: * @return the bucket sorting type
54: */
55: public byte getOrder();
56:
57: /**
58: * Returns the grouping expression.
59: *
60: * @return the grouping expression
61: */
62: public JRExpression getExpression();
63:
64: /**
65: * Returns the comparator expression.
66: * <p>
67: * The result of this expression is used to sort the buckets, in ascending or
68: * descending order (given by {@link #getOrder() getOrder()}.
69: *
70: * @return the comparator expression
71: */
72: public JRExpression getComparatorExpression();
73: }
|