01: /**
02: * ===========================================
03: * JFreeReport : a free Java reporting library
04: * ===========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either 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, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * RawDataSource.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.filter;
30:
31: import org.jfree.report.function.ExpressionRuntime;
32:
33: /**
34: * The raw data source allows direct access to the filtered raw data. It is mainly used in the table exports, where
35: * access to Number and Date objects is a requirement.
36: * <p/>
37: * There is no enforced requirement to implement this interface, all exports will be able to work without it. But raw
38: * datasources definitly improve the quality and value of the generated output, so it is generally a good idea to
39: * implement it.
40: *
41: * @author Thomas Morgner
42: */
43: public interface RawDataSource extends DataSource {
44: /**
45: * Returns the unformated raw value. Whether that raw value is useable for the export is beyond the scope of this API
46: * definition, but providing access to {@link Number} or {@link java.util.Date} objects is a good idea.
47: *
48: * @param runtime the expression runtime that is used to evaluate formulas and expressions when computing the value of
49: * this filter.
50: * @return the raw data.
51: */
52: public Object getRawValue(ExpressionRuntime runtime);
53:
54: /**
55: * Returns information about the formatstring that was used to transform a raw-value into a formatted text. Not all
56: * elements will make use of a format-string. These elements will return {@link org.jfree.report.filter.FormatSpecification#TYPE_UNDEFINED}
57: * in that case.
58: *
59: * @param runtime the Expression runtime used to possibly compute the raw-value.
60: * @param formatSpecification the format specification (can be null).
61: * @return a filled format specififcation. If the <code>formatSpecification</code> parameter was not null, this given
62: * instance is reused.
63: */
64: public FormatSpecification getFormatString(
65: ExpressionRuntime runtime,
66: FormatSpecification formatSpecification);
67: }
|